// InDesign — Adobe InDesign 2026 (21.5.1.73) Object Model // Generated from Adobe’s object model export on 2026-09-16. // https://www.indesignjs.de/indesignapi/indesign/ // // Self-contained: includes the Core JavaScript classes and the global // names (app, alert, …), so no other file is needed. // // ScriptUI is not in here. Nine of its classes carry the names of // product classes — Window, Button, Event, Events, Group, ListBox, // Panel, RadioButton, StaticText — and TypeScript cannot hold both // under one global name. Dialog code therefore uses scriptui.d.ts // instead of this file. // // ExtendScript is not a browser. With the DOM library loaded, Document, // Event, Text and Window resolve to the browser versions and everything // below becomes invisible — doc.pages would be unknown, doc.createElement // would not. Put this next to your scripts as jsconfig.json: // // { // "compilerOptions": { "lib": ["es5"], "types": [], "checkJs": false }, // "include": ["**/*.js", "**/*.d.ts"] // } // // The descriptive texts are Adobe’s. Where Adobe’s own type information // is unusable, the type is "any" — see the project README. // // Parameters whose Adobe name is a reserved word carry a trailing // underscore: findKeyStrings(for_), prompt(…, default_, …). // Adobe references these type names without ever defining them. // The name is kept so the intent stays readable; the type is not known. type VariesType = any; /** * The $ object provides a number of debugging facilities and informational * methods. */ declare class $ { /** * The ExtendScript build information. */ static readonly build: string; /** * The ExtendScript build date. */ static readonly buildDate: Date; /** * The character used as the decimal point character in formatted numeric * output. */ static decimalPoint: string; /** * The name of the current ExtendScript engine, if set. */ static readonly engineName: string; /** * The most recent run-time error information. */ static error: Error; /** * The file name of the current script. */ static readonly fileName: string; /** * Gets or sets low-level debug output flags. */ static flags: number; /** * A reference to the global object, which contains the JavaScript global * namespace. */ static readonly global: any; /** * A high-resolution timer, measuring the time in microseconds. The timer * starts when ExtendScript is initialized during the application startup * sequence. Every read access resets the timer to Zero. */ static readonly hiresTimer: number; /** * The path for include files for the current script. */ static readonly includePath: string; /** * The current debugging level, which enables or disables the JavaScript * debugger. */ static level: number; /** * The current line number of the currently executing script. */ static readonly line: number; /** * Gets or sets the current locale. */ static locale: string; /** * Set to true to enable the extended localization features of the built-in * toString() method. */ static localize: boolean; /** * The ExtendScript memory cache size, in bytes. */ static memCache: number; /** * The current operating system version information. */ static readonly os: string; /** * An array of objects containing information about the display screens * attached to your computer. */ static readonly screens: Object[]; /** * The current stack trace. */ static readonly stack: string; /** * Sets or clears strict mode for object modification. */ static strict: any; /** * The version number of the ExtendScript engine. */ static readonly version: string; /** * Shows an About box for the ExtendScript component, and returns the text for * the box. */ static about(): string; /** * Breaks execution at the current position. * @param condition A string containing a JavaScript statement to be used as a condition. If the statement evaluates to true or nonzero when this point is reached, execution stops. */ static bp(condition?: any): void; /** * Invokes the platform-specific color selection dialog, and returns the * selected color. * @param color The color to be preselected in the dialog, as 0xRRGGBB, or -1 for the platform default. */ static colorPicker(color: number): number; /** * Loads and evaluates a file. * @param file The file to load. * @param timeout An optional timeout in milliseconds. */ static evalFile(file: File, timeout?: number): any; /** * Initiates garbage collection in the ExtendScript engine. */ static gc(): void; /** * Retrieves the value of an environment variable. * @param name The name of the variable. */ static getenv(name: string): string; /** * Sets the value of an environment variable. * @param name The name of the variable. * @param value The value of the variable. */ static setenv(name: string, value: string): void; /** * Suspends the calling thread for a number of milliseconds. * @param msecs Number of milliseconds to sleep. */ static sleep(msecs: number): void; /** * Converts this object to a string. */ static toString(): string; /** * Prints text to the Console. * @param text The text to print. All arguments are concatenated. */ static write(text: any): void; /** * Prints text to the Console, and adds a newline character. * @param text The text to print. All arguments are concatenated. */ static writeln(text: any): void; } /** * The exported PDF document's Acrobat compatibility. */ declare enum AcrobatCompatibility { /** * Makes the file compatible with Acrobat 4.0 and later. */ ACROBAT_4 = 1097020464, /** * Makes the file compatible with Acrobat 5.0 and later. */ ACROBAT_5 = 1097020720, /** * Makes the file compatible with Acrobat 6.0 and later. */ ACROBAT_6 = 1097020976, /** * Makes the file compatible with Acrobat 7.0 or higher. */ ACROBAT_7 = 1097021232, /** * Acrobat 8.0 compatibility. */ ACROBAT_8 = 1097021488, } /** * Options for auto page insertion in response to overset text. */ declare enum AddPageOptions { /** * Insert pages at end of document. */ END_OF_DOCUMENT = 1634037604, /** * Insert pages at end of section. */ END_OF_SECTION = 1634037624, /** * Insert pages at end of story. */ END_OF_STORY = 1634037619, } /** * Adjust layout preferences. */ declare class AdjustLayoutPreference extends Preference { /** * If true, allows font sizes and leading to adjust. */ allowFontSizeAndLeadingAdjustment: boolean; /** * If true, allows locked objects or objects on locked layers to be adjusted. */ allowLockedObjectsToAdjust: boolean; /** * If true, adjust layout is enabled. */ enableAdjustLayout: boolean; /** * If true, margins are adjusted automatically if page size is changed. */ enableAutoAdjustMargins: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, imposes the font size restriction during the adjustment. */ imposeFontSizeRestriction: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * maximum font size after adjustment in points * @remarks Range: 0.1 to 1296 */ maximumFontSize: number; /** * minimum font size after adjustment in points * @remarks Range: 0.1 to 1296 */ minimumFontSize: number; /** * The parent of the AdjustLayoutPreference (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): AdjustLayoutPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * AdjustLayoutPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Overprint options for kenten marks. */ declare enum AdornmentOverprint { /** * Uses auto overprint. */ AUTO = 1635019116, /** * Turns off overprint. */ OVERPRINT_OFF = 1701736294, /** * Turns on overprint. */ OVERPRINT_ON = 1701736302, } /** * Options for aligning or distributing objects. */ declare enum AlignDistributeBounds { /** * Align or distribute to the bounds of the bleed. */ BLEED_BOUNDS = 1416577644, /** * Align or distribute to the bounds of the objects. */ ITEM_BOUNDS = 1416587604, /** * Align or distribute to a key object. */ KEY_OBJECT = 1699439993, /** * Align or distribute to the margins of the page. */ MARGIN_BOUNDS = 1416588609, /** * Align or distribute to the bounds of the page. */ PAGE_BOUNDS = 1416589377, /** * Align or distribute to the bounds of the spread. */ SPREAD_BOUNDS = 1416590160, } /** * Preferences for alignment and distribution. */ declare class AlignDistributePreference extends Preference { /** * The bounds to use as a basis for aligning or distributing page items. */ alignDistributeBounds: AlignDistributeBounds; /** * If true, distribute space between page items and ignore the bounds setting. */ distributeAbsolute: boolean; /** * The distance to use when distributing page items. * @remarks Measurement unit — also accepts a string such as "12mm". */ distributeAbsoluteMeasurement: number | string; /** * If true, distribute space between page items and ignore the bounds setting. */ distributeSpaceAbsolute: boolean; /** * The distance to use when distributing page items. * @remarks Measurement unit — also accepts a string such as "12mm". */ distributeSpaceAbsoluteMeasurement: number | string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the AlignDistributePreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): AlignDistributePreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * AlignDistributePreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for aligning objects. */ declare enum AlignOptions { /** * Align the bottom edges of the objects. */ BOTTOM_EDGES = 1114916196, /** * Align the horizontal centers of the objects. */ HORIZONTAL_CENTERS = 1215257187, /** * Align the left edges of the objects. */ LEFT_EDGES = 1281770852, /** * Align the right edges of the objects. */ RIGHT_EDGES = 1383351652, /** * Align the top edges of the objects. */ TOP_EDGES = 1416643940, /** * Align the vertical centers of the objects. */ VERTICAL_CENTERS = 1449481315, } /** * Alignment options. */ declare enum AlignmentStyleOptions { /** * Center aligns cells. */ CENTER_ALIGN = 1667591796, /** * Left aligns cells. */ LEFT_ALIGN = 1818584692, /** * Right aligns cells. */ RIGHT_ALIGN = 1919379572, /** * Preserves the spreadsheet's alignment. */ SPREADSHEET = 1936749171, } /** * Glyph variant substitution options for standard glyphs. */ declare enum AlternateGlyphForms { /** * Uses the expert variant. */ EXPERT_FORM = 1247897445, /** * Uses the full-width variant. */ FULL_WIDTH_FORM = 1247897446, /** * Uses the JIS04 variant. */ JIS04_FORM = 1247897396, /** * Uses the JIS78 variant. */ JIS78_FORM = 1247897399, /** * Uses the JIS83 variant. */ JIS83_FORM = 1247897400, /** * Uses the JIS90 variant. */ JIS90_FORM = 1247897401, /** * Uses the monospaced half-width variant. */ MONOSPACED_HALF_WIDTH_FORM = 1247897453, /** * Uses the NLC variant. */ NLC_FORM = 1247897454, /** * Does not use an alternate form. */ NONE = 1852796517, /** * Substitutes proportional glyphs for half-width and full-width glyphs. */ PROPORTIONAL_WIDTH_FORM = 1247897456, /** * Uses the quarter-width variant. */ QUARTER_WIDTH_FORM = 1247897457, /** * Uses the third-width variant. */ THIRD_WIDTH_FORM = 1247897448, /** * Uses the traditional variant. */ TRADITIONAL_FORM = 1247897460, } /** * Pattern options for alternating fills. */ declare enum AlternatingFillsTypes { /** * Alternates column fills. */ ALTERNATING_COLUMNS = 1097614188, /** * Alternates row fills. */ ALTERNATING_ROWS = 1097618039, /** * No alternating pattern. */ NO_ALTERNATING_PATTERN = 1097617007, } /** * The reference point on the object's bounding box that does not move during * transformation operations. Note: Transformations include rotation, scaling, * flipping, and shearing. */ declare enum AnchorPoint { /** * The center point on the bottom of the bounding box. */ BOTTOM_CENTER_ANCHOR = 1095656035, /** * The bottom left corner. */ BOTTOM_LEFT_ANCHOR = 1095656044, /** * The bottom right corner. */ BOTTOM_RIGHT_ANCHOR = 1095656050, /** * The center point in the bounding box. */ CENTER_ANCHOR = 1095656308, /** * The center point on the left side of the bounding box. */ LEFT_CENTER_ANCHOR = 1095658595, /** * The center point on the right side of the bounding box. */ RIGHT_CENTER_ANCHOR = 1095660131, /** * The center point on the top of the bounding box. */ TOP_CENTER_ANCHOR = 1095660643, /** * The top left corner. */ TOP_LEFT_ANCHOR = 1095660652, /** * The top right corner. */ TOP_RIGHT_ANCHOR = 1095660658, } /** * Options for specifying the position of the anchored object relative to the * its anchor. */ declare enum AnchorPosition { /** * Place the anchored object above the line of text that contains the object. */ ABOVE_LINE = 1095716961, /** * Custom anchor position. */ ANCHORED = 1097814113, /** * Align the anchored object with the baseline of the line that contains the * object. */ INLINE_POSITION = 1095716969, } /** * Anchored object default settings. */ declare class AnchoredObjectDefault extends Preference { /** * The initial frame type of a new anchored object. */ anchorContent: ContentType; /** * The initial object style of a new anchored object. */ anchoredObjectStyle: ObjectStyle; /** * The initial paragraph style of a new anchored object. Note: Valid when * anchor content is text. */ anchoredParagraphStyle: ParagraphStyle; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The initial height of a new anchored object. * @remarks Measurement unit — also accepts a string such as "12mm". */ initialAnchorHeight: number | string; /** * The initial width of a new anchored object. * @remarks Measurement unit — also accepts a string such as "12mm". */ initialAnchorWidth: number | string; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the AnchoredObjectDefault (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): AnchoredObjectDefault[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * AnchoredObjectDefault. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * The settings for an anchored object. */ declare class AnchoredObjectSetting extends Preference { /** * The point in the anchored object to position. */ anchorPoint: AnchorPoint; /** * The space above an above-line anchored object. * @remarks Measurement unit — also accepts a string such as "12mm". */ anchorSpaceAbove: number | string; /** * The horizontal (x) offset of the anchored object. * @remarks Measurement unit — also accepts a string such as "12mm". */ anchorXoffset: number | string; /** * The vertical (y) offset of the anchored object. Corresponds to the space * after property for above line positioning. * @remarks Measurement unit — also accepts a string such as "12mm". */ anchorYoffset: number | string; /** * The position of the anchored object relative to the anchor. */ anchoredPosition: AnchorPosition; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * When anchored position is above line, the position of the anchored object is * relative to the text area. When anchored position is custom, the horizontal * alignment of the anchored object is set by the horizontal reference point. * Note: Not valid when anchored position is inline. */ horizontalAlignment: HorizontalAlignment; /** * The horizontal reference point on the page. Valid only when anchored * position is custom. */ horizontalReferencePoint: AnchoredRelativeTo; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * If true, prevents manual positioning of the anchored object. */ lockPosition: boolean; /** * The parent of the AnchoredObjectSetting (a FlexObject, Application, * Document, EPSText, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, * TextFrame, EndnoteTextFrame, Button, FormField, SignatureField, TextBox, * RadioButton, ListBox, ComboBox, CheckBox, MultiStateObject or ObjectStyle). */ readonly parent: Application | Button | CheckBox | ComboBox | Document | EPSText | EndnoteTextFrame | FormField | GraphicLine | Group | ListBox | MultiStateObject | Oval | Polygon | RadioButton | Rectangle | SignatureField | SplineItem | TextBox | TextFrame | FlexObject | ObjectStyle; /** * If true, pins the position of the anchored object within the text frame top * and bottom. */ pinPosition: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, the position of the anchored object is relative to the binding * spine of the page or spread. */ spineRelative: boolean; /** * The vertical alignment of the anchored object reference point with the * vertical reference point on the page. Notes: Valid only when anchored * position is custom. */ verticalAlignment: VerticalAlignment; /** * The vertical reference point on the page. Valid when anchored position is * custom. */ verticalReferencePoint: VerticallyRelativeTo; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): AnchoredObjectSetting[]; /** * Inserts the anchored object into specified story. * @param storyOffset The location within the story, specified as an insertion point. * @param anchoredPosition The position of the anchored object relative to the anchor. (Optional) */ insertAnchoredObject(storyOffset: InsertionPoint, anchoredPosition?: AnchorPosition): void; /** * Releases the anchored object from its associated text. */ releaseAnchoredObject(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * AnchoredObjectSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * The horizontal alignment point of an anchored object. */ declare enum AnchoredRelativeTo { /** * Align the anchored object to the anchor. */ ANCHOR_LOCATION = 1095786862, /** * Align the anchored object to the edge of the text or table column. */ COLUMN_EDGE = 1095787375, /** * Align the anchored object to the edge of the page. */ PAGE_EDGE = 1095790695, /** * Align the anchored object to the page margin. */ PAGE_MARGINS = 1095789927, /** * Align the anchored object to the edge of the text frame. */ TEXT_FRAME = 1954051174, } /** * A degree entry control featuring both a pop-up menu and and entry field. */ declare class AngleCombobox extends Widget { /** * The default value in an editbox control. Note: Do not specify both edit * contents and edit value. If both are specified, the one that occurs later in * the script is used. */ editContents: string; /** * The real number default value of the editbox or combobox. Note: For * measurement controls, the value is interpreted in points. The points value * is converted to edit units when the dialog opens. Note: Do not specify both * edit value and edit contents. If both are specified, the one that occurs * later in the script is used. */ editValue: number; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the AngleCombobox. */ readonly id: number; /** * The index of the AngleCombobox within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The amount to increment/decrement the value when a user selects the control * and holds down the Shift key while pressing an arrow key on the keyboard. */ largeNudge: number; /** * The maximum value that a user is allowed to type in a numeric editbox or * combobox. Note: The value for a measurement editbox or combobox is * interpreted in points, regardless of the edit units specified for the * control. The points value is converted automatically to the edit unit when * the dialog is opened. */ maximumValue: number; /** * The width of the control. For an editbox or combobox, specifies the minimum * width of the box. */ minWidth: number; /** * The minumim value that a user is allowed to type in a numeric editbox or * combobox. Note: The value for a measurement editbox or combobox is * interpreted in points, regardless of the edit units specified for the * control. The points value is converted automatically to the edit unit when * the dialog is opened. */ minimumValue: number; /** * The parent of the AngleCombobox (a DialogColumn, DialogRow, EnablingGroup or * BorderPanel). */ readonly parent: DialogRow | EnablingGroup | BorderPanel | DialogColumn; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The amount to increment/decrement the value when the user selects the * control and presses an arrow key on the keyboard. */ smallNudge: number; /** * The menu items on a dropdown or combobox control, as an array of strings. */ stringList: string[]; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): AngleCombobox[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the AngleCombobox. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of angle comboboxes. */ declare class AngleComboboxes { /** Returns the AngleCombobox with the specified index or name. */ [index: number]: AngleCombobox; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new AngleCombobox. * @param withProperties Initial values for properties of the new AngleCombobox (Optional) */ add(withProperties?: Object): AngleCombobox; /** * Returns any AngleCombobox in the collection. */ anyItem(): AngleCombobox; /** * Displays the number of elements in the AngleCombobox. */ count(): number; /** * Returns every AngleCombobox in the collection. */ everyItem(): AngleCombobox; /** * Returns the first AngleCombobox in the collection. */ firstItem(): AngleCombobox; /** * Returns the AngleCombobox with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): AngleCombobox; /** * Returns the AngleCombobox with the specified ID. * @param id The ID. */ itemByID(id: number): AngleCombobox; /** * Returns the AngleComboboxes within the specified range. * @param from The AngleCombobox, index, or name at the beginning of the range. Can accept: AngleCombobox, Long Integer or String. * @param to The AngleCombobox, index, or name at the end of the range. Can accept: AngleCombobox, Long Integer or String. */ itemByRange(from: AngleCombobox | number | string, to: AngleCombobox | number | string): AngleCombobox[]; /** * Returns the last AngleCombobox in the collection. */ lastItem(): AngleCombobox; /** * Returns the middle AngleCombobox in the collection. */ middleItem(): AngleCombobox; /** * Returns the AngleCombobox whose index follows the specified AngleCombobox in * the collection. * @param obj The AngleCombobox whose index comes before the desired AngleCombobox. */ nextItem(obj: AngleCombobox): AngleCombobox; /** * Returns the AngleCombobox with the index previous to the specified index. * @param obj The index of the AngleCombobox that follows the desired AngleCombobox. */ previousItem(obj: AngleCombobox): AngleCombobox; /** * Generates a string which, if executed, will return the AngleCombobox. */ toSource(): string; } /** * A degree entry field. */ declare class AngleEditbox extends Widget { /** * The default value in an editbox control. Note: Do not specify both edit * contents and edit value. If both are specified, the one that occurs later in * the script is used. */ editContents: string; /** * The real number default value of the editbox or combobox. Note: For * measurement controls, the value is interpreted in points. The points value * is converted to edit units when the dialog opens. Note: Do not specify both * edit value and edit contents. If both are specified, the one that occurs * later in the script is used. */ editValue: number; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the AngleEditbox. */ readonly id: number; /** * The index of the AngleEditbox within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The amount to increment/decrement the value when a user selects the control * and holds down the Shift key while pressing an arrow key on the keyboard. */ largeNudge: number; /** * The maximum value that a user is allowed to type in a numeric editbox or * combobox. Note: The value for a measurement editbox or combobox is * interpreted in points, regardless of the edit units specified for the * control. The points value is converted automatically to the edit unit when * the dialog is opened. */ maximumValue: number; /** * The width of the control. For an editbox or combobox, specifies the minimum * width of the box. */ minWidth: number; /** * The minumim value that a user is allowed to type in a numeric editbox or * combobox. Note: The value for a measurement editbox or combobox is * interpreted in points, regardless of the edit units specified for the * control. The points value is converted automatically to the edit unit when * the dialog is opened. */ minimumValue: number; /** * The parent of the AngleEditbox (a DialogColumn, DialogRow, EnablingGroup or * BorderPanel). */ readonly parent: DialogRow | EnablingGroup | BorderPanel | DialogColumn; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The amount to increment/decrement the value when the user selects the * control and presses an arrow key on the keyboard. */ smallNudge: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): AngleEditbox[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the AngleEditbox. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of angle editboxes. */ declare class AngleEditboxes { /** Returns the AngleEditbox with the specified index or name. */ [index: number]: AngleEditbox; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new AngleEditbox. * @param withProperties Initial values for properties of the new AngleEditbox (Optional) */ add(withProperties?: Object): AngleEditbox; /** * Returns any AngleEditbox in the collection. */ anyItem(): AngleEditbox; /** * Displays the number of elements in the AngleEditbox. */ count(): number; /** * Returns every AngleEditbox in the collection. */ everyItem(): AngleEditbox; /** * Returns the first AngleEditbox in the collection. */ firstItem(): AngleEditbox; /** * Returns the AngleEditbox with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): AngleEditbox; /** * Returns the AngleEditbox with the specified ID. * @param id The ID. */ itemByID(id: number): AngleEditbox; /** * Returns the AngleEditboxes within the specified range. * @param from The AngleEditbox, index, or name at the beginning of the range. Can accept: AngleEditbox, Long Integer or String. * @param to The AngleEditbox, index, or name at the end of the range. Can accept: AngleEditbox, Long Integer or String. */ itemByRange(from: AngleEditbox | number | string, to: AngleEditbox | number | string): AngleEditbox[]; /** * Returns the last AngleEditbox in the collection. */ lastItem(): AngleEditbox; /** * Returns the middle AngleEditbox in the collection. */ middleItem(): AngleEditbox; /** * Returns the AngleEditbox whose index follows the specified AngleEditbox in * the collection. * @param obj The AngleEditbox whose index comes before the desired AngleEditbox. */ nextItem(obj: AngleEditbox): AngleEditbox; /** * Returns the AngleEditbox with the index previous to the specified index. * @param obj The index of the AngleEditbox that follows the desired AngleEditbox. */ previousItem(obj: AngleEditbox): AngleEditbox; /** * Generates a string which, if executed, will return the AngleEditbox. */ toSource(): string; } /** * A animation behavior. */ declare class AnimationBehavior extends Behavior { /** * The animation page item. */ animatedPageItem: PageItem; /** * If true, will automatically play the animation in reverse on roll off of the * rollover event. */ autoReverseOnRollOff: boolean; /** * The event which triggers the behavior. */ behaviorEvent: BehaviorEvents; /** * If true, the behavior is enabled. */ enableBehavior: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the AnimationBehavior. */ readonly id: number; /** * The index of the AnimationBehavior within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the AnimationBehavior. */ readonly name: string; /** * The playback mode. */ operation: AnimationPlayOperations; /** * The parent of the AnimationBehavior (a Button). */ readonly parent: Button; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): AnimationBehavior[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the AnimationBehavior. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the AnimationBehavior. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of animation behaviors. */ declare class AnimationBehaviors { /** Returns the AnimationBehavior with the specified index or name. */ [index: number]: AnimationBehavior; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new AnimationBehavior. * @param withProperties Initial values for properties of the new AnimationBehavior (Optional) */ add(withProperties?: Object): AnimationBehavior; /** * Returns any AnimationBehavior in the collection. */ anyItem(): AnimationBehavior; /** * Displays the number of elements in the AnimationBehavior. */ count(): number; /** * Returns every AnimationBehavior in the collection. */ everyItem(): AnimationBehavior; /** * Returns the first AnimationBehavior in the collection. */ firstItem(): AnimationBehavior; /** * Returns the AnimationBehavior with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): AnimationBehavior; /** * Returns the AnimationBehavior with the specified ID. * @param id The ID. */ itemByID(id: number): AnimationBehavior; /** * Returns the AnimationBehavior with the specified name. * @param name The name. */ itemByName(name: string): AnimationBehavior; /** * Returns the AnimationBehaviors within the specified range. * @param from The AnimationBehavior, index, or name at the beginning of the range. Can accept: AnimationBehavior, Long Integer or String. * @param to The AnimationBehavior, index, or name at the end of the range. Can accept: AnimationBehavior, Long Integer or String. */ itemByRange(from: AnimationBehavior | number | string, to: AnimationBehavior | number | string): AnimationBehavior[]; /** * Returns the last AnimationBehavior in the collection. */ lastItem(): AnimationBehavior; /** * Returns the middle AnimationBehavior in the collection. */ middleItem(): AnimationBehavior; /** * Returns the AnimationBehavior whose index follows the specified * AnimationBehavior in the collection. * @param obj The AnimationBehavior whose index comes before the desired AnimationBehavior. */ nextItem(obj: AnimationBehavior): AnimationBehavior; /** * Returns the AnimationBehavior with the index previous to the specified * index. * @param obj The index of the AnimationBehavior that follows the desired AnimationBehavior. */ previousItem(obj: AnimationBehavior): AnimationBehavior; /** * Generates a string which, if executed, will return the AnimationBehavior. */ toSource(): string; } /** * The ease option. */ declare enum AnimationEaseOptions { /** * cutom read only ease type. */ CUSTOM_EASE = 2051363407, /** * simple ease in. */ EASE_IN = 2051371849, /** * simple ease in and out. */ EASE_IN_OUT = 2051361103, /** * simple ease out. */ EASE_OUT = 2051371855, /** * no easing. */ NO_EASE = 2051960645, } /** * Playback options. */ declare enum AnimationPlayOperations { /** * Pauses playback. */ PAUSE = 1885435251, /** * Starts playback. */ PLAY = 1886151033, /** * Resumes playback. */ RESUME = 1919251317, /** * Reverses playback. */ REVERSE_PLAYBACK = 1919252069, /** * Stops playback. */ STOP = 1937010544, /** * Stops all playback. */ STOP_ALL = 1937010785, } /** * Animation settings. */ declare class AnimationSetting extends Preference { /** * The animation design option. */ designOption: DesignOptions; /** * The duration in second for this animation. * @remarks Range: 0.125 to 60 */ duration: number; /** * The ease type. */ easeType: AnimationEaseOptions; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Determines if this animated object has custom settings. */ readonly hasCustomSettings: boolean; /** * Determines if this object is hidden after its animation is played in an * exported SWF file. */ hiddenAfter: boolean; /** * Determines if this object is initially hidden when displayed in an exported * SWF file. */ initiallyHidden: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The list of motion path points and key frames for this animation. Can * return: Ordered array containing keyFrame:Long Integer, pathPoint:Ordered * array containing anchor:Array of 2 Reals, leftDirection:Array of 2 Reals, * rightDirection:Array of 2 Reals. */ motionPath: (any[] | number[][])[]; /** * The list of motion path points for this animation. Can return: Ordered array * containing pathPointArray:Array of Ordered array containing anchor:Array of * 2 Reals, leftDirection:Array of 2 Reals, rightDirection:Array of 2 Reals, * pathOpen:Boolean. */ motionPathPoints: (any[] | number[][] | boolean)[]; /** * The list of opacity key frames for this animation. Can return: Ordered array * containing keyFrame:Long Integer, value:Real. */ opacityArray: (any[] | number)[]; /** * The parent of the AnimationSetting (a PageItem, HtmlItem, FlexObject, * FormField, SignatureField, TextBox, RadioButton, ListBox, ComboBox, * CheckBox, MultiStateObject, Button, MediaItem, Sound, Movie, EPSText, * SplineItem, Polygon, GraphicLine, Rectangle, Oval, Graphic, SVG, * ImportedPage, PICT, WMF, PDF, EPS, Image, Group, TextFrame or * EndnoteTextFrame). */ readonly parent: Button | CheckBox | ComboBox | EPS | EPSText | FlexObject | FormField | Graphic | GraphicLine | Group | HtmlItem | Image | ImportedPage | ListBox | MediaItem | Movie | MultiStateObject | Oval | PDF | PICT | Polygon | RadioButton | Rectangle | SVG | SignatureField | Sound | SplineItem | TextBox | TextFrame | WMF | EndnoteTextFrame | PageItem; /** * The number of times this animation plays. * @remarks Range: 1 to 100 */ plays: number; /** * Set to true if animation play loops. */ playsLoop: boolean; /** * The base animation preset applied. Can return: MotionPreset, String or * NothingEnum enumerator. */ preset: MotionPreset | string | NothingEnum; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The list of rotation key frames for this animation. Can return: Ordered * array containing keyFrame:Long Integer, value:Real. */ rotationArray: (any[] | number)[]; /** * The list of scale x key frames for this animation. Can return: Ordered array * containing keyFrame:Long Integer, value:Real. */ scaleXArray: (any[] | number)[]; /** * The list of scale y key frames for this animation. Can return: Ordered array * containing keyFrame:Long Integer, value:Real. */ scaleYArray: (any[] | number)[]; /** * The tranform offset percentage from the target object bounding box's * left-top corner. */ transformOffsets: number[]; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): AnimationSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Save this motion preset as custom preset. * @param name The name for the new motion preset. */ save(name: string): MotionPreset; /** * Save a copy of this motion preset to a InDesign motion preset file. * @param to The Flash motion preset file to export to. */ saveACopy(to: File): void; /** * Generates a string which, if executed, will return the AnimationSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * The anti-aliasing type. */ declare enum AntiAliasType { /** * Color anti-aliasing. */ COLOR_ANTIALIASING = 1665418322, /** * Gray anti-aliasing. */ GRAY_ANTIALIASING = 1732527186, /** * Thicker anti-aliasing. */ THICKER_ANTIALIASING = 1950444659, } /** * The application. */ declare class Application { /** * The active book. */ activeBook: Book; /** * The front-most document. */ activeDocument: Document; /** * The current script running from the Scripts panel. */ readonly activeScript: File; /** * The undo mode for the current script execution. */ readonly activeScriptUndoMode: UndoModes; /** * The front-most window. Can return: Window, LayoutWindow or StoryWindow. */ activeWindow: LayoutWindow | Window | StoryWindow; /** * Preferences for alignment and distribution. */ readonly alignDistributePreferences: AlignDistributePreference; /** * All Cell styles */ readonly allCellStyles: CellStyle[]; /** * Lists all character styles (regardless of their group). */ readonly allCharacterStyles: CharacterStyle[]; /** * All object styles contained by the Application. */ readonly allObjectStyles: ObjectStyle[]; /** * Lists all paragraph styles (regardless of their group). */ readonly allParagraphStyles: ParagraphStyle[]; /** * The list of all object types (strings) a preflight rule can operate on. */ readonly allPreflightObjectTypes: string[]; /** * The list of all categories that have been declared by rules. */ readonly allPreflightRuleCategories: string[]; /** * The list of all known (declared) rule IDs. */ readonly allPreflightRuleIDs: string[]; /** * All Table styles */ readonly allTableStyles: TableStyle[]; /** * Anchored object default settings. */ readonly anchoredObjectDefaults: AnchoredObjectDefault; /** * Anchored object settings. */ readonly anchoredObjectSettings: AnchoredObjectSetting; /** * Auto-correct preferences. */ readonly autoCorrectPreferences: AutoCorrectPreference; /** * A collection of auto-correct tables. */ readonly autoCorrectTables: AutoCorrectTables; /** * If true, enables the auto detection of flex layout attributes when adding * elements to flex container from canvas. */ autoDetectionEnabled: boolean; /** * A collection of background task objects. */ readonly backgroundTasks: BackgroundTasks; /** * Baseline frame grid option settings. */ readonly baselineFrameGridOptions: BaselineFrameGridOption; /** * A collection of books. */ readonly books: Books; /** * Button preference settings. */ readonly buttonPreferences: ButtonPreference; /** * A collection of cell style groups. */ readonly cellStyleGroups: CellStyleGroups; /** * A collection of cell style mappings. */ readonly cellStyleMappings: CellStyleMappings; /** * A collection of cell styles. */ readonly cellStyles: CellStyles; /** * Change color preferences. Can also accept: NothingEnum enumerator. */ changeColorPreferences: ChangeColorPreference | NothingEnum; /** * Change glyph preferences. Can also accept: NothingEnum enumerator. */ changeGlyphPreferences: ChangeGlyphPreference | NothingEnum; /** * Change grep preferences. Can also accept: NothingEnum enumerator. */ changeGrepPreferences: ChangeGrepPreference | NothingEnum; /** * Change object preferences. Can also accept: NothingEnum enumerator. */ changeObjectPreferences: ChangeObjectPreference | NothingEnum; /** * Change text preferences. Can also accept: NothingEnum enumerator. */ changeTextPreferences: ChangeTextPreference | NothingEnum; /** * Change transliterate preferences. Can also accept: NothingEnum enumerator. */ changeTransliteratePreferences: ChangeTransliteratePreference | NothingEnum; /** * A collection of char style mappings. */ readonly charStyleMappings: CharStyleMappings; /** * A collection of character style groups. */ readonly characterStyleGroups: CharacterStyleGroups; /** * A collection of character styles. */ readonly characterStyles: CharacterStyles; /** * CJK grid preference settings. */ readonly cjkGridPreferences: CjkGridPreference; /** * Clear overrides first before applying object style */ clearOverridesWhenApplyingStyle: boolean; /** * Clipboard preference properties that define the way that the application * interacts with the system clipboard. */ readonly clipboardPreferences: ClipboardPreference; /** * A collection of color groups. */ readonly colorGroups: ColorGroups; /** * Color setting properties that define color management defaults. */ readonly colorSettings: ColorSetting; /** * A collection of colors. */ readonly colors: Colors; /** * A collection of composite fonts. */ readonly compositeFonts: CompositeFonts; /** * A collection of condition sets for conditional text. */ readonly conditionSets: ConditionSets; /** * Conditional text preferences. */ readonly conditionalTextPreferences: ConditionalTextPreference; /** * A collection of conditions for conditional text. */ readonly conditions: Conditions; /** * The Content Placer. Used to get a reference to the content placer object. */ readonly contentPlacer: ContentPlacerObject; /** * A collection of dashed stroke styles. */ readonly dashedStrokeStyles: DashedStrokeStyles; /** * The data merge option properties that define the data merge. */ readonly dataMergeOptions: DataMergeOption; /** * A collection of dialogs. */ readonly dialogs: Dialogs; /** * User dictionary preference settings. */ readonly dictionaryPreferences: DictionaryPreference; /** * Display performance settings. */ readonly displayPerformancePreferences: DisplayPerformancePreference; /** * Display setting properties. */ readonly displaySettings: DisplaySettings; /** * Document preference settings. */ readonly documentPreferences: DocumentPreference; /** * A collection of document presets. */ readonly documentPresets: DocumentPresets; /** * A collection of documents. */ readonly documents: Documents; /** * A collection of dotted stroke styles. */ readonly dottedStrokeStyles: DottedStrokeStyles; /** * Endnote option settings. */ readonly endnoteOptions: EndnoteOption; /** * EPS export preferences. */ readonly epsExportPreferences: EPSExportPreference; /** * EPS import preferences. */ readonly epsImportPreferences: EPSImportPreference; /** * EPub export preview app preference settings. */ readonly epubViewingAppsPreferences: EPubExportPreviewAppPreference; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Excel import preferences. */ readonly excelImportPreferences: ExcelImportPreference; /** * The default export for web preferences. */ readonly exportForWebPreferences: ExportForWebPreference; /** * The feature set. */ readonly featureSet: FeatureSetOptions; /** * The full path to the file. */ readonly filePath: File; /** * Find/change color options. Can also accept: NothingEnum enumerator. */ findChangeColorOptions: FindChangeColorOption | NothingEnum; /** * Find/change glyph options. Can also accept: NothingEnum enumerator. */ findChangeGlyphOptions: FindChangeGlyphOption | NothingEnum; /** * Find/change grep options. Can also accept: NothingEnum enumerator. */ findChangeGrepOptions: FindChangeGrepOption | NothingEnum; /** * Find/change object options. Can also accept: NothingEnum enumerator. */ findChangeObjectOptions: FindChangeObjectOption | NothingEnum; /** * Find/change text options. Can also accept: NothingEnum enumerator. */ findChangeTextOptions: FindChangeTextOption | NothingEnum; /** * Find/change transliterate options. Can also accept: NothingEnum enumerator. */ findChangeTransliterateOptions: FindChangeTransliterateOption | NothingEnum; /** * Find color preferences. Can also accept: NothingEnum enumerator. */ findColorPreferences: FindColorPreference | NothingEnum; /** * Find glyph preferences. Can also accept: NothingEnum enumerator. */ findGlyphPreferences: FindGlyphPreference | NothingEnum; /** * Find grep preferences. Can also accept: NothingEnum enumerator. */ findGrepPreferences: FindGrepPreference | NothingEnum; /** * Find object preferences. Can also accept: NothingEnum enumerator. */ findObjectPreferences: FindObjectPreference | NothingEnum; /** * Find text preferences. Can also accept: NothingEnum enumerator. */ findTextPreferences: FindTextPreference | NothingEnum; /** * Find transliterate preferences. Can also accept: NothingEnum enumerator. */ findTransliteratePreferences: FindTransliteratePreference | NothingEnum; /** * A collection of transparency flattener presets. */ readonly flattenerPresets: FlattenerPresets; /** * Font locking preference settings. */ readonly fontLockingPreferences: FontLockingPreference; /** * The font sync preference properties that define preferences for fonts. */ readonly fontSyncPreferences: FontSyncPreference; /** * A collection of fonts. */ readonly fonts: Fonts; /** * Footnote option settings. */ readonly footnoteOptions: FootnoteOption; /** * The frame fitting option to apply to placed or pasted content. Can be * applied to a frame, object style, or document or to the application. */ readonly frameFittingOptions: FrameFittingOption; /** * The full path to the Application, including the name of the Application. */ readonly fullName: File; /** * Galley preference settings. */ readonly galleyPreferences: GalleyPreference; /** * General preference settings. */ readonly generalPreferences: GeneralPreference; /** * GPU performance preferences. */ readonly gpuPerformancePreferences: GpuPerformancePreference; /** * Grabber preference properties that define display performance quality during * scrolling. */ readonly grabberPreferences: GrabberPreference; /** * A collection of gradients. */ readonly gradients: Gradients; /** * Grid preference settings. */ readonly gridPreferences: GridPreference; /** * Grid printing preference and export settings. */ readonly gridPrintingPreferences: GridPrintingPreference; /** * Guide preference settings. */ readonly guidePreferences: GuidePreference; /** * Get whether home screen is visible or not. */ readonly homeScreenVisible: boolean; /** * Experimental: Connection manager property */ httpLinkConnectionManager: HttpLinkConnectionManagerObject; /** * All attachable idle tasks. */ readonly idleTasks: IdleTasks; /** * The image I/O preference properties that define preferences for importing * images. */ readonly imageIOPreferences: ImageIOPreference; /** * Image preferences. */ readonly imagePreferences: ImagePreference; /** * IME preference settings. */ readonly imePreferences: IMEPreference; /** * Placed InDesign page attributes. */ readonly importedPageAttributes: ImportedPageAttribute; /** * Export options for InCopy INCX document format. */ readonly incopyExportOptions: InCopyExportOption; /** * The index options properties that define how an index is formatted. */ readonly indexGenerationOptions: IndexOptions; /** * A collection of indexing sort options. */ readonly indexingSortOptions: IndexingSortOptions; /** * A collection of inks. */ readonly inks: Inks; /** * Interactive PDF export preferences. */ readonly interactivePDFExportPreferences: InteractivePDFExportPreference; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * JPEG export preferences. */ readonly jpegExportPreferences: JPEGExportPreference; /** * A collection of kinsoku tables. */ readonly kinsokuTables: KinsokuTables; /** * A property that can be set to any string. */ label: string; /** * A collection of languages with vendors. */ readonly languagesWithVendors: LanguagesWithVendors; /** * Default properties specific to layout grids. */ readonly layoutGridData: LayoutGridDataInformation; /** * A collection of layout windows. */ readonly layoutWindows: LayoutWindows; /** * A collection of object libraries. */ readonly libraries: Libraries; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Linked story options */ readonly linkedStoryOptions: LinkedStoryOption; /** * The links preference properties that define preferences for links. */ readonly linkingPreferences: LinkingPreference; /** * Delay before mouse operations trigger live screen drawing of page items. */ liveScreenDrawing: LiveDrawingOptions; /** * The locale of the application. */ readonly locale: Locale; /** * Margin preference settings. */ readonly marginPreferences: MarginPreference; /** * A collection of menu actions. */ readonly menuActions: MenuActions; /** * A collection of menus. */ readonly menus: Menus; /** * A collection of mixed ink groups. */ readonly mixedInkGroups: MixedInkGroups; /** * A collection of mixed inks. */ readonly mixedInks: MixedInks; /** * If true, a modal dialog or alert is active. */ readonly modalState: boolean; /** * A collection of mojikumi tables. */ readonly mojikumiTables: MojikumiTables; /** * Mojikumi user interface preference settings. */ readonly mojikumiUIPreferences: MojikumiUiPreference; /** * A collection of Motion presets. */ readonly motionPresets: MotionPresets; /** * The name of the Application. */ readonly name: string; /** * A collection of named grids. */ readonly namedGrids: NamedGrids; /** * Note preference settings. */ readonly notePreferences: NotePreference; /** * A collection of numbered lists. */ readonly numberingLists: NumberingLists; /** * A collection of object style groups. */ readonly objectStyleGroups: ObjectStyleGroups; /** * A collection of object styles. */ readonly objectStyles: ObjectStyles; /** * The default page item formatting for the Application. */ readonly pageItemDefaults: PageItemDefault; /** * A collection of panels. */ readonly panels: Panels; /** * A collection of para style mappings. */ readonly paraStyleMappings: ParaStyleMappings; /** * A collection of paragraph style groups. */ readonly paragraphStyleGroups: ParagraphStyleGroups; /** * A collection of paragraph styles. */ readonly paragraphStyles: ParagraphStyles; /** * The parent of the Application (a Application). */ readonly parent: Application; /** * Pasteboard preference settings. */ readonly pasteboardPreferences: PasteboardPreference; /** * A collection of PDF export preferences. */ readonly pdfExportPreferences: PDFExportPreference; /** * A collection of PDF export presets. */ readonly pdfExportPresets: PDFExportPresets; /** * The PDF place preference properties that define how PDF files are placed in * the current document. */ readonly pdfPlacePreferences: PDFPlacePreference; /** * The available performance metrics. */ readonly performanceMetrics: number[]; /** * Lists the extensions of file types that can be placed. */ readonly placeableFileExtensions: string[]; /** * Lists the types of files that can be placed. */ readonly placeableFileTypes: string[]; /** * PNG export preferences. */ readonly pngExportPreferences: PNGExportPreference; /** * Polygon preference properties to use to define default settings for creating * a polygon. */ readonly polygonPreferences: PolygonPreference; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * Preflight book option settings. */ readonly preflightBookOptions: PreflightBookOption; /** * Preflight option settings. */ readonly preflightOptions: PreflightOption; /** * A collection of preflight processes. */ readonly preflightProcesses: PreflightProcesses; /** * A collection of preflight profiles. */ readonly preflightProfiles: PreflightProfiles; /** * A collection of preflight rules. */ readonly preflightRules: PreflightRules; /** * A collection of printer presets. */ readonly printerPresets: PrinterPresets; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The names of the items in the redo stack. */ readonly redoHistory: string[]; /** * The name of the action on the top of the redo stack. */ readonly redoName: string; /** * Arguments to pass to a script. */ readonly scriptArgs: ScriptArg; /** * A collection of script menu actions. */ readonly scriptMenuActions: ScriptMenuActions; /** * Script preferences. */ readonly scriptPreferences: ScriptPreference; /** * The selected object(s). Can also accept: Object or NothingEnum enumerator. */ selection: (Object | NothingEnum)[]; /** * The key object of the selection. Can also accept: NothingEnum enumerator. */ selectionKeyObject: PageItem | NothingEnum; /** * The user's serial number. */ readonly serialNumber: string; /** * Smart Guide preference properties. */ readonly smartGuidePreferences: SmartGuidePreference; /** * Spell-check preferences. */ readonly spellPreferences: SpellPreference; /** * Default properties specific to frame grids. */ readonly storyGridData: StoryGridDataInformation; /** * Story preference settings. */ readonly storyPreferences: StoryPreference; /** * A collection of story windows. */ readonly storyWindows: StoryWindows; /** * A collection of striped stroke styles. */ readonly stripedStrokeStyles: StripedStrokeStyles; /** * Stroke/fill proxy settings. */ readonly strokeFillProxySettings: StrokeFillProxySetting; /** * A collection of stroke styles. */ readonly strokeStyles: StrokeStyles; /** * A collection of swatches. */ readonly swatches: Swatches; /** * A collection of table style groups. */ readonly tableStyleGroups: TableStyleGroups; /** * A collection of table style mappings. */ readonly tableStyleMappings: TableStyleMappings; /** * A collection of table styles. */ readonly tableStyles: TableStyles; /** * Tagged PDF preferences. */ readonly taggedPDFPreferences: TaggedPDFPreference; /** * Tagged text export preferences. */ readonly taggedTextExportPreferences: TaggedTextExportPreference; /** * Tagged text import preferences. */ readonly taggedTextImportPreferences: TaggedTextImportPreference; /** * Text default settings. */ readonly textDefaults: TextDefault; /** * Text editing preference settings. */ readonly textEditingPreferences: TextEditingPreference; /** * Text export preferences. */ readonly textExportPreferences: TextExportPreference; /** * Text frame preference settings. */ readonly textFramePreferences: TextFramePreference; /** * Text import preferences. */ readonly textImportPreferences: TextImportPreference; /** * Text preference settings. */ readonly textPreferences: TextPreference; /** * A collection of text variables. */ readonly textVariables: TextVariables; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * A collection of tints. */ readonly tints: Tints; /** * The current tool box states */ readonly toolBoxTools: ToolBox; /** * Track changes preference settings. */ readonly trackChangesPreferences: TrackChangesPreference; /** * Transform preference properties that define default behaviors when * transforming objects. Note: Transforming includes rotation, scaling, * flipping, and shearing. */ readonly transformPreferences: TransformPreference; /** * A collection of transformation matrices. */ readonly transformationMatrices: TransformationMatrices; /** * Transparency preference settings. */ readonly transparencyPreferences: TransparencyPreference; /** * A collection of trap presets. */ readonly trapPresets: TrapPresets; /** * Preferences for showing contextual ui for alternates. */ readonly typeContextualUiPrefs: TypeContextualUiPreference; /** * The names of the items in the undo stack. */ readonly undoHistory: string[]; /** * The name of the action on the top of the undo stack. */ readonly undoName: string; /** * The swatches that are not being used. */ readonly unusedSwatches: Swatch[]; /** * The current user's adobe id */ readonly userAdobeId: string; /** * The color assigned to the tracked changes and notes created by the user, * specified either as an array of three doubles, each in the range 0 to 255 * and representing R, G, and B values, or as an InCopy UI color. Can return: * Array of 3 Reals (0 - 255) or InCopyUIColors enumerator. */ userColor: (number[][] | InCopyUIColors)[]; /** * A collection of user dictionaries. */ readonly userDictionaries: UserDictionaries; /** * The current user's GUID */ readonly userGuid: string; /** * The user associated with the tracked changes and notes. */ userName: string; /** * The application version. */ readonly version: string; /** * View preference settings. */ readonly viewPreferences: ViewPreference; /** * If true, the Application is visible. */ readonly visible: boolean; /** * Watermark preferences */ readonly watermarkPreferences: WatermarkPreference; /** * A collection of windows. */ readonly windows: Windows; /** * Word and RTF import preferences. */ readonly wordRTFImportPreferences: WordRTFImportPreference; /** * A collection of XML export maps. */ readonly xmlExportMaps: XMLExportMaps; /** * XML export preference settings. */ readonly xmlExportPreferences: XMLExportPreference; /** * A collection of XML import maps. */ readonly xmlImportMaps: XMLImportMaps; /** * XML import preference settings. */ readonly xmlImportPreferences: XMLImportPreference; /** * The XML preference settings. */ readonly xmlPreferences: XMLPreference; /** * A collection of XML rule processors. */ readonly xmlRuleProcessors: XMLRuleProcessors; /** * A collection of XML tags. */ readonly xmlTags: XMLTags; /** * XML view preference settings. */ readonly xmlViewPreferences: XMLViewPreference; /** * Dispatched after the Application becomes active. This event bubbles. This * event is not cancelable. */ static readonly AFTER_ACTIVATE: string; /** * Dispatched after a Document is closed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_CLOSE: string; /** * Dispatched after the active context changes. This event bubbles. This event * is not cancelable. */ static readonly AFTER_CONTEXT_CHANGED: string; /** * Dispatched when the Application is quitting. Since the quit has been * committed, it can not be canceled. This event bubbles. This event is not * cancelable. */ static readonly AFTER_QUIT: string; /** * Dispatched after a script method is invoked. This event bubbles. This event * is not cancelable. */ static readonly AFTER_SCRIPT_METHOD: string; /** * Dispatched after an attribute on the active selection changes. This event * bubbles. This event is not cancelable. */ static readonly AFTER_SELECTION_ATTRIBUTE_CHANGED: string; /** * Dispatched after the active selection changes. This event bubbles. This * event is not cancelable. */ static readonly AFTER_SELECTION_CHANGED: string; /** * Dispatched before the Application becomes inactive. This event bubbles. This * event is not cancelable. */ static readonly BEFORE_DEACTIVATE: string; /** * Dispatched before a Document is created. This event bubbles. This event is * cancelable. */ static readonly BEFORE_NEW: string; /** * Dispatched before a Document is opened. This event bubbles. This event is * cancelable. */ static readonly BEFORE_OPEN: string; /** * Dispatched before the Application is quit. Allows the quit to be canceled. * This event bubbles. This event is cancelable. */ static readonly BEFORE_QUIT: string; /** * Dispatched before a script method is invoked. This event bubbles. This event * is not cancelable. */ static readonly BEFORE_SCRIPT_METHOD: string; /** * Dispatched after the Application changes. This event bubbles. This event is * not cancelable. */ static readonly HOME_SCREEN_VISIBILITY_CHANGE: string; /** * Makes the application the front-most or active window. */ activate(): void; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified menu customization set. An empty string will reset all * menus and colorization (Show Full Menus). No string will apply the default * menu set. * @param name The menu customization set. (Optional) */ applyMenuCustomization(name?: string): void; /** * Applies the specified shortcut set file. No string will apply the default * shortcut set. * @param name The shortcut set. (Optional) */ applyShortcutSet(name?: string): void; /** * Applies the specified workspace. * @param name The workspace. (Optional) */ applyWorkspace(name?: string): void; /** * Cancels all the background tasks. */ cancelAllTasks(): void; /** * Cascades all document windows. */ cascadeWindows(): void; /** * Finds color that matches the find what value and replaces the color with the * change to value. */ changeColor(): number; /** * Finds glyphs that match the find what value and replaces the glyphs with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGrep(reverseOrder?: boolean): Text[]; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value and replaces the text * with the change character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeTransliterate(reverseOrder?: boolean): Text[]; /** * Removes the frame fittings options and resets it to the initial state. */ clearFrameFittingOptions(): void; /** * Transforms color values * @param colorValue source color value * @param sourceColorSpace source color space * @param destinationColorSpace destination color space */ colorTransform(colorValue: number[], sourceColorSpace: ColorSpace, destinationColorSpace: ColorSpace): number[]; /** * Copies the selection in the active document window to the clipboard. */ copy(): void; /** * Create a mini-folio out of asset and overlay descriptions. Schema for the * mini folio description: || Key || Type || Required? || Description || | * contentstackid | string | yes | The explicit ID to be used for this stack | * | tocImage | file | no | The TOC image for the mini-folio | | * narrowdimension | int | no | Targetted export size, measured along narrow * dimension | | widedimension | int | no | Targetted export size, measured * along wide dimension | | smoothscrolling | @enum(SmoothScrollingOptions) | * no | The smooth scrolling behavior for this stack (default is * noSmoothScroll) | | locationforgeneratedassets | file | no | If included, * this is an existing directory where the generated assets should be created. * | | overlays | array | no | see the SDK Overlay Builder APIs | | assets | * array | yes | The assets for the mini - folio, described below. | | * assetDependencies | array | no | Files that are needed by the asset, that * will be included in the package but not the manifest. | | metadata | array | * no | The metadata for the mini-folio described below. | | showprogressbar | * boolean | no | Either true or false to indicate whether we should show a * progress bar (default is false) | | targetviewerversion | string | no | If * provided (in the form "major.minor.revision") a folio compatible with the * viewer version is produced. If omitted, the latest folio format is produced. * | CS5 | The following are fields in the array for "assets": || Key || Type * || Required? || Description || | file | file | yes | The asset file | | type * | string | yes | The asset file type, either "web" for HTML or "image" for a * raster | | width | int | yes | The asset width | | height | int | yes | The * asset height | | orientation | string | yes | The asset orientation, either * "portrait" or "landscape" | | thumbnail | file | no | A thumbnail of the * asset to be used in browse mode | | scrubber | file | no | A thumbnail of * the asset to be used in scrubber mode | The following are fields in the * array for "assetDependencies": || Key || Type || Required? || Description || * | file | file | no | The dependent file | | relativePath | string | no | The * relative path to the file, for use in the package | The following are fields * in the array for "metadata": || Key || Type || Required? || Description || | * any string | string or boolean | no | any key/value where the key is a * string, and the value is either a string or a boolean, such as those * described in "export folio meta data" | * @param miniFolioDescription A dictionary describing the custom mini folio to create. Can accept: Ordered array containing key:String, value:Boolean, Long Integer, Long Long Integer, String, File or Array of Any Types. * @param destination The location to write the file. */ createCustomMiniFolio(miniFolioDescription: (File | number | any[] | string | boolean | any)[], destination: File): void; /** * Creates a temporary copy of the file * @param from The file to be copied */ createTemporaryCopy(from: File): string; /** * Cuts the selection in the active document window and stores it in the * clipboard. */ cut(): void; /** * Delete cloud document for a given reference. * @param assetReference The reference to asset */ deleteCloudDocument(assetReference: string): boolean; /** * Deletes the specified find/change query. * @param queryName The query to delete. * @param searchMode The search mode. */ deleteFindChangeQuery(queryName: string, searchMode: SearchModes): void; /** * Deletes unused XML markup tags. */ deleteUnusedTags(): void; /** * Executes the script in the specified language as a single transaction. * @param script The script to execute. Can accept: File, String or JavaScript Function. * @param language The language of the script to execute. If not specified, uses the language used to call this method. (Optional) * @param withArguments An array of arguments passed to the script. (Optional) * @param undoMode How to undo this script. (Optional) * @param undoName The name of the undo step for entire script undo mode. (Optional) */ doScript(script: File | string | Function, language?: ScriptLanguage, withArguments?: any[], undoMode?: UndoModes, undoName?: string): any; /** * Dumps memory allocations from all marks in the specified range. * @param from The first mark in the range. * @param to The last mark in the range. */ dumpBetweenMemoryMarks(from: number[], to: number[]): void; /** * Dumps memory allocations from the specified mark. * @param from The mark from which to dump memory. */ dumpFromMemoryMark(from: number[]): void; /** * Export the specified documents to an article folio. Note: This method * behaves identically to @method(exportMiniFolio), but differs in its return * value. @method(exportMiniFolio) returns an array of warning strings whereas * this method returns an XML structure. * @param destination The location to write the file. * @param portraitDocument The InDesign document for the stack's portrait orientation. * @param landscapeDocument The InDesign document for the stack's landscape orientation. * @param folioMetadata Optional meta data for the mini folio. Can accept: Ordered array containing key:String, value:String. (Optional) * @param miniFolioParams Options for exporting a mini folio. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional) */ exportArticleFolio(destination: File, portraitDocument: Document, landscapeDocument: Document, folioMetadata?: (any[] | string)[], miniFolioParams?: (any[] | VariesType)[]): string; /** * Export the specified document to a DPS article. Note: This method behaves * similarly to @method(exportMiniFolio), but differs in its parameters. * @param destination The location to write the file. * @param document The source InDesign document. * @param dpsArticleParams Options for exporting a DPS article. Can accept: Ordered array containing dataField:String, dataValue:Any Type. */ exportDpsArticle(destination: File, document: Document, dpsArticleParams: (any[] | VariesType)[]): string[]; /** * Export the selected documents to a directory. * @param destination The directory to write the folio. * @param miniFolioList The mini folio(es) to add to the folio. Can accept: File or Array of Files. * @param folioMetadata Meta data for the folio. Can accept: Ordered array containing key:String, value:String. * @param exportFolioParams Additional options for export folios. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional) */ exportFolioToDirectory(destination: File, miniFolioList: (File | File[])[], folioMetadata: (any[] | string)[], exportFolioParams?: (any[] | VariesType)[]): void; /** * Export the selected documents to a compressed folio file that contains * non-compressed mini folios. * @param destination The location to write the package. * @param miniFolioList The mini folio(es) to add to the folio. Can accept: File or Array of Files. * @param folioMetadata Meta data for the folio. Can accept: Ordered array containing key:String, value:String. * @param exportFolioParams Additional options for export folios. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional) */ exportFolioToDirectoryPackage(destination: File, miniFolioList: (File | File[])[], folioMetadata: (any[] | string)[], exportFolioParams?: (any[] | VariesType)[]): void; /** * Export the selected documents to a compressed folio file that contains * compressed mini folios. * @param destination The location to write the package. * @param miniFolioList The mini folio(es) to add to the folio. Can accept: File or Array of Files. * @param folioMetadata Meta data for the folio. Can accept: Ordered array containing key:String, value:String. * @param exportFolioParams Additional options for export folios. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional) */ exportFolioToPackage(destination: File, miniFolioList: (File | File[])[], folioMetadata: (any[] | string)[], exportFolioParams?: (any[] | VariesType)[]): void; /** * Export the specified documents to a mini-folio. * @param destination The location to write the file. * @param portraitDocument The InDesign document for the stack's portrait orientation. * @param landscapeDocument The InDesign document for the stack's landscape orientation. * @param folioMetadata Optional meta data for the mini folio. Can accept: Ordered array containing key:String, value:String. (Optional) * @param miniFolioParams Options for exporting a mini folio. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional) */ exportMiniFolio(destination: File, portraitDocument: Document, landscapeDocument: Document, folioMetadata?: (any[] | string)[], miniFolioParams?: (any[] | VariesType)[]): string[]; /** * Export the presets to a file. * @param format The preset format. * @param to The file to export to. * @param versionComments The comments for this version. (Optional) * @param forceSave Forcibly save a version. (Optional) */ exportPresets(format: ExportPresetFormat, to: File, versionComments?: string, forceSave?: boolean): void; /** * Exports selection as assets required for cloud library. * @param to The path to the export file. */ exportSelectionForCloudLibrary(to: File): boolean; /** * export the customised settings * @param fileReference The reference to asset */ exportSettings(fileReference: string): void; /** * Exports stroke styles or presets. * @param to The file to save to * @param strokeStyleList The list of stroke styles to save * @param versionComments The comment for this version (Optional) * @param forceSave Forcibly save a version (Optional) */ exportStrokeStyles(to: File, strokeStyleList: StrokeStyle[], versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds color that matches the find what value. */ findColor(): number; /** * Finds glyphs that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGrep(reverseOrder?: boolean): Text[]; /** * Returns the locale-independent string(s) from the internal string * localization database that correspond to the specified string (in the * current locale). * @param for_ The string to search for. */ findKeyStrings(for_: string): string[]; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findTransliterate(reverseOrder?: boolean): Text[]; /** * Generate schema for IDML. * @param to The folder path of the schema. * @param packageFormat If true, generate schema for package format (multiple files). Default value is false. (Optional) */ generateIDMLSchema(to: File, packageFormat?: boolean): void; /** * Get all overlays. * @param portraitDocumentForCheckingOverlays The portrait document for checking overlays. * @param landscapeDocumentForCheckingOverlays The landscape document for checking overlays. * @param miniFolioParams Options for exporting a mini folio. Can accept: Ordered array containing dataField:String, dataValue:Any Type. (Optional) */ getAllOverlays(portraitDocumentForCheckingOverlays: Document, landscapeDocumentForCheckingOverlays: Document, miniFolioParams?: (any[] | VariesType)[]): any[]; /** * Get a JSON string for the CCX Welcome dialog. * @param jsondata mode description (Optional) */ getCCXUserJSONData(jsondata?: string): string; /** * Internal Use Only. */ getContextMathMLDescription(): string; /** * Get the current digital publishing article version number for the given * parameter. * @param digpubArticleVersion Version string(s) to retrieve. */ getDigpubArticleVersion(digpubArticleVersion: DigpubArticleVersion): string[]; /** * Get the current digital publishing version number for the given parameter. * @param digpubVersion Version string(s) to retrieve. */ getDigpubVersion(digpubVersion: DigpubVersion): string[]; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Application[]; /** * Internal Use Only. */ getPathToExportMml2svg(): string; /** * Get the resolution strategy for style conflict, false if the user cancels * @param charOrParaStyle Style type to look at. (Optional) */ getStyleConflictResolutionStrategy(charOrParaStyle?: StyleType): any; /** * Get the list of article viewer versions the digital publishing plugin * supports. */ getSupportedArticleViewerVersions(): string[]; /** * Get the list of viewer versions the digital publishing plugin supports. */ getSupportedViewerVersions(): string[]; /** * Gets the count which will be used in the name of the next untitled document. */ getUntitledCount(): number; /** * Gets the decision from the user to add the content of text frame or the * complete story in case of threaded text frame. */ getUserChoiceForCloudTextAddition(): any; /** * Internal Use Only * @param resyncData Internal Use Only */ handleMathMLMessage(resyncData: string): void; /** * Imports a process color swatch from a preloaded Adobe color book. * @param name The process color to load. */ importAdobeSwatchbookProcessColor(name: string): Color; /** * Imports a spot color swatch from an Adobe color book. * @param name The spot color to load. */ importAdobeSwatchbookSpotColor(name: string): Color; /** * Imports presets from the specified file. * @param format The type of preset to import. * @param from The file to import presets from. */ importFile(format: ExportPresetFormat, from: File): void; /** * import the customised settings * @param fileReference The reference to asset */ importSettings(fileReference: string): void; /** * Imports the specified styles. * @param format The types of styles to import. * @param from The file containing the styles you want to import. * @param globalStrategy The resolution strategy to employ for imported styles that have the same names as existing styles. (Optional) */ importStyles(format: ImportFormat, from: File, globalStrategy?: GlobalClashResolutionStrategy): void; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Internal use only: a black box method for use by InDesign Engineering team * only. * @param internalParameter1 The first internal parameter * @param internalParameter2 The second internal parameter */ internalMethod(internalParameter1: string, internalParameter2: string): string; /** * Invokes InDesign's Color Picker. * @param space Color space RGB, CMYK or LAB * @param colorValue Color values */ invokeColorPicker(space: ColorSpace, colorValue: number[]): string; /** * Whether the app is in touch mode or not. */ isAppInTouchMode(): boolean; /** * Whether user has opted-in to share usage data. */ isUserSharingAppUsageData(): boolean; /** * Load conditions from the specified file. * @param from The path to the file that contains the conditions. * @param loadConditionSets If true, load the condition sets as well. (Optional) */ loadConditions(from: File, loadConditionSets?: boolean): void; /** * Loads the specified find/change query. * @param queryName The query to load. * @param searchMode The search mode. */ loadFindChangeQuery(queryName: string, searchMode: SearchModes): void; /** * Load motion preset from the specified file. * @param from The Flash motion preset file. */ loadMotionPreset(from: File): MotionPreset; /** * Load preflight profile from the specified file. * @param from The InDesign preflight profile file or InDesign document. */ loadPreflightProfile(from: File): PreflightProfile; /** * Load swatches from the specified file. * @param from The swatch file or InDesign document. */ loadSwatches(from: File): void; /** * Loads a set of XML markup tags from the specified file. * @param from The path to the file that contains the tags. */ loadXMLTags(from: File): void; /** * Gets the memory statistics from the server. */ memoryStatistics(): any[]; /** * Mount a Version Cue project. * @param serverURL The URL of the Version Cue server containing the project * @param projectName The name of the Version Cue project to mount */ mountProject(serverURL: string, projectName: string): void; /** * Opens the specified document, book, or library. * @param from The file path(s) to the document, book, or library. Can accept: File or Array of Files. * @param showingWindow If true, opens the document in a window. If false, the document is opened but is not displayed in a window. (Optional) * @param openOption How to open the document. (Optional) */ open(from: (File | File[])[], showingWindow?: boolean, openOption?: OpenOptions): any; /** * Opens the cloud library asset for editing. * @param jsondata JSON encoded information about the asset to be edited. */ openCloudAssetForEdit(jsondata: string): boolean; /** * Open cloud document for a given reference. * @param assetReference The reference to asset * @param showingWindow If true, opens the document in a window. If false, the document is opened but is not displayed in a window. (Optional) */ openCloudDocument(assetReference: string, showingWindow?: boolean): Document; /** * Open the panel associated with the action. * @param id The ID. */ openPanel(id: number): void; /** * Package a folder into a UCF file. * @param sourceFolder The folder to be packaged into an IDML file. Does not validate structure of the folder pursuant to the IDML spec. Caller is responsible for making sure the files in the folder are correctly organized. * @param ucfFile The destination UCF file. Will be overwritten if it already exists. * @param mimeMediaType The MIME media type, default value identifies package as IDML. (Optional) */ packageUCF(sourceFolder: File, ucfFile: File, mimeMediaType?: string): void; /** * Pastes data from the clipboard into the active document window. */ paste(): void; /** * Pastes data from the clipboard into the active document window at the same * position that the data held in its original document. */ pasteInPlace(): void; /** * Pastes data from the clipboard into the selected object in the active * document window. */ pasteInto(): void; /** * Pastes data (minus formatting) from the clipboard into the active document * window. */ pasteWithoutFormatting(): void; /** * Gets the current value of the specified performance metric. * @param for_ The status to get from InDesign. Can accept: Long Integer or PerformanceMetricOptions enumerator. */ performanceMetric(for_: number | PerformanceMetricOptions): any; /** * Gets the long name of the specified performance metric. * @param for_ The status to get from InDesign. Can accept: Long Integer or PerformanceMetricOptions enumerator. */ performanceMetricLongName(for_: number | PerformanceMetricOptions): string; /** * Gets the short name of the specified performance metric. * @param for_ The status to get from InDesign. Can accept: Long Integer or PerformanceMetricOptions enumerator. */ performanceMetricShortName(for_: number | PerformanceMetricOptions): string; /** * Place one or more files following the behavior of the place menu item. This * may load the place gun or replace the selected object, depending on current * preferences. * @param fileName One or more files to place. Can accept: File or Array of Files. * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: (File | File[])[], showingOptions?: boolean, withProperties?: Object): void; /** * Prints the specified file(s). * @param from One or more file paths. Can accept: File or Array of Files. * @param printDialog Whether to invoke the print dialog (Optional) * @param using Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional) */ print(from: (File | File[])[], printDialog?: boolean, using?: PrinterPresetTypes | PrinterPreset): void; /** * Quits the application. * @param saving The option to use for saving changes to open documents before quitting. (Optional) */ quit(saving?: SaveOptions): void; /** * Redoes the last action. */ redo(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Remove the file from most recently used files * @param to The file to be removed */ removeFileFromRecentFiles(to: File): boolean; /** * reset to default preferences */ resetPreference(): void; /** * Saves the specified find/change query. * @param queryName The query to save. * @param searchMode The search mode. */ saveFindChangeQuery(queryName: string, searchMode: SearchModes): void; /** * Saves the specified swatch(es) to a swatchbook file. * @param to The swatchbook file to save to. * @param swatchList The swatch(es) to save. * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ saveSwatches(to: File, swatchList: Swatch[], versionComments?: string, forceSave?: boolean): void; /** * Saves a set of tags to an external file. * @param to The full path to the file in which to save the tags. * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ saveXMLTags(to: File, versionComments?: string, forceSave?: boolean): void; /** * Selects the specified object(s). * @param selectableItems The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator. * @param existingSelection The selection status of the Application in relation to previously selected objects. (Optional) */ select(selectableItems: (any[] | NothingEnum | Object | SelectAll)[], existingSelection?: SelectionOptions): void; /** * Sets the application's preferences. * @param applicationPreferences The IDML defaults file or enumeration. Can accept: File or LanguageAndRegion enumerator. */ setApplicationPreferences(applicationPreferences: File | LanguageAndRegion): void; /** * Set cloud libraries info. * @param librariesCollectionInfo JSON encoded information about cloud libraries collection */ setCloudLibraryCollection(librariesCollectionInfo: string): void; /** * Sets the export options for generation of a cloud asset. * @param maxwidth The maximum width of the thumbnail generated in pixels. * @param maxheight The maximum height of the thumbnail generated in pixels. */ setCloudLibraryOptions(maxwidth: number, maxheight: number): void; /** * Sets the count which will be used in the name of the next untitled document. * @param untitledCount The count to be used in the name of the next untitled document. Only positive values are expected */ setUntitledCount(untitledCount: number): void; /** * Tile all document windows */ tileWindows(): void; /** * Generates a string which, if executed, will return the Application. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Toggles the visibility of the entire panel system. */ togglePanelSystemVisibility(): void; /** * Translates a key string into localized form based on current application * locale. * @param for_ The key string to translate */ translateKeyString(for_: string): string; /** * Undoes the last action. */ undo(): void; /** * Unpackage a UCF file into a folder structure. * @param ucfFile The UCF file to be unpackaged. * @param destinationFolder The folder where you would like the UCF file unpackaged to. Will be created if it does not exist. */ unpackageUCF(ucfFile: File, destinationFolder: File): void; /** * Forces a check for new fonts in the various Fonts folders. */ updateFonts(): void; /** * Waits for all the background tasks to finish. */ waitForAllTasks(): TaskState[]; } /** * The order in which to arrange records in the target document. */ declare enum ArrangeBy { /** * Arranges records by column. */ COLUMNS_FIRST = 1684882278, /** * Arranges records by row. */ ROWS_FIRST = 1684886118, } /** * The shape of one or both ends of an open path. */ declare enum ArrowHead { /** * A solid arrow head whose pierced end bows sharply toward the point and whose * point describes a 45-degree angle. */ BARBED_ARROW_HEAD = 1650553442, /** * A vertical bar bisected by the stroke, which meets the stroke at a right * angle and is the same weight as the stroke. The bar's length is 4.5 times * the stroke width. */ BAR_ARROW_HEAD = 1651663208, /** * A hollow circle whose outline is the same weight as the stroke. The circle's * diameter is 5 times the stroke width. */ CIRCLE_ARROW_HEAD = 1668440424, /** * A solid circle whose diameter is 5 times the stroke width. */ CIRCLE_SOLID_ARROW_HEAD = 1668505960, /** * A solid arrow head whose pierced end concaves toward the point and whose * point describes a 45-degree angle. */ CURVED_ARROW_HEAD = 1668702568, /** * None. */ NONE = 1852796517, /** * An arrow head formed by two slanting lines whose intersection forms a * 45-degree angle and whose stroke weight is the same as the path's stroke. */ SIMPLE_ARROW_HEAD = 1936289136, /** * An arrow head formed by two slanting lines whose intersection forms a * 90-degree angle and whose stroke weight is the same as the path's stroke. */ SIMPLE_WIDE_ARROW_HEAD = 1937203560, /** * A hollow square set perpendicular to the path, whose outline is the same * weight as the stroke. The length of one side of the square is 5 times the * stroke width. */ SQUARE_ARROW_HEAD = 1936810344, /** * A solid square set perpendicular to the end of the path. The length of one * side of the square is 5 times the stroke width. */ SQUARE_SOLID_ARROW_HEAD = 1936941416, /** * A solid triangle arrow head whose point describes a 45-degree angle. */ TRIANGLE_ARROW_HEAD = 1953655150, /** * A solid triangle arrow head whose point describes a 90-degree angle. */ TRIANGLE_WIDE_ARROW_HEAD = 1953980776, } /** * Arrowhead alignment types. */ declare enum ArrowHeadAlignmentEnum { /** * The arrowhead is inside the path, path geometry changes to accomodate arrow * heads. */ INSIDE_PATH = 1634230633, /** * The arrowhead is outside the path i.e. path geometry remains same. */ OUTSIDE_PATH = 1634230639, } /** * An article */ declare class Article { /** * The export status of the Article */ articleExportStatus: boolean; /** * A collection of article members. */ readonly articleMembers: ArticleMembers; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the Article. */ readonly id: number; /** * The index of the Article within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the Article. */ name: string; /** * The parent of the Article (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Populates the article with all page items in the document. */ addDocumentContent(): void; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Article[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Moves the Article to the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to value specifies before or after. (Optional) */ move(to: LocationOptions, reference?: Article): Article; /** * Deletes the Article. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Article. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Member of a group that is part of an article. */ declare class ArticleChild { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the ArticleChild. */ readonly id: number; /** * The index of the ArticleChild within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The underlying page item */ readonly itemRef: PageItem; /** * The parent of the ArticleChild (a Group). */ readonly parent: Group; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ArticleChild[]; /** * Moves the ArticleChild to the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to value specifies before or after. (Optional) */ move(to: LocationOptions, reference?: ArticleChild): ArticleChild; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ArticleChild. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of group items that are also part of an article. */ declare class ArticleChildren { /** Returns the ArticleChild with the specified index or name. */ [index: number]: ArticleChild; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any ArticleChild in the collection. */ anyItem(): ArticleChild; /** * Displays the number of elements in the ArticleChild. */ count(): number; /** * Returns every ArticleChild in the collection. */ everyItem(): ArticleChild; /** * Returns the first ArticleChild in the collection. */ firstItem(): ArticleChild; /** * Returns the ArticleChild with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): ArticleChild; /** * Returns the ArticleChild with the specified ID. * @param id The ID. */ itemByID(id: number): ArticleChild; /** * Returns the ArticleChildren within the specified range. * @param from The ArticleChild, index, or name at the beginning of the range. Can accept: ArticleChild, Long Integer or String. * @param to The ArticleChild, index, or name at the end of the range. Can accept: ArticleChild, Long Integer or String. */ itemByRange(from: ArticleChild | number | string, to: ArticleChild | number | string): ArticleChild[]; /** * Returns the last ArticleChild in the collection. */ lastItem(): ArticleChild; /** * Returns the middle ArticleChild in the collection. */ middleItem(): ArticleChild; /** * Returns the ArticleChild whose index follows the specified ArticleChild in * the collection. * @param obj The ArticleChild whose index comes before the desired ArticleChild. */ nextItem(obj: ArticleChild): ArticleChild; /** * Returns the ArticleChild with the index previous to the specified index. * @param obj The index of the ArticleChild that follows the desired ArticleChild. */ previousItem(obj: ArticleChild): ArticleChild; /** * Generates a string which, if executed, will return the ArticleChild. */ toSource(): string; } /** * An article member. */ declare class ArticleMember { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the ArticleMember. */ readonly id: number; /** * The index of the ArticleMember within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The underlying page item */ readonly itemRef: PageItem; /** * The parent of the ArticleMember (a Article). */ readonly parent: Article; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ArticleMember[]; /** * Moves the ArticleMember to the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to value specifies before or after. (Optional) */ move(to: LocationOptions, reference?: ArticleMember): ArticleMember; /** * Deletes the ArticleMember. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ArticleMember. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of article members. */ declare class ArticleMembers { /** Returns the ArticleMember with the specified index or name. */ [index: number]: ArticleMember; /** * The number of objects in the collection. */ readonly length: number; /** * Adds a new member. * @param itemRef page item to be added to article * @param at The location relative to the reference object or within the containing object. (Optional) * @param reference The reference object. Note: Required when the to value specifies before or after. (Optional) * @param withProperties Initial values for properties of the new ArticleMember (Optional) */ add(itemRef: PageItem, at?: LocationOptions, reference?: ArticleMember, withProperties?: Object): ArticleMember; /** * Returns any ArticleMember in the collection. */ anyItem(): ArticleMember; /** * Displays the number of elements in the ArticleMember. */ count(): number; /** * Returns every ArticleMember in the collection. */ everyItem(): ArticleMember; /** * Returns the first ArticleMember in the collection. */ firstItem(): ArticleMember; /** * Returns the ArticleMember with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): ArticleMember; /** * Returns the ArticleMember with the specified ID. * @param id The ID. */ itemByID(id: number): ArticleMember; /** * Returns the ArticleMembers within the specified range. * @param from The ArticleMember, index, or name at the beginning of the range. Can accept: ArticleMember, Long Integer or String. * @param to The ArticleMember, index, or name at the end of the range. Can accept: ArticleMember, Long Integer or String. */ itemByRange(from: ArticleMember | number | string, to: ArticleMember | number | string): ArticleMember[]; /** * Returns the last ArticleMember in the collection. */ lastItem(): ArticleMember; /** * Returns the middle ArticleMember in the collection. */ middleItem(): ArticleMember; /** * Returns the ArticleMember whose index follows the specified ArticleMember in * the collection. * @param obj The ArticleMember whose index comes before the desired ArticleMember. */ nextItem(obj: ArticleMember): ArticleMember; /** * Returns the ArticleMember with the index previous to the specified index. * @param obj The index of the ArticleMember that follows the desired ArticleMember. */ previousItem(obj: ArticleMember): ArticleMember; /** * Generates a string which, if executed, will return the ArticleMember. */ toSource(): string; } /** * A collection of articles. */ declare class Articles { /** Returns the Article with the specified index or name. */ [index: number]: Article; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new Article * @param name The article name (Optional) * @param articleExportStatus The article's export status (Optional) * @param at The location relative to the reference object or within the containing object. (Optional) * @param reference The reference object. Note: Required when the to value specifies before or after. (Optional) * @param withProperties Initial values for properties of the new Article (Optional) */ add(name?: string, articleExportStatus?: boolean, at?: LocationOptions, reference?: Article, withProperties?: Object): Article; /** * Returns any Article in the collection. */ anyItem(): Article; /** * Displays the number of elements in the Article. */ count(): number; /** * Returns every Article in the collection. */ everyItem(): Article; /** * Returns the first Article in the collection. */ firstItem(): Article; /** * Returns the Article with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Article; /** * Returns the Article with the specified ID. * @param id The ID. */ itemByID(id: number): Article; /** * Returns the Article with the specified name. * @param name The name. */ itemByName(name: string): Article; /** * Returns the Articles within the specified range. * @param from The Article, index, or name at the beginning of the range. Can accept: Article, Long Integer or String. * @param to The Article, index, or name at the end of the range. Can accept: Article, Long Integer or String. */ itemByRange(from: Article | number | string, to: Article | number | string): Article[]; /** * Returns the last Article in the collection. */ lastItem(): Article; /** * Returns the middle Article in the collection. */ middleItem(): Article; /** * Returns the Article whose index follows the specified Article in the * collection. * @param obj The Article whose index comes before the desired Article. */ nextItem(obj: Article): Article; /** * Returns the Article with the index previous to the specified index. * @param obj The index of the Article that follows the desired Article. */ previousItem(obj: Article): Article; /** * Generates a string which, if executed, will return the Article. */ toSource(): string; } /** * An object library asset. */ declare class Asset { /** * The type of object library asset. */ assetType: AssetType; /** * The date and time the Asset was created. */ readonly date: Date; /** * The description of the Asset. */ description: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the Asset. */ readonly id: number; /** * The index of the Asset within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the Asset. */ name: string; /** * The parent of the Asset (a Library). */ readonly parent: Library; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Asset[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Places the asset in the specified document or text. * @param on The document or text object in which to place the asset. Can accept: Document or Text. */ placeAsset(on: Document | Text): any[]; /** * Deletes the Asset. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Selects the object. * @param existingSelection The selection status of the Asset in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Generates a string which, if executed, will return the Asset. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Asset type options. */ declare enum AssetType { /** * The asset is cataloged as an EPS asset. */ EPS_TYPE = 1952400720, /** * The asset is cataloged as a geometric page item asset. */ GEOMETRY_TYPE = 1952409445, /** * The asset is cataloged as an image asset. */ IMAGE_TYPE = 1952409965, /** * InDesign file asset */ INDESIGN_FILE_TYPE = 1952409956, /** * The asset is cataloged as a page asset. */ PAGE_TYPE = 1952411745, /** * The asset is cataloged as a PDF asset. */ PDF_TYPE = 1952403524, /** * Structure asset */ STRUCTURE_TYPE = 1952412532, /** * The asset is cataloged as a text asset. */ TEXT_TYPE = 1952412773, } /** * A collection of object library assets. */ declare class Assets { /** Returns the Asset with the specified index or name. */ [index: number]: Asset; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Asset in the collection. */ anyItem(): Asset; /** * Displays the number of elements in the Asset. */ count(): number; /** * Returns every Asset in the collection. */ everyItem(): Asset; /** * Returns the first Asset in the collection. */ firstItem(): Asset; /** * Returns the Asset with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Asset; /** * Returns the Asset with the specified ID. * @param id The ID. */ itemByID(id: number): Asset; /** * Returns the Asset with the specified name. * @param name The name. */ itemByName(name: string): Asset; /** * Returns the Assets within the specified range. * @param from The Asset, index, or name at the beginning of the range. Can accept: Asset, Long Integer or String. * @param to The Asset, index, or name at the end of the range. Can accept: Asset, Long Integer or String. */ itemByRange(from: Asset | number | string, to: Asset | number | string): Asset[]; /** * Returns the last Asset in the collection. */ lastItem(): Asset; /** * Returns the middle Asset in the collection. */ middleItem(): Asset; /** * Returns the Asset whose index follows the specified Asset in the collection. * @param obj The Asset whose index comes before the desired Asset. */ nextItem(obj: Asset): Asset; /** * Returns the Asset with the index previous to the specified index. * @param obj The index of the Asset that follows the desired Asset. */ previousItem(obj: Asset): Asset; /** * Generates a string which, if executed, will return the Asset. */ toSource(): string; } /** * A collection of assigned stories. */ declare class AssignedStories { /** Returns the AssignedStory with the specified index or name. */ [index: number]: AssignedStory; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any AssignedStory in the collection. */ anyItem(): AssignedStory; /** * Displays the number of elements in the AssignedStory. */ count(): number; /** * Returns every AssignedStory in the collection. */ everyItem(): AssignedStory; /** * Returns the first AssignedStory in the collection. */ firstItem(): AssignedStory; /** * Returns the AssignedStory with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): AssignedStory; /** * Returns the AssignedStory with the specified ID. * @param id The ID. */ itemByID(id: number): AssignedStory; /** * Returns the AssignedStory with the specified name. * @param name The name. */ itemByName(name: string): AssignedStory; /** * Returns the AssignedStories within the specified range. * @param from The AssignedStory, index, or name at the beginning of the range. Can accept: AssignedStory, Long Integer or String. * @param to The AssignedStory, index, or name at the end of the range. Can accept: AssignedStory, Long Integer or String. */ itemByRange(from: AssignedStory | number | string, to: AssignedStory | number | string): AssignedStory[]; /** * Returns the last AssignedStory in the collection. */ lastItem(): AssignedStory; /** * Returns the middle AssignedStory in the collection. */ middleItem(): AssignedStory; /** * Returns the AssignedStory whose index follows the specified AssignedStory in * the collection. * @param obj The AssignedStory whose index comes before the desired AssignedStory. */ nextItem(obj: AssignedStory): AssignedStory; /** * Returns the AssignedStory with the index previous to the specified index. * @param obj The index of the AssignedStory that follows the desired AssignedStory. */ previousItem(obj: AssignedStory): AssignedStory; /** * Generates a string which, if executed, will return the AssignedStory. */ toSource(): string; } /** * An assigned story. */ declare class AssignedStory { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The file path (colon delimited on the Mac OS). Can also accept: File. */ readonly filePath: string | File; /** * The unique ID of the AssignedStory. */ readonly id: number; /** * The index of the AssignedStory within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the AssignedStory. */ name: string; /** * The parent of the AssignedStory (a Assignment). */ readonly parent: Assignment; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A reference to the assigned story. Can return: Story, PageItem, Oval, * Rectangle or Polygon. */ readonly storyReference: Oval | PageItem | Rectangle | Story | Polygon; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): AssignedStory[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Moves the assigned story to the specified location. * @param to The location of the assigned story relative to the reference object or within the containing object. (Optional) * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Assignment or AssignedStory. (Optional) */ move(to?: LocationOptions, reference?: Assignment | AssignedStory): AssignedStory; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the AssignedStory. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * An assignment. */ declare class Assignment { /** * A collection of assigned stories. */ readonly assignedStories: AssignedStories; /** * The status of the assignment file. */ readonly assignmentFileStatus: AssignmentStatus; /** * The path to the document that the hyperlink destination points to. */ readonly documentPath: File; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The content to export in the assignment. */ exportOptions: AssignmentExportOptions; /** * The file path (colon delimited on the Mac OS). Can also accept: File. */ readonly filePath: string | File; /** * The color of the assignment's frames. Can return: Array of 3 Reals (0 - 255) * or UIColors enumerator or NothingEnum enumerator. */ frameColor: (number[][] | NothingEnum | UIColors)[]; /** * The unique ID of the Assignment. */ readonly id: number; /** * If true, includes linked files when packaging the assignment. */ includeLinksWhenPackage: boolean; /** * The index of the Assignment within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the Assignment. */ name: string; /** * If true, the assignment package is up to date. */ readonly packageUpToDate: boolean; /** * If true, the assignment is packaged. */ readonly packaged: boolean; /** * The parent of the Assignment (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The user name to assign to tracked changes and notes. */ userName: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Cancels the package for an assignment. */ cancelPackage(): void; /** * Creates an assignment package. * @param filePath The full path name of the assignment package file. * @param submit If true, submits assigned stories before packaging the assignment. (Optional) * @param withProperties Initial values for properties of the new Assignment (Optional) */ createPackage(filePath: File, submit?: boolean, withProperties?: Object): File; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Assignment[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the assignment and its file. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Assignment. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Updates the assignment file. * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ update(versionComments?: string, forceSave?: boolean): void; } /** * Export options for assignment files. */ declare enum AssignmentExportOptions { /** * Exports only spreads with assigned frames. */ ASSIGNED_SPREADS = 1098073459, /** * Exports frames but does not export content. */ EMPTY_FRAMES = 1098073446, /** * Exports the entire document. */ EVERYTHING = 1098073441, } /** * The status of the assigment. */ declare enum AssignmentStatus { /** * The assignment file is missing. */ ASSIGNMENT_FILE_MISSING = 1095126387, /** * The assignment has been modified and needs to be updated. */ ASSIGNMENT_OUT_OF_DATE = 1095724868, /** * The assignment has not been modified. */ ASSIGNMENT_UP_TO_DATE = 1096119364, } /** * A collection of assignments. */ declare class Assignments { /** Returns the Assignment with the specified index or name. */ [index: number]: Assignment; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new assignment. * @param filePath The full path name of the new assignment. * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) * @param withProperties Initial values for properties of the new Assignment (Optional) */ add(filePath: File, versionComments?: string, forceSave?: boolean, withProperties?: Object): Assignment; /** * Returns any Assignment in the collection. */ anyItem(): Assignment; /** * Displays the number of elements in the Assignment. */ count(): number; /** * Returns every Assignment in the collection. */ everyItem(): Assignment; /** * Returns the first Assignment in the collection. */ firstItem(): Assignment; /** * Returns the Assignment with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Assignment; /** * Returns the Assignment with the specified ID. * @param id The ID. */ itemByID(id: number): Assignment; /** * Returns the Assignment with the specified name. * @param name The name. */ itemByName(name: string): Assignment; /** * Returns the Assignments within the specified range. * @param from The Assignment, index, or name at the beginning of the range. Can accept: Assignment, Long Integer or String. * @param to The Assignment, index, or name at the end of the range. Can accept: Assignment, Long Integer or String. */ itemByRange(from: Assignment | number | string, to: Assignment | number | string): Assignment[]; /** * Returns the last Assignment in the collection. */ lastItem(): Assignment; /** * Returns the middle Assignment in the collection. */ middleItem(): Assignment; /** * Returns the Assignment whose index follows the specified Assignment in the * collection. * @param obj The Assignment whose index comes before the desired Assignment. */ nextItem(obj: Assignment): Assignment; /** * Returns the Assignment with the index previous to the specified index. * @param obj The index of the Assignment that follows the desired Assignment. */ previousItem(obj: Assignment): Assignment; /** * Generates a string which, if executed, will return the Assignment. */ toSource(): string; } /** * The device types that are attached. */ declare enum AttachedDevices { /** * all devices, Android followed by iOS. */ ALL = 1634495520, /** * Android devices. */ ANDROID = 1685086564, /** * iOS devices. */ IOS = 1684631411, } /** * Auto-correct preferences. */ declare class AutoCorrectPreference extends Preference { /** * If true, automatically corrects misspelled words listed in the auto-correct * table. */ autoCorrect: boolean; /** * If true, automatically corrects capitalization errors listed in the * auto-correct table. */ autoCorrectCapitalizationErrors: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the AutoCorrectPreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): AutoCorrectPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * AutoCorrectPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * An auto-correct table. */ declare class AutoCorrectTable { /** * An auto-correct word pair, specified as a misspelled word and a corrected * word. Can return: Array of Arrays of 2 Strings. */ autoCorrectWordPairList: string[][][][]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the AutoCorrectTable within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the AutoCorrectTable. */ readonly name: string; /** * The parent of the AutoCorrectTable (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): AutoCorrectTable[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the AutoCorrectTable. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of auto-correct tables. */ declare class AutoCorrectTables { /** Returns the AutoCorrectTable with the specified index or name. */ [index: number]: AutoCorrectTable; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any AutoCorrectTable in the collection. */ anyItem(): AutoCorrectTable; /** * Displays the number of elements in the AutoCorrectTable. */ count(): number; /** * Returns every AutoCorrectTable in the collection. */ everyItem(): AutoCorrectTable; /** * Returns the first AutoCorrectTable in the collection. */ firstItem(): AutoCorrectTable; /** * Returns the AutoCorrectTable with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): AutoCorrectTable; /** * Returns the AutoCorrectTable with the specified name. * @param name The name. */ itemByName(name: string): AutoCorrectTable; /** * Returns the AutoCorrectTables within the specified range. * @param from The AutoCorrectTable, index, or name at the beginning of the range. Can accept: AutoCorrectTable, Long Integer or String. * @param to The AutoCorrectTable, index, or name at the end of the range. Can accept: AutoCorrectTable, Long Integer or String. */ itemByRange(from: AutoCorrectTable | number | string, to: AutoCorrectTable | number | string): AutoCorrectTable[]; /** * Returns the last AutoCorrectTable in the collection. */ lastItem(): AutoCorrectTable; /** * Returns the middle AutoCorrectTable in the collection. */ middleItem(): AutoCorrectTable; /** * Returns the AutoCorrectTable whose index follows the specified * AutoCorrectTable in the collection. * @param obj The AutoCorrectTable whose index comes before the desired AutoCorrectTable. */ nextItem(obj: AutoCorrectTable): AutoCorrectTable; /** * Returns the AutoCorrectTable with the index previous to the specified index. * @param obj The index of the AutoCorrectTable that follows the desired AutoCorrectTable. */ previousItem(obj: AutoCorrectTable): AutoCorrectTable; /** * Generates a string which, if executed, will return the AutoCorrectTable. */ toSource(): string; } /** * The default value. */ declare enum AutoEnum { /** * Uses the default value defined automatically for the object based on a * parent or other type of object. */ AUTO_VALUE = 1635087471, } /** * Auto sizing reference points for text. */ declare enum AutoSizingReferenceEnum { /** * Center point on the botom edge of bounding box */ BOTTOM_CENTER_POINT = 1651467109, /** * Bottom left point of bounding box */ BOTTOM_LEFT_POINT = 1651469413, /** * Bottom right point of bounding box */ BOTTOM_RIGHT_POINT = 1651470953, /** * Center point of bounding box */ CENTER_POINT = 1668183154, /** * Center point on the left edge of bounding box */ LEFT_CENTER_POINT = 1818583909, /** * Center point on the right edge of bounding box */ RIGHT_CENTER_POINT = 1919509349, /** * Center point on the top edge of bounding box */ TOP_CENTER_POINT = 1953456997, /** * Top left point of bounding box */ TOP_LEFT_POINT = 1953459301, /** * Top right point of bounding box */ TOP_RIGHT_POINT = 1953460841, } /** * Auto sizing type options for text. */ declare enum AutoSizingTypeEnum { /** * Text frame will be resized in both(height and width) dimensions. */ HEIGHT_AND_WIDTH = 1752069993, /** * Text frame will be resized in both(height and width) dimensions * proportionally. */ HEIGHT_AND_WIDTH_PROPORTIONALLY = 1752070000, /** * Text frame will be resized in height dimension only. */ HEIGHT_ONLY = 1751476583, /** * Text frame auto-sizing is off. */ OFF = 1330005536, /** * Text frame will be resized in width dimension only. */ WIDTH_ONLY = 2003395700, } /** * background task */ declare class BackgroundTask { /** * The alerts encountered while running this task object. Can return: Array of * Array of 2 TaskAlertType enumerators or Strings. */ readonly alerts: (TaskAlertType[] | string[])[]; /** * The document name on which this task operates. */ readonly documentName: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the BackgroundTask. */ readonly id: number; /** * The index of the BackgroundTask within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the BackgroundTask. */ readonly name: string; /** * The parent of the BackgroundTask (a Application). */ readonly parent: Application; /** * Progress information for this task. */ readonly percentDone: number; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The current status of this task object. */ readonly status: TaskState; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Cancels the specified background task. */ cancelTask(): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): BackgroundTask[]; /** * Queries for a particular property in the task metadata. * @param name The task property being queried */ queryProperty(name: string): any; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the BackgroundTask. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Waits for the task to finish. */ waitForTask(): TaskState; } /** * A collection of background task objects. */ declare class BackgroundTasks { /** Returns the BackgroundTask with the specified index or name. */ [index: number]: BackgroundTask; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any BackgroundTask in the collection. */ anyItem(): BackgroundTask; /** * Displays the number of elements in the BackgroundTask. */ count(): number; /** * Returns every BackgroundTask in the collection. */ everyItem(): BackgroundTask; /** * Returns the first BackgroundTask in the collection. */ firstItem(): BackgroundTask; /** * Returns the BackgroundTask with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): BackgroundTask; /** * Returns the BackgroundTask with the specified ID. * @param id The ID. */ itemByID(id: number): BackgroundTask; /** * Returns the BackgroundTask with the specified name. * @param name The name. */ itemByName(name: string): BackgroundTask; /** * Returns the BackgroundTasks within the specified range. * @param from The BackgroundTask, index, or name at the beginning of the range. Can accept: BackgroundTask, Long Integer or String. * @param to The BackgroundTask, index, or name at the end of the range. Can accept: BackgroundTask, Long Integer or String. */ itemByRange(from: BackgroundTask | number | string, to: BackgroundTask | number | string): BackgroundTask[]; /** * Returns the last BackgroundTask in the collection. */ lastItem(): BackgroundTask; /** * Returns the middle BackgroundTask in the collection. */ middleItem(): BackgroundTask; /** * Returns the BackgroundTask whose index follows the specified BackgroundTask * in the collection. * @param obj The BackgroundTask whose index comes before the desired BackgroundTask. */ nextItem(obj: BackgroundTask): BackgroundTask; /** * Returns the BackgroundTask with the index previous to the specified index. * @param obj The index of the BackgroundTask that follows the desired BackgroundTask. */ previousItem(obj: BackgroundTask): BackgroundTask; /** * Generates a string which, if executed, will return the BackgroundTask. */ toSource(): string; } /** * Options for balancing line endings in the text. */ declare enum BalanceLinesStyle { /** * Balances lines equally. */ FULLY_BALANCED = 1114391921, /** * Does not balance lines. */ NO_BALANCING = 1114394470, /** * Prefers longer last lines. */ PYRAMID_SHAPE = 1114394745, /** * Prefers shorter last lines. */ VEE_SHAPE = 1114396261, } /** * Baseline frame grid options. */ declare class BaselineFrameGridOption extends Preference { /** * The grid line color, specified either as an array of three doubles, each in * the range 0 to 255 and representing R, G, and B values, or as a UI color. * Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. */ baselineFrameGridColor: (number[][] | UIColors)[]; /** * The distance between grid lines. * @remarks Measurement unit — also accepts a string such as "12mm". */ baselineFrameGridIncrement: number | string; /** * The location (top of page, top margin, top of frame, or frame inset) on * which to base the custom baseline grid. */ baselineFrameGridRelativeOption: BaselineFrameGridRelativeOption; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the BaselineFrameGridOption (a Application, Document, * TextFrame, EndnoteTextFrame or ObjectStyle). */ readonly parent: Document | EndnoteTextFrame | TextFrame | Application | ObjectStyle; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The amount to offset the baseline grid. * @remarks Measurement unit — also accepts a string such as "12mm". */ startingOffsetForBaselineFrameGrid: number | string; /** * If true, uses a custom baseline frame grid. */ useCustomBaselineFrameGrid: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): BaselineFrameGridOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * BaselineFrameGridOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * The starting point used to calculate the baseline frame grid offset. */ declare enum BaselineFrameGridRelativeOption { /** * Offsets the grid from the top of the text frame. */ TOP_OF_FRAME = 1163161446, /** * Offsets the grid from the top inset of the text frame. */ TOP_OF_INSET = 1163161449, /** * Offsets the grid from the top margin of the page. */ TOP_OF_MARGIN = 1163161453, /** * Offsets the grid from the top of the page. */ TOP_OF_PAGE = 1163161458, } /** * The zero point for the baseline grid offset. */ declare enum BaselineGridRelativeOption { /** * The baseline grid offset zero point is at the top page margin. */ TOP_OF_MARGIN_OF_BASELINE_GRID_RELATIVE_OPTION = 1162766189, /** * The baseline grid offset zero point is at the top of the page. */ TOP_OF_PAGE_OF_BASELINE_GRID_RELATIVE_OPTION = 1162766196, } /** * A behavior object. */ declare class Behavior { /** * The event which triggers the behavior. */ behaviorEvent: BehaviorEvents; /** * If true, the behavior is enabled. */ enableBehavior: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the Behavior. */ readonly id: number; /** * The index of the Behavior within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the Behavior. */ readonly name: string; /** * The parent of the Behavior (a Button, CheckBox, ComboBox, ListBox, * RadioButton, TextBox or SignatureField). */ readonly parent: CheckBox | ComboBox | ListBox | RadioButton | TextBox | Button | SignatureField; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Behavior[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the Behavior. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Behavior. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Behavior trigger event options. */ declare enum BehaviorEvents { /** * Triggers the behavior when the mouse button is clicked (without being * released). */ MOUSE_DOWN = 1835296118, /** * Triggers the behavior when the mouse pointer enters the area defined by the * bounding box of the object. */ MOUSE_ENTER = 1835361654, /** * Triggers the behavior when the mouse pointer exits the area defined by the * bounding box of the object. */ MOUSE_EXIT = 1836606838, /** * Triggers the behavior when the mouse is released after a click. */ MOUSE_UP = 1836410230, /** * Triggers the behavior when the focus moves to a different interactive * object. */ ON_BLUR = 1868719478, /** * Triggers the behavior when the object receives focus, either through a mouse * action or by pressing the Tab key. */ ON_FOCUS = 1868981622, } /** * A collection of behavior objects. */ declare class Behaviors { /** Returns the Behavior with the specified index or name. */ [index: number]: Behavior; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Behavior in the collection. */ anyItem(): Behavior; /** * Displays the number of elements in the Behavior. */ count(): number; /** * Returns every Behavior in the collection. */ everyItem(): Behavior; /** * Returns the first Behavior in the collection. */ firstItem(): Behavior; /** * Returns the Behavior with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Behavior; /** * Returns the Behavior with the specified ID. * @param id The ID. */ itemByID(id: number): Behavior; /** * Returns the Behavior with the specified name. * @param name The name. */ itemByName(name: string): Behavior; /** * Returns the Behaviors within the specified range. * @param from The Behavior, index, or name at the beginning of the range. Can accept: Behavior, Long Integer or String. * @param to The Behavior, index, or name at the end of the range. Can accept: Behavior, Long Integer or String. */ itemByRange(from: Behavior | number | string, to: Behavior | number | string): Behavior[]; /** * Returns the last Behavior in the collection. */ lastItem(): Behavior; /** * Returns the middle Behavior in the collection. */ middleItem(): Behavior; /** * Returns the Behavior whose index follows the specified Behavior in the * collection. * @param obj The Behavior whose index comes before the desired Behavior. */ nextItem(obj: Behavior): Behavior; /** * Returns the Behavior with the index previous to the specified index. * @param obj The index of the Behavior that follows the desired Behavior. */ previousItem(obj: Behavior): Behavior; /** * Generates a string which, if executed, will return the Behavior. */ toSource(): string; } /** * Bevel and emboss direction options. */ declare enum BevelAndEmbossDirection { /** * The effect appears depressed. */ DOWN = 1181971556, /** * The effect appears raised. */ UP = 1181971566, } /** * Bevel and emboss effect settings. */ declare class BevelAndEmbossSetting extends Preference { /** * The altitude of the light source. (Range: 0 to 90) * @remarks Range: 0 to 100 */ altitude: number; /** * The angle of the light source. (Range: -180 to 180) * @remarks Range: -180 to 180 */ angle: number; /** * If true, the bevel or emboss effect is applied. */ applied: boolean; /** * The depth of the bevel or emboss (as a percentage). (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ depth: number; /** * The direction of the bevel or emboss. */ direction: BevelAndEmbossDirection; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The blending mode for the highlight portion of the effect. */ highlightBlendMode: BlendMode; /** * The color applied to the highlight portion of the effect, specified as a * swatch (color, gradient, tint, or mixed ink), a color library color, a hex * value, or as an array of color values. The color mode dictates the array * values: for RGB, specify three values, each in the range 0 to 255, in the * format [R,G,B]; for CMYK, specify four values, each as a percentage and each * in the range 0 to 100, in the format [C,M,Y,K]; for LAB, specify three * values in the format [L,A,B], with L in the range 0 to 100 and A and B in * the range -128 to 127; for HSB, specify three colors in the format [H,S,B], * with H in the range 0 to 360 and S and B as percentages in the range 0 to * 100. */ highlightColor: Swatch; /** * The opacity of the highlight portion of the effect (as a percentage). * (Range: 0 to 100) * @remarks Range: 0 to 100 */ highlightOpacity: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the BevelAndEmbossSetting (a TransparencySetting, * StrokeTransparencySetting, FillTransparencySetting or * ContentTransparencySetting). */ readonly parent: FillTransparencySetting | StrokeTransparencySetting | ContentTransparencySetting | TransparencySetting; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The blending mode for the shadow portion of the effect. */ shadowBlendMode: BlendMode; /** * The color applied to the shadow portion of the effect, specified as a swatch * (color, gradient, tint, or mixed ink), a color library color, a hex value, * or as an array of color values. The color mode dictates the array values: * for RGB, specify three values, each in the range 0 to 255, in the format * [R,G,B]; for CMYK, specify four values, each as a percentage and each in the * range 0 to 100, in the format [C,M,Y,K]; for LAB, specify three values in * the format [L,A,B], with L in the range 0 to 100 and A and B in the range * -128 to 127; for HSB, specify three colors in the format [H,S,B], with H in * the range 0 to 360 and S and B as percentages in the range 0 to 100. */ shadowColor: Swatch; /** * The opacity of the shadow portion of the effect (as a percentage). (Range: 0 * to 100) * @remarks Range: 0 to 100 */ shadowOpacity: number; /** * The size of the bevel or emboss. * @remarks Measurement unit — also accepts a string such as "12mm". */ size: number | string; /** * The amount (in pixels) of softening. * @remarks Measurement unit — also accepts a string such as "12mm". */ soften: number | string; /** * The style of bevel or emboss. */ style: BevelAndEmbossStyle; /** * The edging technique of the bevel or emboss. */ technique: BevelAndEmbossTechnique; /** * If true, the global light source is used. */ useGlobalLight: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): BevelAndEmbossSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * BevelAndEmbossSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Bevel and emboss style options. */ declare enum BevelAndEmbossStyle { /** * An emboss effect is applied to the object. */ EMBOSS = 2020618851, /** * The inside edges of the object are beveled. */ INNER_BEVEL = 2020618850, /** * The outside edges of the object are beveled. */ OUTER_BEVEL = 2020618849, /** * An emboss effect is applied to the edges of the object. */ PILLOW_EMBOSS = 2020618852, } /** * Bevel and emboss technique options. */ declare enum BevelAndEmbossTechnique { /** * Emboss and bevel contours are chiseled and have hard corners. */ CHISEL_HARD = 2020619106, /** * Emboss or bevel contours chiseled but softened somewhat. */ CHISEL_SOFT = 2020619107, /** * Emboss and bevel contours are smooth. */ SMOOTH_CONTOUR = 2020619105, } /** * The location of the binding spine in a spread. */ declare enum BindingOptions { /** * Uses the default binding side. */ DEFAULT_VALUE = 1147563124, /** * Moves the page to the left side of the spread's binding spine. */ LEFT_ALIGN = 1818584692, /** * Moves the page to the right side of the spread's binding spine. */ RIGHT_ALIGN = 1919379572, } /** * The type of compression for bitmap images. */ declare enum BitmapCompression { /** * The Automatic JPEG 2000 compression method. */ AUTOMATIC_JPEG_2000 = 1634365490, /** * Uses JPEG compression and automatically determines the best quality type. * Valid only when acrobat compatibility is acrobat 6 or higher. */ AUTO_COMPRESSION = 1631808880, /** * Uses JPEG compression. */ JPEG = 1785751398, /** * Uses JPEG 2000 compression. Valid only when acrobat compatibility is acrobat * 6 or higher. */ JPEG_2000 = 1785751346, /** * Uses no compression. */ NONE = 1852796517, /** * Uses ZIP compression. */ ZIP = 2053730371, } /** * Blend mode options. */ declare enum BlendMode { /** * Creates a color with the luminance of the base color and the hue and * saturation of the blend color. Note: Preserves gray levels and is useful for * coloring monochrome images or tinting color images. Creates the inverse * effect of the luminosity blend mode. */ COLOR = 1668246642, /** * Darkens the base color to reflect the blend color. Note: Blending with white * produces no change. */ COLOR_BURN = 2020625768, /** * Brightens the base color to reflect the blend color. Note: Blending with * pure black produces no change. */ COLOR_DODGE = 2020625767, /** * Selects the darker of the base or blend colors as the resulting color; * replaces areas lighter than the blend color but does not change areas darker * than the blend color. */ DARKEN = 2020625769, /** * Subtracts either the blend color from the base color or vice versa, * depending on which has the greater brightness value. Note: Blending with * white inverts the base color values; blending with black produces no change. */ DIFFERENCE = 2020625771, /** * Creates an effect similar to--but lower in contrast than--the difference * blend mode. Note: Blending with white inverts the base color values; * blending with black produces no change */ EXCLUSION = 2020625772, /** * For blend colors lighter than 50% gray, lightens the artwork as if it were * screened; for blend colors darker than 50% gray, darkens the artwork as if * it were multiplied. Note: Painting with pure black or white results in pure * black or white. */ HARD_LIGHT = 2020625766, /** * Creates a color with the luminance and saturation of the base color and the * hue of the blend color. */ HUE = 2020625773, /** * Selects the lighter of the base or blend colors as the resulting color; * replaces areas darker than the blend color but does not change areas lighter * than the blend color */ LIGHTEN = 2020625770, /** * Creates a color with the hue and saturation of the base color and the * luminance of the blend color. Note: Creates the inverse effect of the color * blend mode. */ LUMINOSITY = 2020625776, /** * Multiplies the base color by the blend color, resulting in a darker color. * Note: Multiplying with black produces black; multiplying with white leaves * the color unchanged. */ MULTIPLY = 2020625762, /** * Colors the object with the blend color, without interaction with the base * color. */ NORMAL = 1852797549, /** * Multiplies or screens the colors, depending on the base color; patterns or * colors overlay the existing artwork, preserving base color highlights and * shadows while mixing in the blend color to reflect the lightness or darkness * of the original color. */ OVERLAY = 2020625764, /** * Creates a color with the luminance and hue of the base color and the * saturation of the blend color. Note: Does not change areas with no * saturation (0% gray). */ SATURATION = 1380545377, /** * Multiplies the inverse of the blend and base colors, resulting in a lighter * color. Note: Screening with white produces white; screening with black * leaves the color unchanged. */ SCREEN = 2020625763, /** * For blend colors lighter than 50% gray, lightens the artwork as if it were * dodged; for blend colors darker than 50% gray, darkens the artwork as if it * were burned. Note: Painting with pure black or white produces a distinctly * darker or lighter area, but does not result in pure black or white. */ SOFT_LIGHT = 2020625765, } /** * Basic object blending settings. */ declare class BlendingSetting extends Preference { /** * The blending mode for controlling how the base color interacts with the * color of the BlendingSetting. */ blendMode: BlendMode; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * If true, blending is applied only to the group. If false, blending includes * all objects beneath the group. */ isolateBlending: boolean; /** * If true, the BlendingSetting is a knockout group. */ knockoutGroup: boolean; /** * The fill opacity of the BlendingSetting (as a percentage). (Range: 0 to 100) * @remarks Range: 0 to 100 */ opacity: number; /** * The parent of the BlendingSetting (a TransparencySetting, * StrokeTransparencySetting, FillTransparencySetting or * ContentTransparencySetting). */ readonly parent: FillTransparencySetting | StrokeTransparencySetting | ContentTransparencySetting | TransparencySetting; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): BlendingSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the BlendingSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Transparency blending space options. */ declare enum BlendingSpace { /** * Uses the CMYK profile. */ CMYK = 1129142603, /** * Defaults to the current color profile. */ DEFAULT_VALUE = 1147563124, /** * Uses the RGB color profile. */ RGB = 1666336578, } /** * A book. */ declare class Book { /** * If true, automatically converts the book content object during repagination * and synchronization. */ automaticDocumentConversion: boolean; /** * If true, automatically updates page numbers when pages in book content files * are added, deleted, or rearranged. */ automaticPagination: boolean; /** * A collection of book content objects. */ readonly bookContents: BookContents; /** * EPub export preference settings. */ readonly epubExportPreferences: EPubExportPreference; /** * EPub fixed layout export preference settings. */ readonly epubFixedLayoutExportPreferences: EPubFixedLayoutExportPreference; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The path to the folder containing the book. */ readonly filePath: Folder; /** * The full path to the Book, including the name of the Book. */ readonly fullName: File; /** * The index of the Book within its containing object. */ readonly index: number; /** * If true, inserts a blank page as necessary to fill in page number gaps * caused by the odd or even specification set in the repagination option. */ insertBlankPage: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * If true, merges identically named layers when exporting to PDF. */ mergeIdenticalLayers: boolean; /** * If true, the Book has been modified since it was last saved. */ readonly modified: boolean; /** * The name of the Book. */ readonly name: string; /** * The parent of the Book (a Application). */ readonly parent: Application; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * Preflight book option settings. */ readonly preflightBookOptions: PreflightBookOption; /** * Print preference settings. */ readonly printPreferences: PrintPreference; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Page numbering options for book content objects within the book. */ repaginationOption: RepaginateOption; /** * If true, the Book has been saved since it was created. */ readonly saved: boolean; /** * How to match styles with same name while synchronizing a book. */ smartMatchStyleGroups: SmartMatchOptions; /** * Current style source document. Can return: Document or BookContent. */ styleSourceDocument: Document | BookContent; /** * If true, synchronize bullets and numbering. */ synchronizeBulletNumberingList: boolean; /** * If true, synchronize cell styles. */ synchronizeCellStyle: boolean; /** * If true, synchronize character styles. */ synchronizeCharacterStyle: boolean; /** * If true, synchronize conditional text. */ synchronizeConditionalText: boolean; /** * If true, synchronize cross reference formats */ synchronizeCrossReferenceFormat: boolean; /** * If true, synchronize master pages. */ synchronizeMasterPage: boolean; /** * If true, synchronize object styles. */ synchronizeObjectStyle: boolean; /** * If true, synchronize paragraph styles. */ synchronizeParagraphStyle: boolean; /** * If true, synchronize swatches. */ synchronizeSwatch: boolean; /** * If true, synchronize table of content styles. */ synchronizeTableOfContentStyle: boolean; /** * If true, synchronize table styles. */ synchronizeTableStyle: boolean; /** * If true, synchronize text variables. */ synchronizeTextVariable: boolean; /** * If true, synchronize trap styles. */ synchronizeTrapStyle: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Close the Book * @param saving Whether to save changes before closing the Book (Optional) * @param savingIn The file in which to save the Book (Optional) * @param versionComments The comment for this version (Optional) * @param forceSave Forcibly save a version (Optional) */ close(saving?: SaveOptions, savingIn?: File, versionComments?: string, forceSave?: boolean): void; /** * Exports the book to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The file to which to export the book. (Optional) * @param showingOptions Used to specify if the PDF Export Options Dialog needs to be shown or not (Optional) * @param using Used to specify the presets for the export which can be the object of the preset type, enumeration for existing presets or user defined presets, or a string naming the preset to be used, but in case Showing Options is true, the preset specified in the Export Dialog will over ride this parameter (Optional) * @param whichDocuments Used to specify a list of book content references, from the current book, where the list may contain duplicate entries and if the list is not specified then the entire book contents shall be exported (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to?: File, showingOptions?: boolean, using?: PDFExportPreset, whichDocuments?: BookContent[], versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Book[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Packages the document. * @param to The folder, alias, or path in which to place the packaged files. * @param copyingFonts If true, copies fonts used in the document to the package folder. * @param copyingLinkedGraphics If true, copies linked graphics files to the package folder. * @param copyingProfiles If true, copies color profiles to the package folder. * @param updatingGraphics If true, updates graphics links to the package folder. * @param includingHiddenLayers If true, copies fonts and links from hidden layers to the package. * @param ignorePreflightErrors If true, ignores preflight errors and proceeds with the packaging. If false, cancels the packaging when errors exist. * @param creatingReport If true, creates a package report that includes printing instructions, print settings, lists of fonts, links and required inks, and other information. * @param includeIdml If true, generates and includes IDML in the package folder. (Optional) * @param includePdf If true, generates and includes PDF in the package folder. (Optional) * @param pdfStyle If specified and PDF is to be included, use this style for PDF export if it is valid, otherwise use the last used PDF preset. (Optional) * @param useDocumentHyphenationExceptionsOnly If this option is selected, InDesign flags this document so that it does not reflow when someone else opens or edits it on a computer that has different hyphenation and dictionary settings. (Optional) * @param versionComments The comments for the version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ packageForPrint(to: File, copyingFonts: boolean, copyingLinkedGraphics: boolean, copyingProfiles: boolean, updatingGraphics: boolean, includingHiddenLayers: boolean, ignorePreflightErrors: boolean, creatingReport: boolean, includeIdml?: boolean, includePdf?: boolean, pdfStyle?: string, useDocumentHyphenationExceptionsOnly?: boolean, versionComments?: string, forceSave?: boolean): boolean; /** * Preflight a book and optionally save the resulting report. * @param to The preflight report to save to. (Optional) * @param autoOpen If true, automatically open the report after creation. (Optional) */ preflight(to?: File, autoOpen?: boolean): void; /** * Prints the Book(s). * @param printDialog Whether to invoke the print dialog (Optional) * @param using Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional) */ print(printDialog?: boolean, using?: PrinterPresetTypes | PrinterPreset): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Repaginates the book. */ repaginate(): void; /** * Saves the book. * @param to The file path. Note: Required only if the book has not been previously saved. If the book has previously been saved, specifying a path saves a copy and closes the original book. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ save(to?: File, versionComments?: string, forceSave?: boolean): void; /** * Synchronizes the entire book to the style source document. */ synchronize(): void; /** * Generates a string which, if executed, will return the Book. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Updates the cross references in the entire book. */ updateAllCrossReferences(): void; /** * Update all numbers (e.g. Page numbers, chapter numbers and paragraph * numbers) throughout the book. */ updateAllNumbers(): void; /** * Updates chapter numbers and paragraph numbers throughout the book. */ updateChapterAndParagraphNumbers(): void; } /** * A document added to a book. */ declare class BookContent { /** * The date and time the BookContent was created. */ readonly date: Date; /** * The page range of the book content object within the book. */ readonly documentPageRange: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The full path to the file. */ readonly filePath: File; /** * The full path to the BookContent, including the name of the BookContent. */ readonly fullName: File; /** * The unique ID of the BookContent. */ readonly id: number; /** * The index of the BookContent within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the BookContent. */ readonly name: string; /** * The parent of the BookContent (a Book). */ readonly parent: Book; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The size of the BookContent file. */ readonly size: number; /** * The status of the book content object file. */ readonly status: BookContentStatus; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): BookContent[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Moves the book content object. * @param to The location relative to the reference object or within the book. (Optional) * @param reference The reference object. Note: Required when the to parameter specifies before or after. (Optional) */ move(to?: LocationOptions, reference?: BookContent): BookContent; /** * Preflight a book content object and optionally save the resulting report. * @param to The preflight report to save to. (Optional) * @param autoOpen If true, automatically open the report after creation. (Optional) */ preflight(to?: File, autoOpen?: boolean): void; /** * Deletes the BookContent. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Replaces a book content object with a new file. Note: If the new file * replaces the current style source document, the new file becomes the style * source document. * @param using The full path name of the new book content object. */ replace(using: File): BookContent; /** * Matches the formatting of the book content object to the style source * document. */ synchronize(): void; /** * Generates a string which, if executed, will return the BookContent. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Book content file status options. */ declare enum BookContentStatus { /** * The book content object is being used by someone else and is therefore * locked. */ DOCUMENT_IN_USE = 1148150601, /** * The book content object is open. */ DOCUMENT_IS_OPEN = 1148150607, /** * The book content object has been modified after repagination. */ DOCUMENT_OUT_OF_DATE = 1148150596, /** * The book content object is missing because it has been moved, renamed, or * deleted. */ MISSING_DOCUMENT = 1148150605, /** * The book content object is not open and is unchanged. */ NORMAL = 1852797549, } /** * A collection of book content objects. */ declare class BookContents { /** Returns the BookContent with the specified index or name. */ [index: number]: BookContent; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new book content object. * @param fullName The full path name of the new book content object. * @param at The location of the book content object within the book. (Optional) * @param withProperties Initial values for properties of the new BookContent (Optional) */ add(fullName: File, at?: number, withProperties?: Object): BookContent; /** * Returns any BookContent in the collection. */ anyItem(): BookContent; /** * Displays the number of elements in the BookContent. */ count(): number; /** * Returns every BookContent in the collection. */ everyItem(): BookContent; /** * Returns the first BookContent in the collection. */ firstItem(): BookContent; /** * Returns the BookContent with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): BookContent; /** * Returns the BookContent with the specified ID. * @param id The ID. */ itemByID(id: number): BookContent; /** * Returns the BookContent with the specified name. * @param name The name. */ itemByName(name: string): BookContent; /** * Returns the BookContents within the specified range. * @param from The BookContent, index, or name at the beginning of the range. Can accept: BookContent, Long Integer or String. * @param to The BookContent, index, or name at the end of the range. Can accept: BookContent, Long Integer or String. */ itemByRange(from: BookContent | number | string, to: BookContent | number | string): BookContent[]; /** * Returns the last BookContent in the collection. */ lastItem(): BookContent; /** * Returns the middle BookContent in the collection. */ middleItem(): BookContent; /** * Returns the BookContent whose index follows the specified BookContent in the * collection. * @param obj The BookContent whose index comes before the desired BookContent. */ nextItem(obj: BookContent): BookContent; /** * Returns the BookContent with the index previous to the specified index. * @param obj The index of the BookContent that follows the desired BookContent. */ previousItem(obj: BookContent): BookContent; /** * Generates a string which, if executed, will return the BookContent. */ toSource(): string; } /** * Booklet type options. */ declare enum BookletTypeOptions { /** * Four up consecutive imposition. */ FOUR_UP_CONSECUTIVE = 1110721363, /** * Three up consecutive imposition. */ THREE_UP_CONSECUTIVE = 1110655827, /** * Two up consecutive imposition. */ TWO_UP_CONSECUTIVE = 1110590291, /** * Two up perfect bound imposition. */ TWO_UP_PERFECT_BOUND = 1110593602, /** * Two up saddle stitch imposition. */ TWO_UP_SADDLE_STITCH = 1110594387, } /** * A bookmark. */ declare class Bookmark { /** * A collection of bookmarks. */ readonly bookmarks: Bookmarks; /** * The destination that the hyperlink points to. Can return: * HyperlinkTextDestination, HyperlinkPageDestination, * HyperlinkExternalPageDestination or Page. */ readonly destination: HyperlinkExternalPageDestination | HyperlinkPageDestination | HyperlinkTextDestination | Page; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the Bookmark. */ readonly id: number; /** * The indent level of the bookmark. */ readonly indent: number; /** * The index of the Bookmark within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the Bookmark. */ name: string; /** * The parent of the Bookmark (a Document or Bookmark). */ readonly parent: Bookmark | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Bookmark[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Moves the bookmark to the specified location. * @param to The bookmark location relative to the reference object or within the containing object. (Optional) * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Bookmark, Document or Bookmark. (Optional) */ move(to?: LocationOptions, reference?: Bookmark | Document): Bookmark; /** * Deletes the Bookmark. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Go to the bookmark. */ showBookmark(): void; /** * Generates a string which, if executed, will return the Bookmark. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of bookmarks. */ declare class Bookmarks { /** Returns the Bookmark with the specified index or name. */ [index: number]: Bookmark; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new bookmark. * @param destination The bookmark destination. Can accept: HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination or Page. * @param withProperties Initial values for properties of the new Bookmark (Optional) */ add(destination: HyperlinkExternalPageDestination | HyperlinkPageDestination | HyperlinkTextDestination | Page, withProperties?: Object): Bookmark; /** * Returns any Bookmark in the collection. */ anyItem(): Bookmark; /** * Displays the number of elements in the Bookmark. */ count(): number; /** * Returns every Bookmark in the collection. */ everyItem(): Bookmark; /** * Returns the first Bookmark in the collection. */ firstItem(): Bookmark; /** * Returns the Bookmark with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Bookmark; /** * Returns the Bookmark with the specified ID. * @param id The ID. */ itemByID(id: number): Bookmark; /** * Returns the Bookmark with the specified name. * @param name The name. */ itemByName(name: string): Bookmark; /** * Returns the Bookmarks within the specified range. * @param from The Bookmark, index, or name at the beginning of the range. Can accept: Bookmark, Long Integer or String. * @param to The Bookmark, index, or name at the end of the range. Can accept: Bookmark, Long Integer or String. */ itemByRange(from: Bookmark | number | string, to: Bookmark | number | string): Bookmark[]; /** * Returns the last Bookmark in the collection. */ lastItem(): Bookmark; /** * Returns the middle Bookmark in the collection. */ middleItem(): Bookmark; /** * Returns the Bookmark whose index follows the specified Bookmark in the * collection. * @param obj The Bookmark whose index comes before the desired Bookmark. */ nextItem(obj: Bookmark): Bookmark; /** * Returns the Bookmark with the index previous to the specified index. * @param obj The index of the Bookmark that follows the desired Bookmark. */ previousItem(obj: Bookmark): Bookmark; /** * Generates a string which, if executed, will return the Bookmark. */ toSource(): string; } /** * A collection of books. */ declare class Books { /** Returns the Book with the specified index or name. */ [index: number]: Book; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new book. * @param fullName The full path name of the new book file, including the book file extension '.indb'. * @param withProperties Initial values for properties of the new Book (Optional) */ add(fullName: File, withProperties?: Object): Book; /** * Returns any Book in the collection. */ anyItem(): Book; /** * Displays the number of elements in the Book. */ count(): number; /** * Returns every Book in the collection. */ everyItem(): Book; /** * Returns the first Book in the collection. */ firstItem(): Book; /** * Returns the Book with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Book; /** * Returns the Book with the specified name. * @param name The name. */ itemByName(name: string): Book; /** * Returns the Books within the specified range. * @param from The Book, index, or name at the beginning of the range. Can accept: Book, Long Integer or String. * @param to The Book, index, or name at the end of the range. Can accept: Book, Long Integer or String. */ itemByRange(from: Book | number | string, to: Book | number | string): Book[]; /** * Returns the last Book in the collection. */ lastItem(): Book; /** * Returns the middle Book in the collection. */ middleItem(): Book; /** * Returns the Book whose index follows the specified Book in the collection. * @param obj The Book whose index comes before the desired Book. */ nextItem(obj: Book): Book; /** * Returns the Book with the index previous to the specified index. * @param obj The index of the Book that follows the desired Book. */ previousItem(obj: Book): Book; /** * Generates a string which, if executed, will return the Book. */ toSource(): string; } /** * A bordered panel on a dialog that can contain any type and number of * controls. */ declare class BorderPanel extends Widget { /** * A collection of angle comboboxes. */ readonly angleComboboxes: AngleComboboxes; /** * A collection of angle editboxes. */ readonly angleEditboxes: AngleEditboxes; /** * A collection of border panels. */ readonly borderPanels: BorderPanels; /** * A collection of checkbox controls. */ readonly checkboxControls: CheckboxControls; /** * A collection of dialog columns. */ readonly dialogColumns: DialogColumns; /** * A collection of dropdowns. */ readonly dropdowns: Dropdowns; /** * A collection of enabling groups. */ readonly enablingGroups: EnablingGroups; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the BorderPanel. */ readonly id: number; /** * The index of the BorderPanel within its containing object. */ readonly index: number; /** * A collection of integer comboboxes. */ readonly integerComboboxes: IntegerComboboxes; /** * A collection of integer editboxes. */ readonly integerEditboxes: IntegerEditboxes; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A collection of measurement comboboxes. */ readonly measurementComboboxes: MeasurementComboboxes; /** * A collection of measurement editboxes. */ readonly measurementEditboxes: MeasurementEditboxes; /** * The width of the control. For an editbox or combobox, specifies the minimum * width of the box. */ minWidth: number; /** * The parent of the BorderPanel (a DialogColumn, DialogRow, EnablingGroup or * BorderPanel). */ readonly parent: DialogRow | EnablingGroup | BorderPanel | DialogColumn; /** * A collection of percent comboboxes. */ readonly percentComboboxes: PercentComboboxes; /** * A collection of percent editboxes. */ readonly percentEditboxes: PercentEditboxes; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of radiobutton groups. */ readonly radiobuttonGroups: RadiobuttonGroups; /** * A collection of real number comboboxes. */ readonly realComboboxes: RealComboboxes; /** * A collection of real number editboxes. */ readonly realEditboxes: RealEditboxes; /** * A collection of static text objects. */ readonly staticTexts: StaticTexts; /** * A collection of text editboxes. */ readonly textEditboxes: TextEditboxes; /** * A collection of widgets. */ readonly widgets: Widgets; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): BorderPanel[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the BorderPanel. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of border panels. */ declare class BorderPanels { /** Returns the BorderPanel with the specified index or name. */ [index: number]: BorderPanel; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new BorderPanel. * @param withProperties Initial values for properties of the new BorderPanel (Optional) */ add(withProperties?: Object): BorderPanel; /** * Returns any BorderPanel in the collection. */ anyItem(): BorderPanel; /** * Displays the number of elements in the BorderPanel. */ count(): number; /** * Returns every BorderPanel in the collection. */ everyItem(): BorderPanel; /** * Returns the first BorderPanel in the collection. */ firstItem(): BorderPanel; /** * Returns the BorderPanel with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): BorderPanel; /** * Returns the BorderPanel with the specified ID. * @param id The ID. */ itemByID(id: number): BorderPanel; /** * Returns the BorderPanels within the specified range. * @param from The BorderPanel, index, or name at the beginning of the range. Can accept: BorderPanel, Long Integer or String. * @param to The BorderPanel, index, or name at the end of the range. Can accept: BorderPanel, Long Integer or String. */ itemByRange(from: BorderPanel | number | string, to: BorderPanel | number | string): BorderPanel[]; /** * Returns the last BorderPanel in the collection. */ lastItem(): BorderPanel; /** * Returns the middle BorderPanel in the collection. */ middleItem(): BorderPanel; /** * Returns the BorderPanel whose index follows the specified BorderPanel in the * collection. * @param obj The BorderPanel whose index comes before the desired BorderPanel. */ nextItem(obj: BorderPanel): BorderPanel; /** * Returns the BorderPanel with the index previous to the specified index. * @param obj The index of the BorderPanel that follows the desired BorderPanel. */ previousItem(obj: BorderPanel): BorderPanel; /** * Generates a string which, if executed, will return the BorderPanel. */ toSource(): string; } /** * Bounding box limits. */ declare enum BoundingBoxLimits { /** * Geometric path bounds */ GEOMETRIC_PATH_BOUNDS = 1768844080, /** * Outer stroke bounds */ OUTER_STROKE_BOUNDS = 1768844081, } /** * A cross reference building block object. */ declare class BuildingBlock { /** * Character style to be applied to the building block. */ appliedCharacterStyle: CharacterStyle; /** * Delimiter character for paragraph text and full paragraph building blocks. * It is ignored for other types of building blocks. */ appliedDelimiter: string; /** * Type of the building block. */ blockType: BuildingBlockTypes; /** * Building block custom text. Currently this is only useful in custom string * building block. It is ignored for other types of building blocks. */ customText: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, the source generated for the building block includes the delimiter. * It is ignored if no delimiter is specified on the building block. */ includeDelimiter: boolean; /** * The index of the BuildingBlock within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the BuildingBlock (a CrossReferenceFormat). */ readonly parent: CrossReferenceFormat; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): BuildingBlock[]; /** * Deletes the BuildingBlock. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the BuildingBlock. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Cross reference building block types. */ declare enum BuildingBlockTypes { /** * Bookmark name building block type. */ BOOKMARK_NAME_BUILDING_BLOCK = 1650614894, /** * Chapter number building block type. */ CHAPTER_NUMBER_BUILDING_BLOCK = 1650615150, /** * Custom string building block type. */ CUSTOM_STRING_BUILDING_BLOCK = 1650615155, /** * File name building block type. */ FILE_NAME_BUILDING_BLOCK = 1650615918, /** * Full paragraph building block type. */ FULL_PARAGRAPH_BUILDING_BLOCK = 1650615920, /** * Page number building block type. */ PAGE_NUMBER_BUILDING_BLOCK = 1650618478, /** * Paragraph number building block type. */ PARAGRAPH_NUMBER_BUILDING_BLOCK = 1651533678, /** * Paragraph text building block type. */ PARAGRAPH_TEXT_BUILDING_BLOCK = 1650618484, } /** * A collection of cross reference building blocks. */ declare class BuildingBlocks { /** Returns the BuildingBlock with the specified index or name. */ [index: number]: BuildingBlock; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new cross reference building block. * @param blockType Type of the building block. * @param appliedCharacterStyle Character style to be applied to the building block. (Optional) * @param customText Building block custom text. Currently this is only useful in custom string building block. It is ignored for other types of building blocks. (Optional) * @param withProperties Initial values for properties of the new BuildingBlock (Optional) */ add(blockType: BuildingBlockTypes, appliedCharacterStyle?: CharacterStyle, customText?: string, withProperties?: Object): BuildingBlock; /** * Returns any BuildingBlock in the collection. */ anyItem(): BuildingBlock; /** * Displays the number of elements in the BuildingBlock. */ count(): number; /** * Returns every BuildingBlock in the collection. */ everyItem(): BuildingBlock; /** * Returns the first BuildingBlock in the collection. */ firstItem(): BuildingBlock; /** * Returns the BuildingBlock with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): BuildingBlock; /** * Returns the BuildingBlocks within the specified range. * @param from The BuildingBlock, index, or name at the beginning of the range. Can accept: BuildingBlock, Long Integer or String. * @param to The BuildingBlock, index, or name at the end of the range. Can accept: BuildingBlock, Long Integer or String. */ itemByRange(from: BuildingBlock | number | string, to: BuildingBlock | number | string): BuildingBlock[]; /** * Returns the last BuildingBlock in the collection. */ lastItem(): BuildingBlock; /** * Returns the middle BuildingBlock in the collection. */ middleItem(): BuildingBlock; /** * Returns the BuildingBlock whose index follows the specified BuildingBlock in * the collection. * @param obj The BuildingBlock whose index comes before the desired BuildingBlock. */ nextItem(obj: BuildingBlock): BuildingBlock; /** * Returns the BuildingBlock with the index previous to the specified index. * @param obj The index of the BuildingBlock that follows the desired BuildingBlock. */ previousItem(obj: BuildingBlock): BuildingBlock; /** * Generates a string which, if executed, will return the BuildingBlock. */ toSource(): string; } /** * Bullet character. */ declare class Bullet extends Preference { /** * Font of the bullet character. Can return: Font, String or AutoEnum * enumerator. */ bulletsFont: Font | string | AutoEnum; /** * Font style of the bullet character. Can return: String, NothingEnum * enumerator or AutoEnum enumerator. */ bulletsFontStyle: NothingEnum | string | AutoEnum; /** * The type of bullet character. */ characterType: BulletCharacterType; /** * The bullet character as a unicode ID or a glyph ID. */ characterValue: number; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the Bullet (a TextDefault, ParagraphStyle, Text, * InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, * Character, Story, XmlStory, FindTextPreference, ChangeTextPreference, * FindGrepPreference, ChangeGrepPreference, FindTransliteratePreference or * ChangeTransliteratePreference). */ readonly parent: ChangeGrepPreference | ChangeTextPreference | Character | FindGrepPreference | FindTextPreference | FindTransliteratePreference | InsertionPoint | Line | Paragraph | ParagraphStyle | Story | Text | TextColumn | TextStyleRange | Word | XmlStory | ChangeTransliteratePreference | TextDefault; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Bullet[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Bullet. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Bullet character type. */ declare enum BulletCharacterType { /** * Glyph with font. */ GLYPH_WITH_FONT = 1111713638, /** * Unicode only. */ UNICODE_ONLY = 1111717231, /** * Unicode with font. */ UNICODE_WITH_FONT = 1111717222, } /** * Options for export unorder list. */ declare enum BulletListExportOption { /** * convert to text. */ AS_TEXT = 1700946804, /** * map to html unordered list. */ UNORDERED_LIST = 1700949333, } /** * A button. */ declare class Button extends FormField { /** * Indicates whether the Button has been flipped independently of its parent * object and, if yes, the direction in which the Button was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the Button relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the Button relative to its containing object. (Range: * -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the Button relative to its containing object. (Range: * -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the Button relative to its containing object. */ absoluteVerticalScale: number; /** * The index of the active state in the object's states collection. */ activeStateIndex: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the Button. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the Button. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * Anchored object settings. */ readonly anchoredObjectSettings: AnchoredObjectSetting; /** * A collection of animation behaviors. */ readonly animationBehaviors: AnimationBehaviors; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the Button. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the Button. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the Button. */ readonly associatedXMLElement: XMLItem; /** * A collection of behavior objects. */ readonly behaviors: Behaviors; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * A collection of clear form behavior objects. */ readonly clearFormBehaviors: ClearFormBehaviors; /** * Transparency settings for the content of the Button. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The description of the Button. */ description: string; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the Button. */ endJoin: EndJoin; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * A collection of EPS files. */ readonly epss: EPSs; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * Button. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the Button's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the Button. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the Button excluding the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * A collection of goto anchor behavior objects. */ readonly gotoAnchorBehaviors: GotoAnchorBehaviors; /** * A collection of goto first page behavior objects. */ readonly gotoFirstPageBehaviors: GotoFirstPageBehaviors; /** * A collection of goto last page behavior objects. */ readonly gotoLastPageBehaviors: GotoLastPageBehaviors; /** * A collection of goto next page behavior objects. */ readonly gotoNextPageBehaviors: GotoNextPageBehaviors; /** * A collection of goto next state behaviors. */ readonly gotoNextStateBehaviors: GotoNextStateBehaviors; /** * A collection of goto next view behavior objects. */ readonly gotoNextViewBehaviors: GotoNextViewBehaviors; /** * A collection of go to page behavior objects. */ readonly gotoPageBehaviors: GotoPageBehaviors; /** * A collection of goto previous page behavior objects. */ readonly gotoPreviousPageBehaviors: GotoPreviousPageBehaviors; /** * A collection of goto previous state behaviors. */ readonly gotoPreviousStateBehaviors: GotoPreviousStateBehaviors; /** * A collection of goto previous view behavior objects. */ readonly gotoPreviousViewBehaviors: GotoPreviousViewBehaviors; /** * A collection of goto state behaviors. */ readonly gotoStateBehaviors: GotoStateBehaviors; /** * A collection of goto URL behavior objects. */ readonly gotoURLBehaviors: GotoURLBehaviors; /** * The angle of a linear gradient applied to the fill of the Button. (Range: * -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the Button. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the Button, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the Button. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the Button. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the Button, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * A collection of groups. */ readonly groups: Groups; /** * If true, the form field/push button is hidden until triggered in the * exported PDF. */ hiddenUntilTriggered: boolean; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the Button. */ horizontalScale: number; /** * The unique ID of the Button. */ readonly id: number; /** * A collection of bitmap images in any bitmap file format (including TIFF, * JPEG, or GIF). */ readonly images: Images; /** * The index of the Button within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the Button is on. */ itemLayer: Layer; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the Button. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the Button is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * A collection of movie behavior objects. */ readonly movieBehaviors: MovieBehaviors; /** * The name of the Button. */ name: string; /** * If true, the Button does not print. */ nonprinting: boolean; /** * A collection of open file behavior objects. */ readonly openFileBehaviors: OpenFileBehaviors; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the Button's fill color overprints any underlying objects. If * false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the Button's stroke color overprints any underlying objects. If * false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the Button (a Snippet, PlaceGun, FlexObject, Spread, * MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group or * Character). */ readonly parent: FlexObject | GraphicLine | Group | MasterSpread | Oval | PlaceGun | Polygon | Rectangle | SplineItem | Spread | Character | Snippet; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of paths. */ readonly paths: Paths; /** * A collection of PDF files. */ readonly pdfs: PDFs; /** * A collection of PICT graphics. */ readonly picts: PICTs; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A collection of print form behavior objects. */ readonly printFormBehaviors: PrintFormBehaviors; /** * If true, the form field/push button is printable in the exported PDF. */ printableInPdf: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the Button. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the Button. (Range: -360 to 360) */ shearAngle: number; /** * A collection of show/hide fields behavior objects. */ readonly showHideFieldsBehaviors: ShowHideFieldsBehaviors; /** * A collection of sound behavior objects. */ readonly soundBehaviors: SoundBehaviors; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * A collection of states. */ readonly states: States; /** * The stroke alignment applied to the Button. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the Button. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the Button. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the Button's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of submit form behavior objects. */ readonly submitFormBehaviors: SubmitFormBehaviors; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the Button. */ verticalScale: number; /** * A collection of view zoom behavior objects. */ readonly viewZoomBehaviors: ViewZoomBehaviors; /** * If true, the Button is visible. */ visible: boolean; /** * The bounds of the Button including the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * A collection of WMF graphics. */ readonly wmfs: WMFs; /** * Dispatched after a Button is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a Button is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the Button's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the Button that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Brings the Button forward one level in its layer. */ bringForward(): void; /** * Brings the Button to the front of its layer or in front of a particular * item. * @param reference The reference object to bring the object in front of (must have same parent) (Optional) */ bringToFront(reference?: PageItem): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the Button. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the Button to a different shape. * @param given The Button's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Converts the button object to the page item currently in the active state. * Page items from other states will be lost. */ convertToObject(): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Button. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Button. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Button. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Button. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Button. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the Button at the specified location or offset. * @param to The location of the new Button, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new Button from the original Button's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the Button. * @param given The axis around which to flip the Button. * @param around The point around which to flip the Button. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Button[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the Button to a new location. Note: Either the 'to' or 'by' parameter * is required; if both parameters are defined, only the to value is used. * @param to The new location of the Button,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the Button relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the Button. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the Button in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Sends the Button back one level in its layer. */ sendBackward(): void; /** * Sends the Button to the back of its layer or behind a particular item (must * have same parent). * @param reference The reference object to send the object behind (Optional) */ sendToBack(reference?: PageItem): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new Button (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the Button. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the Button using the last transformation performed on any object. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformAgain(): string[]; /** * Transforms the Button using the last transformation performed on any Button. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformAgainIndividually(): string[]; /** * Transforms the Button using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the Button using the last sequence of transformations performed * on any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * Button preferences. */ declare class ButtonPreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the ButtonPreference. */ name: string; /** * The parent of the ButtonPreference (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ButtonPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ButtonPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of buttons. */ declare class Buttons { /** Returns the Button with the specified index or name. */ [index: number]: Button; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new Button * @param layer The layer on which to create the Button. (Optional) * @param at The location at which to insert the Button relative to the reference object or within the container object. (Optional) * @param reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) * @param withProperties Initial values for properties of the new Button (Optional) */ add(layer?: Layer, at?: LocationOptions, reference?: Document | Layer | MasterSpread | Page | Spread | PageItem, withProperties?: Object): Button; /** * Returns any Button in the collection. */ anyItem(): Button; /** * Displays the number of elements in the Button. */ count(): number; /** * Returns every Button in the collection. */ everyItem(): Button; /** * Returns the first Button in the collection. */ firstItem(): Button; /** * Returns the Button with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Button; /** * Returns the Button with the specified ID. * @param id The ID. */ itemByID(id: number): Button; /** * Returns the Button with the specified name. * @param name The name. */ itemByName(name: string): Button; /** * Returns the Buttons within the specified range. * @param from The Button, index, or name at the beginning of the range. Can accept: Button, Long Integer or String. * @param to The Button, index, or name at the end of the range. Can accept: Button, Long Integer or String. */ itemByRange(from: Button | number | string, to: Button | number | string): Button[]; /** * Returns the last Button in the collection. */ lastItem(): Button; /** * Returns the middle Button in the collection. */ middleItem(): Button; /** * Returns the Button whose index follows the specified Button in the * collection. * @param obj The Button whose index comes before the desired Button. */ nextItem(obj: Button): Button; /** * Returns the Button with the index previous to the specified index. * @param obj The index of the Button that follows the desired Button. */ previousItem(obj: Button): Button; /** * Generates a string which, if executed, will return the Button. */ toSource(): string; } /** * Capitalization options. */ declare enum Capitalization { /** * Use all uppercase letters. */ ALL_CAPS = 1634493296, /** * Use OpenType small caps. */ CAP_TO_SMALL_CAP = 1664250723, /** * Use to change to Lower case. */ LOWER_CASE = 1819244387, /** * Do not change the capitalization of the text. */ NORMAL = 1852797549, /** * Use small caps for lowercase letters. */ SMALL_CAPS = 1936548720, } /** * The preferences for a caption metadata variable. */ declare class CaptionMetadataVariablePreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * Name of the metadata provider. */ metadataProviderName: string; /** * The parent of the CaptionMetadataVariablePreference (a TextVariable). */ readonly parent: TextVariable; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The text that follows the value of the variable. (Limit: 128 characters) */ textAfter: string; /** * The text that precedes the value of the variable. (Limit: 128 characters) */ textBefore: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): CaptionMetadataVariablePreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * CaptionMetadataVariablePreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A table cell. */ declare class Cell { /** * Lists all graphics contained by the Cell. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the Cell. */ readonly allPageItems: PageItem[]; /** * The cell style applied to the cell. Can also accept: String. */ appliedCellStyle: CellStyle | string; /** * The XML element associated with the Cell. */ readonly associatedXMLElement: XMLItem; /** * If true, the height of the cell or the cells in the Cell can increase or * decrease automatically to fit cell content. Note: Allows cells to grow or * shrink to the maximum or minimum height, if specified. */ autoGrow: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the bottom edge * border stroke. */ bottomEdgeStrokeColor: Swatch; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * bottom edge border stroke. Note: Not valid when bottom edge stroke type is * solid. */ bottomEdgeStrokeGapColor: Swatch; /** * If true, the gap color of the bottom edge border stroke will overprint. * Note: Not valid when bottom edge stroke type is solid. */ bottomEdgeStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the bottom edge border stroke gap color. * (Range: 0 to 100) Note: Not valid when bottom edge stroke type is solid. * @remarks Range: 0 to 100 */ bottomEdgeStrokeGapTint: number; /** * If true, the bottom edge border stroke will overprint. */ bottomEdgeStrokeOverprint: boolean; /** * The tint (as a percentage) of the bottom edge border stroke. */ bottomEdgeStrokeTint: number; /** * The stroke type of the bottom edge. Can also accept: String. */ bottomEdgeStrokeType: StrokeStyle | string; /** * The stroke weight of the bottom edge border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomEdgeStrokeWeight: number | string; /** * The bottom inset of the cell.The API has been deprecated. Use * TextBottomInset or GraphicBottomInset * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomInset: number | string; /** * A collection of buttons. */ readonly buttons: Buttons; /** * The content type of cell. */ cellType: CellTypeEnum; /** * A collection of table cells. */ readonly cells: Cells; /** * A collection of changes. */ readonly changes: Changes; /** * A collection of characters. */ readonly characters: Characters; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * If true, clips the cell's content to width and height of the cell. The API * has been deprecated. Use ClipContentsToTextCell or * ClipContentsToPageItemCell */ clipContentToCell: boolean; /** * If true, clips the graphic cell's content to width and height of the cell. */ clipContentToGraphicCell: boolean; /** * If true, clips the text cell's content to width and height of the cell. */ clipContentToTextCell: boolean; /** * The number of columns that the object spans. */ readonly columnSpan: number; /** * The column type. */ columnType: ColumnTypes; /** * A collection of table columns. */ readonly columns: Columns; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * The text contents. For rows or columns, when specified as a string, the * sting populates each cell in the row or column; when specified as an array, * the first value in the array populates the left-most cell in the row or the * top-most cell in the column; the next value populates the next cell to the * right (for rows) or the next lowest cell (for columns), and so on. Can * return: PageItem, String, SpecialCharacters enumerator or Array of Strings, * SpecialCharacters enumerators or PageItems. Can also accept: PageItem, * NothingEnum enumerator or Array of Strings, SpecialCharacters enumerators, * NothingEnum enumerators or PageItems. */ contents: (NothingEnum | NothingEnum[] | PageItem | SpecialCharacters | string | string[] | PageItems)[]; /** * If true, draws the diagonal line in front of cell contents. */ diagonalLineInFront: boolean; /** * The diagonal line color, specified as a swatch. */ diagonalLineStrokeColor: Swatch; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * diagonal line stroke. Note: Not valid when diagonal line stroke type is * solid. */ diagonalLineStrokeGapColor: Swatch; /** * If true, the stroke gap of the diagonal line will overprint. Note: Not valid * when diagonal line stroke type is solid. */ diagonalLineStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the diagonal line stroke gap color. Note: Not * valid when diagonal line stroke type is solid. */ diagonalLineStrokeGapTint: number; /** * If true, the diagonal line stroke will overprint. */ diagonalLineStrokeOverprint: boolean; /** * The diagonal line tint (as a percentage). (Range: 0 to 100) * @remarks Range: 0 to 100 */ diagonalLineStrokeTint: number; /** * The stroke type of the diagonal line(s). Can also accept: String. */ diagonalLineStrokeType: StrokeStyle | string; /** * The diagonal line stroke weight. * @remarks Measurement unit — also accepts a string such as "12mm". */ diagonalLineStrokeWeight: number | string; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * A collection of endnotes. */ readonly endnotes: Endnotes; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * object. Can also accept: String. */ fillColor: Swatch | string; /** * The tint (as a percentage) of the fill of the object. */ fillTint: number; /** * The distance between the baseline of the text and the top inset of the cell. */ firstBaselineOffset: FirstBaseline; /** * A collection of footnotes. */ readonly footnotes: Footnotes; /** * A collection of form fields. */ readonly formFields: FormFields; /** * The angle of a linear gradient applied to the fill of the object. (Range: * -180 to 180) */ gradientFillAngle: number; /** * The length (of a linear gradient) or radius (of a radial gradient) applied * to the fill of the object. */ gradientFillLength: number; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the Cell, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The bottom inset of the graphic cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ graphicBottomInset: number | string; /** * The left inset of the graphic cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ graphicLeftInset: number | string; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * The right inset of the graphic cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ graphicRightInset: number | string; /** * The top inset of the graphic cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ graphicTopInset: number | string; /** * A collection of groups. */ readonly groups: Groups; /** * The height of the Cell. For a table or column, specifies the sum of the row * heights. * @remarks Measurement unit — also accepts a string such as "12mm". */ height: number | string; /** * A collection of hidden text objects. */ readonly hiddenTexts: HiddenTexts; /** * The unique ID of the Cell. */ readonly id: number; /** * The index of the Cell within its containing object. */ readonly index: number; /** * The color, specified as a swatch, of the inner column border stroke. */ innerColumnStrokeColor: Swatch; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * inner column border stroke. Note: Not valid when inner column stroke type is * solid. */ innerColumnStrokeGapColor: Swatch; /** * If true, the gap color of the inner column border stroke will overprint. * Note: Not valid when inner column stroke type is solid. */ innerColumnStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the inner column border stroke gap color. * (Range: 0 to 100) Note: Not valid when inner column stroke type is solid. * @remarks Range: 0 to 100 */ innerColumnStrokeGapTint: number; /** * If true, the inner column border stroke will overprint. */ innerColumnStrokeOverprint: boolean; /** * The tint (as a percentage) of the inner column border stroke. (Range: 0 to * 100) * @remarks Range: 0 to 100 */ innerColumnStrokeTint: number; /** * The stroke type of the inner column. Can also accept: String. */ innerColumnStrokeType: StrokeStyle | string; /** * The stroke weight of the inner column border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ innerColumnStrokeWeight: number | string; /** * The color, specified as a swatch, of the inner row border stroke. */ innerRowStrokeColor: Swatch; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * inner row border stroke. Note: Not valid when inner row stroke type is * solid. */ innerRowStrokeGapColor: Swatch; /** * If true, the gap color of the inner row border stroke will overprint. Note: * Not valid when inner row stroke type is solid. */ innerRowStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the inner row border stroke. (Range: 0 to 100) * Note: Not valid when inner row stroke type is solid. * @remarks Range: 0 to 100 */ innerRowStrokeGapTint: number; /** * If true, the inner row border stroke will overprint. */ innerRowStrokeOverprint: boolean; /** * The tint (as a percentage) of the inner row border stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ innerRowStrokeTint: number; /** * The stroke type of the inner row. Can also accept: String. */ innerRowStrokeType: StrokeStyle | string; /** * The stroke weight of the inner row border strokes. * @remarks Measurement unit — also accepts a string such as "12mm". */ innerRowStrokeWeight: number | string; /** * A collection of insertion points. */ readonly insertionPoints: InsertionPoints; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * If true, keeps the row with the next row when the table is split across text * frames or pages. */ keepWithNextRow: boolean; /** * A property that can be set to any string. */ label: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the left edge * border stroke. */ leftEdgeStrokeColor: Swatch; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * left edge border stroke. Note: Not valid when left edge stroke type is * solid. */ leftEdgeStrokeGapColor: Swatch; /** * If true, the gap color of the left edge border stroke will overprint. Note: * Not valid when left edge stroke type is solid. */ leftEdgeStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the left edge border stroke gap color. (Range: * 0 to 100) Note: Not valid when left edge stroke type is solid. * @remarks Range: 0 to 100 */ leftEdgeStrokeGapTint: number; /** * If true, the left edge border stroke will overprint. */ leftEdgeStrokeOverprint: boolean; /** * The tint (as a percentage) of the left edge border stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ leftEdgeStrokeTint: number; /** * The stroke type of the left edge. Can also accept: String. */ leftEdgeStrokeType: StrokeStyle | string; /** * The stroke weight of the left edge border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ leftEdgeStrokeWeight: number | string; /** * The left inset of the cell.The API has been deprecated. Use TextLeftInset or * GraphicLeftInset * @remarks Measurement unit — also accepts a string such as "12mm". */ leftInset: number | string; /** * A collection of lines. */ readonly lines: Lines; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * The maximum height to which cells in the Cell may grow. Note: The maximum * height cannot be exceeded even when auto grow is set to true. Also, the * maximum height can affect redistribution. * @remarks Measurement unit — also accepts a string such as "12mm". */ maximumHeight: number | string; /** * The space between the baseline of the text and the top inset of the frame or * cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ minimumFirstBaselineOffset: number | string; /** * The minimum height of the cells in the Cell. Note: When auto grow is true, * cells can automatically grow larger than this amount when content is added. * Also, the minimum height can affect redistribution. * @remarks Measurement unit — also accepts a string such as "12mm". */ minimumHeight: number | string; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * The name of the Cell. */ readonly name: string; /** * A collection of notes. */ readonly notes: Notes; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the story has overset text. */ readonly overflows: boolean; /** * If true, the fill of the object will overprint. */ overprintFill: boolean; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The maximum space that can be added between paragraphs in a cell. Note: * Valid only when vertical justification is justified. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphSpacingLimit: number | string; /** * A collection of paragraphs. */ readonly paragraphs: Paragraphs; /** * The parent of the Cell (a XMLElement, Cell, Table, Column or Row). */ readonly parent: Cell | Column | Table | Row | XMLElement; /** * The parent column of the cell. */ readonly parentColumn: Column; /** * The parent row of the cell. */ readonly parentRow: Row; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * The color, specified as a swatch, of the right edge border stroke. */ rightEdgeStrokeColor: Swatch; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * right edge border stroke. Note: Not valid when right edge stroke type is * solid. */ rightEdgeStrokeGapColor: Swatch; /** * If true, the gap color of the right edge border stroke will overprint. Note: * Not valid when right edge stroke type is solid. */ rightEdgeStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the right edge border stroke gap color. * (Range: 0 to 100) Note: Not valid when right edge stroke type is solid. * @remarks Range: 0 to 100 */ rightEdgeStrokeGapTint: number; /** * If true, the right edge border stroke will overprint. */ rightEdgeStrokeOverprint: boolean; /** * The tint (as a percentage) of the right edge border stroke. (Range: 0 to * 100) * @remarks Range: 0 to 100 */ rightEdgeStrokeTint: number; /** * The stroke type of the right edge. Can also accept: String. */ rightEdgeStrokeType: StrokeStyle | string; /** * The stroke weight of the right edge border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ rightEdgeStrokeWeight: number | string; /** * The right inset of the cell.The API has been deprecated. Use TextLeftInset * or GraphicRightInset * @remarks Measurement unit — also accepts a string such as "12mm". */ rightInset: number | string; /** * The rotation angle (in degrees) of the cell, specified as one of the * following values: 0, 90, 180, or 270. */ rotationAngle: number; /** * The number of rows that the object spans. */ readonly rowSpan: number; /** * The row type. */ rowType: RowTypes; /** * A collection of table rows. */ readonly rows: Rows; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * Indicates where to start the row. */ startRow: StartParagraph; /** * A collection of tables. */ readonly tables: Tables; /** * The bottom inset of the text cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ textBottomInset: number | string; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text columns. */ readonly textColumns: TextColumns; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * The left inset of the text cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ textLeftInset: number | string; /** * The right inset of the text cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ textRightInset: number | string; /** * A collection of text style ranges. */ readonly textStyleRanges: TextStyleRanges; /** * The top inset of the text cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ textTopInset: number | string; /** * A collection of text variable instances. */ readonly textVariableInstances: TextVariableInstances; /** * A collection of text objects. */ readonly texts: Texts; /** * The swatch (color, gradient, tint, or mixed ink) applied to the top edge * border stroke. */ topEdgeStrokeColor: Swatch; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * top edge border stroke. Note: Not valid when top edge stroke type is solid. */ topEdgeStrokeGapColor: Swatch; /** * If true, the gap color of the top edge border stroke will overprint. Note: * Not valid when top edge stroke type is solid. */ topEdgeStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the top edge border stroke gap color. (Range: * 0 to 100) Note: Not valid when top edge stroke type is solid. * @remarks Range: 0 to 100 */ topEdgeStrokeGapTint: number; /** * If true, the top edge border stroke will overprint. */ topEdgeStrokeOverprint: boolean; /** * The tint (as a percentage) of the top edge border stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ topEdgeStrokeTint: number; /** * The stroke type of the top edge. Can also accept: String. */ topEdgeStrokeType: StrokeStyle | string; /** * The stroke weight of the top edge border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ topEdgeStrokeWeight: number | string; /** * The top inset of the cell. The API has been deprecated. Use TextTopInset or * GraphicTopInset * @remarks Measurement unit — also accepts a string such as "12mm". */ topInset: number | string; /** * If true, draws a diagonal line starting from the top left. */ topLeftDiagonalLine: boolean; /** * If true, draws a diagonal line starting from the top right. */ topRightDiagonalLine: boolean; /** * The vertical alignment of cell. */ verticalJustification: VerticalJustification; /** * The width of the Cell. For a table or row, specifies the sum of the column * widths. * @remarks Measurement unit — also accepts a string such as "12mm". */ width: number | string; /** * A collection of words. */ readonly words: Words; /** * The direction of the text in the cell. */ writingDirection: HorizontalOrVertical; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds glyphs that match the find what value and replaces the glyphs with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value and replaces the text * with the change character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeTransliterate(reverseOrder?: boolean): Text[]; /** * Clear Cell Style Overrides * @param clearingOverridesThroughRootCellStyle If true, clears all overrides, whether or not they are defined in the underlying cell style (Optional) */ clearCellStyleOverrides(clearingOverridesThroughRootCellStyle?: boolean): void; /** * Convert bullets and numbering to text. */ convertBulletsAndNumberingToText(): void; /** * Convert cell type. The new cell type parameter is required. Preserve data is * optional * @param finalCellType Cell Type to which the cell is to be converted * @param flagToPreserveData If true then the data inside the cell is preserved. While converting graphic cell to text cell, page item becomes inline. (Optional) */ convertCellType(finalCellType: CellTypeEnum, flagToPreserveData?: boolean): void; /** * Converts text to outlines. Each line of text becomes a polygon object. When * the converted text is a single letter that has no internal spaces or * detached parts, the polygon contains only a single path. Note: To determine * whether a font allows the creation of outlines, see allow outlines. * @param deleteOriginal If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) */ createOutlines(deleteOriginal?: boolean): PageItem[]; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds glyphs that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findTransliterate(reverseOrder?: boolean): Text[]; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Cell[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Merges the cells. * @param with_ The cell(s) to merge with. Can accept: Cell, Row or Column. (Optional) */ merge(with_?: Cell | Row | Column): Cell; /** * Recomposes the text in the Cell. */ recompose(): void; /** * Deletes the Cell. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Selects the object. * @param existingSelection The selection status of the Cell in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Splits the cell along the specified axis. * @param using The direction in which to split the cell. */ split(using: HorizontalOrVertical): void; /** * Generates a string which, if executed, will return the Cell. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Unmerges all merged cells in the Cell. */ unmerge(): Cell[]; } /** * A cell style. */ declare class CellStyle { /** * The paragraph style applied to the text. Can return: ParagraphStyle or * NothingEnum enumerator. Can also accept: String. */ appliedParagraphStyle: ParagraphStyle | string | NothingEnum; /** * The style that this style is based on. Can return: CellStyle or String. */ basedOn: CellStyle | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the bottom edge * border stroke. Can return: Swatch or NothingEnum enumerator. */ bottomEdgeStrokeColor: Swatch | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * bottom edge border stroke. Note: Not valid when bottom edge stroke type is * solid. Can return: Swatch or NothingEnum enumerator. */ bottomEdgeStrokeGapColor: Swatch | NothingEnum; /** * If true, the gap color of the bottom edge border stroke will overprint. * Note: Not valid when bottom edge stroke type is solid. Can return: Boolean * or NothingEnum enumerator. */ bottomEdgeStrokeGapOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the bottom edge border stroke gap color. * (Range: 0 to 100) Note: Not valid when bottom edge stroke type is solid. Can * return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ bottomEdgeStrokeGapTint: number | NothingEnum; /** * If true, the bottom edge border stroke will overprint. Can return: Boolean * or NothingEnum enumerator. */ bottomEdgeStrokeOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the bottom edge border stroke. Can return: * Real or NothingEnum enumerator. */ bottomEdgeStrokeTint: number | NothingEnum; /** * The stroke type of the bottom edge. Can return: StrokeStyle or NothingEnum * enumerator. Can also accept: String. */ bottomEdgeStrokeType: string | StrokeStyle | NothingEnum; /** * The stroke weight of the bottom edge border stroke. Can return: Unit or * NothingEnum enumerator. */ bottomEdgeStrokeWeight: number | NothingEnum; /** * The bottom inset of the cell.The API has been deprecated. Use * TextBottomInset or GraphicBottomInset. Can return: Unit or NothingEnum * enumerator. */ bottomInset: number | NothingEnum; /** * If true, clips the cell's content to width and height of the cell. The API * has been deprecated. Use ClipContentsToTextCell or * ClipContentsToPageItemCell. Can return: Boolean or NothingEnum enumerator. */ clipContentToCell: boolean | NothingEnum; /** * If true, clips the graphic cell's content to width and height of the cell. * Can return: Boolean or NothingEnum enumerator. */ clipContentToGraphicCell: boolean | NothingEnum; /** * If true, clips the text cell's content to width and height of the cell. Can * return: Boolean or NothingEnum enumerator. */ clipContentToTextCell: boolean | NothingEnum; /** * If true, draws the diagonal line in front of cell contents. Can return: * Boolean or NothingEnum enumerator. */ diagonalLineInFront: boolean | NothingEnum; /** * The diagonal line color, specified as a swatch. Can return: Swatch or * NothingEnum enumerator. */ diagonalLineStrokeColor: Swatch | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * diagonal line stroke. Note: Not valid when diagonal line stroke type is * solid. Can return: Swatch or NothingEnum enumerator. */ diagonalLineStrokeGapColor: Swatch | NothingEnum; /** * If true, the stroke gap of the diagonal line will overprint. Note: Not valid * when diagonal line stroke type is solid. Can return: Boolean or NothingEnum * enumerator. */ diagonalLineStrokeGapOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the diagonal line stroke gap color. Note: Not * valid when diagonal line stroke type is solid. Can return: Real or * NothingEnum enumerator. */ diagonalLineStrokeGapTint: number | NothingEnum; /** * If true, the diagonal line stroke will overprint. Can return: Boolean or * NothingEnum enumerator. */ diagonalLineStrokeOverprint: boolean | NothingEnum; /** * The diagonal line tint (as a percentage). (Range: 0 to 100). Can return: * Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ diagonalLineStrokeTint: number | NothingEnum; /** * The stroke type of the diagonal line(s). Can return: StrokeStyle or * NothingEnum enumerator. Can also accept: String. */ diagonalLineStrokeType: string | StrokeStyle | NothingEnum; /** * The diagonal line stroke weight. Can return: Unit or NothingEnum enumerator. */ diagonalLineStrokeWeight: number | NothingEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * object. Can return: Swatch or NothingEnum enumerator. Can also accept: * String. */ fillColor: string | Swatch | NothingEnum; /** * The tint (as a percentage) of the fill of the object. Can return: Real or * NothingEnum enumerator. */ fillTint: number | NothingEnum; /** * The distance between the baseline of the text and the top inset of the cell. * Can return: FirstBaseline enumerator or NothingEnum enumerator. */ firstBaselineOffset: FirstBaseline | NothingEnum; /** * The angle of a linear gradient applied to the fill of the object. (Range: * -180 to 180). Can return: Real or NothingEnum enumerator. */ gradientFillAngle: number | NothingEnum; /** * The length (of a linear gradient) or radius (of a radial gradient) applied * to the fill of the object. Can return: Real or NothingEnum enumerator. */ gradientFillLength: number | NothingEnum; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the CellStyle, in the format [x, y]. Can return: Array of 2 Units or * NothingEnum enumerator. */ gradientFillStart: (number[][] | NothingEnum)[]; /** * The bottom inset of the graphic cell. Can return: Unit or NothingEnum * enumerator. */ graphicBottomInset: number | NothingEnum; /** * The left inset of the graphic cell. Can return: Unit or NothingEnum * enumerator. */ graphicLeftInset: number | NothingEnum; /** * The right inset of the graphic cell. Can return: Unit or NothingEnum * enumerator. */ graphicRightInset: number | NothingEnum; /** * The top inset of the graphic cell. Can return: Unit or NothingEnum * enumerator. */ graphicTopInset: number | NothingEnum; /** * The unique ID of the CellStyle. */ readonly id: number; /** * The index of the CellStyle within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the left edge * border stroke. Can return: Swatch or NothingEnum enumerator. */ leftEdgeStrokeColor: Swatch | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * left edge border stroke. Note: Not valid when left edge stroke type is * solid. Can return: Swatch or NothingEnum enumerator. */ leftEdgeStrokeGapColor: Swatch | NothingEnum; /** * If true, the gap color of the left edge border stroke will overprint. Note: * Not valid when left edge stroke type is solid. Can return: Boolean or * NothingEnum enumerator. */ leftEdgeStrokeGapOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the left edge border stroke gap color. (Range: * 0 to 100) Note: Not valid when left edge stroke type is solid. Can return: * Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ leftEdgeStrokeGapTint: number | NothingEnum; /** * If true, the left edge border stroke will overprint. Can return: Boolean or * NothingEnum enumerator. */ leftEdgeStrokeOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the left edge border stroke. (Range: 0 to * 100). Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ leftEdgeStrokeTint: number | NothingEnum; /** * The stroke type of the left edge. Can return: StrokeStyle or NothingEnum * enumerator. Can also accept: String. */ leftEdgeStrokeType: string | StrokeStyle | NothingEnum; /** * The stroke weight of the left edge border stroke. Can return: Unit or * NothingEnum enumerator. */ leftEdgeStrokeWeight: number | NothingEnum; /** * The left inset of the cell.The API has been deprecated. Use TextLeftInset or * GraphicLeftInset. Can return: Unit or NothingEnum enumerator. */ leftInset: number | NothingEnum; /** * The space between the baseline of the text and the top inset of the frame or * cell. Can return: Unit (0 - 8640 points) or NothingEnum enumerator. */ minimumFirstBaselineOffset: number | NothingEnum; /** * The name of the style. */ name: string; /** * If true, the fill of the object will overprint. Can return: Boolean or * NothingEnum enumerator. */ overprintFill: boolean | NothingEnum; /** * The maximum space that can be added between paragraphs in a cell. Note: * Valid only when vertical justification is justified. Can return: Unit or * NothingEnum enumerator. */ paragraphSpacingLimit: number | NothingEnum; /** * The parent of the CellStyle (a Document, Application or CellStyleGroup). */ readonly parent: Application | CellStyleGroup | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The color, specified as a swatch, of the right edge border stroke. Can * return: Swatch or NothingEnum enumerator. */ rightEdgeStrokeColor: Swatch | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * right edge border stroke. Note: Not valid when right edge stroke type is * solid. Can return: Swatch or NothingEnum enumerator. */ rightEdgeStrokeGapColor: Swatch | NothingEnum; /** * If true, the gap color of the right edge border stroke will overprint. Note: * Not valid when right edge stroke type is solid. Can return: Boolean or * NothingEnum enumerator. */ rightEdgeStrokeGapOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the right edge border stroke gap color. * (Range: 0 to 100) Note: Not valid when right edge stroke type is solid. Can * return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ rightEdgeStrokeGapTint: number | NothingEnum; /** * If true, the right edge border stroke will overprint. Can return: Boolean or * NothingEnum enumerator. */ rightEdgeStrokeOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the right edge border stroke. (Range: 0 to * 100). Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ rightEdgeStrokeTint: number | NothingEnum; /** * The stroke type of the right edge. Can return: StrokeStyle or NothingEnum * enumerator. Can also accept: String. */ rightEdgeStrokeType: string | StrokeStyle | NothingEnum; /** * The stroke weight of the right edge border stroke. Can return: Unit or * NothingEnum enumerator. */ rightEdgeStrokeWeight: number | NothingEnum; /** * The right inset of the cell.The API has been deprecated. Use TextLeftInset * or GraphicRightInset. Can return: Unit or NothingEnum enumerator. */ rightInset: number | NothingEnum; /** * The rotation angle (in degrees) of the cell, specified as one of the * following values: 0, 90, 180, or 270. Can return: Real or NothingEnum * enumerator. */ rotationAngle: number | NothingEnum; /** * The bottom inset of the text cell. Can return: Unit or NothingEnum * enumerator. */ textBottomInset: number | NothingEnum; /** * The left inset of the text cell. Can return: Unit or NothingEnum enumerator. */ textLeftInset: number | NothingEnum; /** * The right inset of the text cell. Can return: Unit or NothingEnum * enumerator. */ textRightInset: number | NothingEnum; /** * The top inset of the text cell. Can return: Unit or NothingEnum enumerator. */ textTopInset: number | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the top edge * border stroke. Can return: Swatch or NothingEnum enumerator. */ topEdgeStrokeColor: Swatch | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * top edge border stroke. Note: Not valid when top edge stroke type is solid. * Can return: Swatch or NothingEnum enumerator. */ topEdgeStrokeGapColor: Swatch | NothingEnum; /** * If true, the gap color of the top edge border stroke will overprint. Note: * Not valid when top edge stroke type is solid. . Can return: Boolean or * NothingEnum enumerator. */ topEdgeStrokeGapOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the top edge border stroke gap color. (Range: * 0 to 100) Note: Not valid when top edge stroke type is solid. Can return: * Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ topEdgeStrokeGapTint: number | NothingEnum; /** * If true, the top edge border stroke will overprint. Can return: Boolean or * NothingEnum enumerator. */ topEdgeStrokeOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the top edge border stroke. (Range: 0 to 100). * Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ topEdgeStrokeTint: number | NothingEnum; /** * The stroke type of the top edge. Can return: StrokeStyle or NothingEnum * enumerator. Can also accept: String. */ topEdgeStrokeType: string | StrokeStyle | NothingEnum; /** * The stroke weight of the top edge border stroke. Can return: Unit or * NothingEnum enumerator. */ topEdgeStrokeWeight: number | NothingEnum; /** * The top inset of the cell. The API has been deprecated. Use TextTopInset or * GraphicTopInset. Can return: Unit or NothingEnum enumerator. */ topInset: number | NothingEnum; /** * If true, draws a diagonal line starting from the top left. Can return: * Boolean or NothingEnum enumerator. */ topLeftDiagonalLine: boolean | NothingEnum; /** * If true, draws a diagonal line starting from the top right. Can return: * Boolean or NothingEnum enumerator. */ topRightDiagonalLine: boolean | NothingEnum; /** * The vertical alignment of cell. Can return: VerticalJustification enumerator * or NothingEnum enumerator. */ verticalJustification: VerticalJustification | NothingEnum; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the CellStyle. */ duplicate(): CellStyle; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): CellStyle[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Moves the style to the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: ParagraphStyle, ParagraphStyleGroup, CharacterStyle, CharacterStyleGroup, CellStyle, CellStyleGroup, TableStyle, TableStyleGroup, Document or Application. (Optional) */ move(to: LocationOptions, reference?: CellStyle | CellStyleGroup | CharacterStyle | CharacterStyleGroup | Document | ParagraphStyle | ParagraphStyleGroup | TableStyle | TableStyleGroup | Application): CellStyle; /** * Deletes the style. * @param replacingWith The style to apply in place of the deleted style. (Optional) */ remove(replacingWith?: CellStyle): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the CellStyle. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A cell style group. */ declare class CellStyleGroup { /** * All Cell styles */ readonly allCellStyles: CellStyle[]; /** * A collection of cell style groups. */ readonly cellStyleGroups: CellStyleGroups; /** * A collection of cell styles. */ readonly cellStyles: CellStyles; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the CellStyleGroup. */ readonly id: number; /** * The index of the CellStyleGroup within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the CellStyleGroup. */ name: string; /** * The parent of the CellStyleGroup (a Document, Application or * CellStyleGroup). */ readonly parent: Application | CellStyleGroup | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the CellStyleGroup. */ duplicate(): CellStyleGroup; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): CellStyleGroup[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Moves the style to the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: ParagraphStyle, ParagraphStyleGroup, CharacterStyle, CharacterStyleGroup, CellStyle, CellStyleGroup, TableStyle, TableStyleGroup, Document or Application. (Optional) */ move(to: LocationOptions, reference?: CellStyle | CellStyleGroup | CharacterStyle | CharacterStyleGroup | Document | ParagraphStyle | ParagraphStyleGroup | TableStyle | TableStyleGroup | Application): CellStyleGroup; /** * Deletes the style. * @param replacingWith The style to apply in place of the deleted style. Can accept: ParagraphStyle or CharacterStyle. (Optional) */ remove(replacingWith?: ParagraphStyle | CharacterStyle): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the CellStyleGroup. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of cell style groups. */ declare class CellStyleGroups { /** Returns the CellStyleGroup with the specified index or name. */ [index: number]: CellStyleGroup; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new CellStyleGroup. * @param withProperties Initial values for properties of the new CellStyleGroup (Optional) */ add(withProperties?: Object): CellStyleGroup; /** * Returns any CellStyleGroup in the collection. */ anyItem(): CellStyleGroup; /** * Displays the number of elements in the CellStyleGroup. */ count(): number; /** * Returns every CellStyleGroup in the collection. */ everyItem(): CellStyleGroup; /** * Returns the first CellStyleGroup in the collection. */ firstItem(): CellStyleGroup; /** * Returns the CellStyleGroup with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): CellStyleGroup; /** * Returns the CellStyleGroup with the specified ID. * @param id The ID. */ itemByID(id: number): CellStyleGroup; /** * Returns the CellStyleGroup with the specified name. * @param name The name. */ itemByName(name: string): CellStyleGroup; /** * Returns the CellStyleGroups within the specified range. * @param from The CellStyleGroup, index, or name at the beginning of the range. Can accept: CellStyleGroup, Long Integer or String. * @param to The CellStyleGroup, index, or name at the end of the range. Can accept: CellStyleGroup, Long Integer or String. */ itemByRange(from: CellStyleGroup | number | string, to: CellStyleGroup | number | string): CellStyleGroup[]; /** * Returns the last CellStyleGroup in the collection. */ lastItem(): CellStyleGroup; /** * Returns the middle CellStyleGroup in the collection. */ middleItem(): CellStyleGroup; /** * Returns the CellStyleGroup whose index follows the specified CellStyleGroup * in the collection. * @param obj The CellStyleGroup whose index comes before the desired CellStyleGroup. */ nextItem(obj: CellStyleGroup): CellStyleGroup; /** * Returns the CellStyleGroup with the index previous to the specified index. * @param obj The index of the CellStyleGroup that follows the desired CellStyleGroup. */ previousItem(obj: CellStyleGroup): CellStyleGroup; /** * Generates a string which, if executed, will return the CellStyleGroup. */ toSource(): string; } /** * A cell style mapping. */ declare class CellStyleMapping { /** * The destination style name property. */ destinationStyleName: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the CellStyleMapping within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The type of the mapping rule. */ mappingRuleType: MapType; /** * The parent of the CellStyleMapping (a Application, Document, Story or * XmlStory). */ readonly parent: Document | Story | Application | XmlStory; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The source style name property. */ sourceStyleName: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): CellStyleMapping[]; /** * deletes a style mapping. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the CellStyleMapping. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of cell style mappings. */ declare class CellStyleMappings { /** Returns the CellStyleMapping with the specified index or name. */ [index: number]: CellStyleMapping; /** * The number of objects in the collection. */ readonly length: number; /** * Adds a style mapping. * @param sourceStyleName The source style name. * @param destinationStyleName The destination style name. * @param mappingRuleType The mapping type * @param withProperties Initial values for properties of the new CellStyleMapping (Optional) */ add(sourceStyleName: string, destinationStyleName: string, mappingRuleType: MapType, withProperties?: Object): CellStyleMapping; /** * Returns any CellStyleMapping in the collection. */ anyItem(): CellStyleMapping; /** * Displays the number of elements in the CellStyleMapping. */ count(): number; /** * Returns every CellStyleMapping in the collection. */ everyItem(): CellStyleMapping; /** * Returns the first CellStyleMapping in the collection. */ firstItem(): CellStyleMapping; /** * Returns the CellStyleMapping with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): CellStyleMapping; /** * Returns the CellStyleMappings within the specified range. * @param from The CellStyleMapping, index, or name at the beginning of the range. Can accept: CellStyleMapping, Long Integer or String. * @param to The CellStyleMapping, index, or name at the end of the range. Can accept: CellStyleMapping, Long Integer or String. */ itemByRange(from: CellStyleMapping | number | string, to: CellStyleMapping | number | string): CellStyleMapping[]; /** * Returns the last CellStyleMapping in the collection. */ lastItem(): CellStyleMapping; /** * Returns the middle CellStyleMapping in the collection. */ middleItem(): CellStyleMapping; /** * Returns the CellStyleMapping whose index follows the specified * CellStyleMapping in the collection. * @param obj The CellStyleMapping whose index comes before the desired CellStyleMapping. */ nextItem(obj: CellStyleMapping): CellStyleMapping; /** * Returns the CellStyleMapping with the index previous to the specified index. * @param obj The index of the CellStyleMapping that follows the desired CellStyleMapping. */ previousItem(obj: CellStyleMapping): CellStyleMapping; /** * Generates a string which, if executed, will return the CellStyleMapping. */ toSource(): string; } /** * A collection of cell styles. */ declare class CellStyles { /** Returns the CellStyle with the specified index or name. */ [index: number]: CellStyle; /** * The number of objects in the collection. Can return: Long Integer or * NothingEnum enumerator. */ readonly length: number | NothingEnum; /** * Creates a new CellStyle. * @param withProperties Initial values for properties of the new CellStyle (Optional) */ add(withProperties?: Object): CellStyle; /** * Returns any CellStyle in the collection. */ anyItem(): CellStyle; /** * Displays the number of elements in the CellStyle. */ count(): number; /** * Returns every CellStyle in the collection. */ everyItem(): CellStyle; /** * Returns the first CellStyle in the collection. */ firstItem(): CellStyle; /** * Returns the CellStyle with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): CellStyle; /** * Returns the CellStyle with the specified ID. * @param id The ID. */ itemByID(id: number): CellStyle; /** * Returns the CellStyle with the specified name. * @param name The name. */ itemByName(name: string): CellStyle; /** * Returns the CellStyles within the specified range. * @param from The CellStyle, index, or name at the beginning of the range. Can accept: CellStyle, Long Integer or String. * @param to The CellStyle, index, or name at the end of the range. Can accept: CellStyle, Long Integer or String. */ itemByRange(from: CellStyle | number | string, to: CellStyle | number | string): CellStyle[]; /** * Returns the last CellStyle in the collection. */ lastItem(): CellStyle; /** * Returns the middle CellStyle in the collection. */ middleItem(): CellStyle; /** * Returns the CellStyle whose index follows the specified CellStyle in the * collection. * @param obj The CellStyle whose index comes before the desired CellStyle. */ nextItem(obj: CellStyle): CellStyle; /** * Returns the CellStyle with the index previous to the specified index. * @param obj The index of the CellStyle that follows the desired CellStyle. */ previousItem(obj: CellStyle): CellStyle; /** * Generates a string which, if executed, will return the CellStyle. */ toSource(): string; } /** * Specify the type of cell, either text or graphic. */ declare enum CellTypeEnum { /** * Graphic or Page item cell. */ GRAPHIC_TYPE_CELL = 1701728329, /** * Text cell. */ TEXT_TYPE_CELL = 1701730388, } /** * A collection of table cells. */ declare class Cells { /** Returns the Cell with the specified index or name. */ [index: number]: Cell; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Cell in the collection. */ anyItem(): Cell; /** * Displays the number of elements in the Cell. */ count(): number; /** * Returns every Cell in the collection. */ everyItem(): Cell; /** * Returns the first Cell in the collection. */ firstItem(): Cell; /** * Returns the Cell with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Cell; /** * Returns the Cell with the specified ID. * @param id The ID. */ itemByID(id: number): Cell; /** * Returns the Cell with the specified name. * @param name The name. */ itemByName(name: string): Cell; /** * Returns the Cells within the specified range. * @param from The Cell, index, or name at the beginning of the range. Can accept: Cell, Long Integer or String. * @param to The Cell, index, or name at the end of the range. Can accept: Cell, Long Integer or String. */ itemByRange(from: Cell | number | string, to: Cell | number | string): Cell[]; /** * Returns the last Cell in the collection. */ lastItem(): Cell; /** * Returns the middle Cell in the collection. */ middleItem(): Cell; /** * Returns the Cell whose index follows the specified Cell in the collection. * @param obj The Cell whose index comes before the desired Cell. */ nextItem(obj: Cell): Cell; /** * Returns the Cell with the index previous to the specified index. * @param obj The index of the Cell that follows the desired Cell. */ previousItem(obj: Cell): Cell; /** * Generates a string which, if executed, will return the Cell. */ toSource(): string; } /** * A tracked change made to a story. */ declare class Change { /** * The type of tracked change. Note: Valid only when track changes is true. */ readonly changeType: ChangeTypes; /** * A collection of characters. */ readonly characters: Characters; /** * The date on which the tracked change was made. Note: Valid only when track * changes is true. */ readonly date: Date; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the Change within its containing object. */ readonly index: number; /** * A collection of insertion points. */ readonly insertionPoints: InsertionPoints; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A collection of lines. */ readonly lines: Lines; /** * A collection of paragraphs. */ readonly paragraphs: Paragraphs; /** * The parent of the Change (a Story, XmlStory or Cell). */ readonly parent: XmlStory | Cell | Story; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The location of the first insertion point in the object (relative to the * beginning of the story). */ readonly storyOffset: InsertionPoint; /** * A collection of text columns. */ readonly textColumns: TextColumns; /** * A collection of text style ranges. */ readonly textStyleRanges: TextStyleRanges; /** * A collection of text variable instances. */ readonly textVariableInstances: TextVariableInstances; /** * A collection of text objects. */ readonly texts: Texts; /** * The user who made the change. Note: Valid only when track changes is true. */ readonly userName: string; /** * A collection of words. */ readonly words: Words; /** * Accepts the tracked change. Note: Valid only when track changes is true. */ accept(): void; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Change[]; /** * Rejects the tracked change. Note: Valid only when track changes is true. */ reject(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Change. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Background color options for changed text. */ declare enum ChangeBackgroundColorChoices { /** * The background color for changed text is the same as the track changes * preferences background color. For information, see background color for * added text, background color for deleted text, or background color for moved * text. */ CHANGE_BACKGROUND_USES_CHANGE_PREF_COLOR = 1700098146, /** * The background color for changed text is the same as the galley background * color. */ CHANGE_BACKGROUND_USES_GALLEY_BACKGROUND_COLOR = 1700095842, /** * The background color for changed text is the same as the color assigned to * the current user. */ CHANGE_BACKGROUND_USES_USER_COLOR = 1700099426, } /** * Change case options. */ declare enum ChangeCaseOptions { /** * Converts all letters to lowercase. */ LOWERCASE = 1667460195, /** * No conversion. */ NONE = 1852796517, /** * Converts the first letter of the first word of each sentence to uppercase. */ SENTENCECASE = 1667461987, /** * Converts the first letter of each word to uppercase. */ TITLECASE = 1667462243, /** * Converts all letters to uppercase. */ UPPERCASE = 1667462499, } /** * Change color preferences. */ declare class ChangeColorPreference extends Preference { /** * The replacement color. Can return: Swatch or NothingEnum enumerator. */ changeTo: Swatch | NothingEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the ChangeColorPreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The replacement tint. Can return: Real (0 - 100) or NothingEnum enumerator. */ tint: number | NothingEnum; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ChangeColorPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * ChangeColorPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Change conditions modes. */ declare enum ChangeConditionsModes { /** * Change adds to applied conditions. */ ADD_TO = 1633969202, /** * Change replaces applied conditions. */ REPLACE_WITH = 1919250519, } /** * Change glyph preferences. */ declare class ChangeGlyphPreference extends Preference { /** * The font applied to the ChangeGlyphPreference, specified as either a font * object or the name of font family. Can return: Font, String or NothingEnum * enumerator. */ appliedFont: Font | string | NothingEnum; /** * Value of Design Axes. Can return: Array of Reals or NothingEnum enumerator. */ designAxes: (number[] | NothingEnum)[]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The name of the font style. Can return: String or NothingEnum enumerator. */ fontStyle: string | NothingEnum; /** * The GID/CID of the glyph. Can return: Long Integer or NothingEnum * enumerator. */ glyphID: number | NothingEnum; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the ChangeGlyphPreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ChangeGlyphPreference[]; /** * If true, Nth design axis of variable font is hidden. * @param nthAxisIndex Index of design axis. */ isNthDesignAxisHidden(nthAxisIndex: number): boolean; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Set Nth design axis of a variable font. * @param nthAxisIndex Index of design axis. * @param nthAxisValue Value of nth design axis. */ setNthDesignAxis(nthAxisIndex: number, nthAxisValue: number): void; /** * Generates a string which, if executed, will return the * ChangeGlyphPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Change grep preferences. */ declare class ChangeGrepPreference extends Preference { /** * If true, words unassociated with a hyphenation dictionary can break to the * next line on any character. Can return: Boolean or NothingEnum enumerator. */ allowArbitraryHyphenation: boolean | NothingEnum; /** * The character style to search for or change to. Can return: String or * NothingEnum enumerator. Can also accept: CharacterStyle. */ appliedCharacterStyle: CharacterStyle | string | NothingEnum; /** * The conditions to search for or change to. Specify the "nothing" enum for * "Any" or an empty list for "[Unconditional]". Can return: Array of Strings * or NothingEnum enumerator. Can also accept: Array of Conditions. */ appliedConditions: (Conditions | string[] | NothingEnum)[]; /** * The font applied to the ChangeGrepPreference, specified as either a font * object or the name of font family. Can return: Font, String or NothingEnum * enumerator. */ appliedFont: Font | string | NothingEnum; /** * The language to search for or change to. Can return: String or NothingEnum * enumerator. Can also accept: Language or LanguageWithVendors. */ appliedLanguage: Language | string | LanguageWithVendors | NothingEnum; /** * The list to be part of. Can return: NumberingList, String or NothingEnum * enumerator. */ appliedNumberingList: NumberingList | string | NothingEnum; /** * The paragraph style to search for or change to. Can return: String or * NothingEnum enumerator. Can also accept: ParagraphStyle. */ appliedParagraphStyle: ParagraphStyle | string | NothingEnum; /** * The percent of the type size to use for auto leading. (Range: 0 to 500). Can * return: Real or NothingEnum enumerator. * @remarks Range: 0 to 500 */ autoLeading: number | NothingEnum; /** * The number of half-width characters at or below which the characters * automatically run horizontally in vertical text. Can return: Short Integer * or NothingEnum enumerator. */ autoTcy: number | NothingEnum; /** * If true, auto tcy includes Roman characters. Can return: Boolean or * NothingEnum enumerator. */ autoTcyIncludeRoman: boolean | NothingEnum; /** * If true or set to an enumeration value, balances ragged lines. Note: Not * valid with a single-line text composer. Can return: Boolean, * BalanceLinesStyle enumerator or NothingEnum enumerator. */ balanceRaggedLines: BalanceLinesStyle | boolean | NothingEnum; /** * The baseline shift applied to the text. Can return: Unit or NothingEnum * enumerator. */ baselineShift: number | NothingEnum; /** * Bullet character. Can return: Bullet or NothingEnum enumerator. */ readonly bulletChar: Bullet | NothingEnum; /** * List type for bullets and numbering. Can return: ListType enumerator or * NothingEnum enumerator. */ bulletsAndNumberingListType: ListType | NothingEnum; /** * The character style to be used for the text after string. Can return: * CharacterStyle, String or NothingEnum enumerator. */ bulletsCharacterStyle: CharacterStyle | string | NothingEnum; /** * The text after string expression for bullets. Can return: String or * NothingEnum enumerator. */ bulletsTextAfter: string | NothingEnum; /** * If true, adds the double period (..), ellipse (...), and double hyphen (--) * to the selected kinsoku set. Note: Valid only when a kinsoku set is in * effect. Can return: Boolean or NothingEnum enumerator. */ bunriKinshi: boolean | NothingEnum; /** * The capitalization scheme. Can return: Capitalization enumerator or * NothingEnum enumerator. */ capitalization: Capitalization | NothingEnum; /** * The change case mode, changes the case of the found text. Can return: * ChangecaseMode enumerator or NothingEnum enumerator. */ changeCaseMode: ChangecaseMode | NothingEnum; /** * The change conditions mode, change either replaces applied conditions or * adds to applied conditions. Can return: ChangeConditionsModes enumerator or * NothingEnum enumerator. */ changeConditionsMode: ChangeConditionsModes | NothingEnum; /** * The replacement ChangeGrepPreference. Can return: String or NothingEnum * enumerator. */ changeTo: string | NothingEnum; /** * The alignment of small characters to the largest character in the line. Can * return: CharacterAlignment enumerator or NothingEnum enumerator. */ characterAlignment: CharacterAlignment | NothingEnum; /** * The direction of the character. Can return: CharacterDirectionOptions * enumerator or NothingEnum enumerator. */ characterDirection: CharacterDirectionOptions | NothingEnum; /** * The rotation angle (in degrees) of individual characters. Note: The rotation * is counterclockwise. Can return: Real or NothingEnum enumerator. */ characterRotation: number | NothingEnum; /** * If true, uses grid tracking to track non-Roman characters in CJK grids. Can * return: Boolean or NothingEnum enumerator. */ cjkGridTracking: boolean | NothingEnum; /** * The text composer to use to compose the text. Can return: String or * NothingEnum enumerator. */ composer: string | NothingEnum; /** * Value of Design Axes. Can return: Array of Reals or NothingEnum enumerator. */ designAxes: (number[] | NothingEnum)[]; /** * Position of diacriticical characters. Can return: DiacriticPositionOptions * enumerator or NothingEnum enumerator. */ diacriticPosition: DiacriticPositionOptions | NothingEnum; /** * The digits type. Can return: DigitsTypeOptions enumerator or NothingEnum * enumerator. */ digitsType: DigitsTypeOptions | NothingEnum; /** * The number of characters to drop cap. Can return: Short Integer (0 - 150) or * NothingEnum enumerator. */ dropCapCharacters: number | NothingEnum; /** * The number of lines to drop cap. Can return: Short Integer (0 - 25) or * NothingEnum enumerator. */ dropCapLines: number | NothingEnum; /** * Details about the drop cap based on the glyph outlines. 1 = left side * bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid. * Can return: Long Integer or NothingEnum enumerator. */ dropcapDetail: number | NothingEnum; /** * The stroke join type applied to the characters of the text. Can return: * OutlineJoin enumerator or NothingEnum enumerator. */ endJoin: OutlineJoin | NothingEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink), applied as a fill color, * to search for or change to. Can return: String or NothingEnum enumerator. * Can also accept: Swatch. */ fillColor: string | Swatch | NothingEnum; /** * The tint (as a percentage) of the fill color of the ChangeGrepPreference. * (To specify a tint percentage, use a number in the range of 0 to 100; to use * the inherited or overridden value, use -1.). Can return: Real or NothingEnum * enumerator. * @remarks Range: 0 to 100 */ fillTint: number | NothingEnum; /** * The amount to indent the first line. Can return: Unit or NothingEnum * enumerator. */ firstLineIndent: number | NothingEnum; /** * The name of the font style. Can return: String or NothingEnum enumerator. */ fontStyle: string | NothingEnum; /** * The glyph variant to substitute for standard glyphs. Can return: * AlternateGlyphForms enumerator or NothingEnum enumerator. */ glyphForm: AlternateGlyphForms | NothingEnum; /** * The angle of a linear gradient applied to the fill of the text. (Range: -180 * to 180). Can return: Real or NothingEnum enumerator. */ gradientFillAngle: number | NothingEnum; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the text. Can return: Real or NothingEnum enumerator. */ gradientFillLength: number | NothingEnum; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the text, in the format [x, y]. Can return: Array of 2 Units or * NothingEnum enumerator. */ gradientFillStart: (number[][] | NothingEnum)[]; /** * The angle of a linear gradient applied to the stroke of the text. (Range: * -180 to 180). Can return: Real or NothingEnum enumerator. */ gradientStrokeAngle: number | NothingEnum; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the text. Can return: Real or NothingEnum enumerator. */ gradientStrokeLength: number | NothingEnum; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the text, in the format [x, y]. Can return: Array of 2 Units or * NothingEnum enumerator. */ gradientStrokeStart: (number[][] | NothingEnum)[]; /** * The alignment to the frame grid or baseline grid. Can return: GridAlignment * enumerator or NothingEnum enumerator. */ gridAlignment: GridAlignment | NothingEnum; /** * The manual gyoudori setting. Can return: Short Integer or NothingEnum * enumerator. */ gridGyoudori: number | NothingEnum; /** * The horizontal scaling applied to the ChangeGrepPreference. Can return: Real * or NothingEnum enumerator. */ horizontalScale: number | NothingEnum; /** * If true, allows the last word in a text column to be hyphenated. Can return: * Boolean or NothingEnum enumerator. */ hyphenateAcrossColumns: boolean | NothingEnum; /** * If true, allows hyphenation in the last word in a paragraph. Note: Valid * only when hyphenation is true. Can return: Boolean or NothingEnum * enumerator. */ hyphenateLastWord: boolean | NothingEnum; /** * If true, ignores optical edge alignment for the paragraph. Can return: * Boolean or NothingEnum enumerator. */ ignoreEdgeAlignment: boolean | NothingEnum; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The number of grid squares in which to arrange the text. . Can return: Short * Integer or NothingEnum enumerator. */ jidori: number | NothingEnum; /** * The paragraph alignment. Can return: Justification enumerator or NothingEnum * enumerator. */ justification: Justification | NothingEnum; /** * Use of Kashidas for justification. Can return: KashidasOptions enumerator or * NothingEnum enumerator. */ kashidas: KashidasOptions | NothingEnum; /** * If true, keeps all lines of the paragraph together. If false, allows * paragraphs to break across pages or columns. Can return: Boolean or * NothingEnum enumerator. */ keepAllLinesTogether: boolean | NothingEnum; /** * The minimum number of lines to keep together in a paragraph before allowing * a page break. Can return: Short Integer (1 - 50) or NothingEnum enumerator. */ keepFirstLines: number | NothingEnum; /** * The minimum number of lines to keep together in a paragraph after a page * break. Can return: Short Integer (1 - 50) or NothingEnum enumerator. */ keepLastLines: number | NothingEnum; /** * If true, keeps a specified number of lines together when the paragraph * breaks across columns or text frames. Can return: Boolean or NothingEnum * enumerator. */ keepLinesTogether: boolean | NothingEnum; /** * If true, forces the rule above the paragraph to remain in the frame bounds. * Note: Valid only when rule above is true. Can return: Boolean or NothingEnum * enumerator. */ keepRuleAboveInFrame: boolean | NothingEnum; /** * The minimum number of lines to keep with the next paragraph. Can return: * Short Integer (0 - 5) or NothingEnum enumerator. */ keepWithNext: number | NothingEnum; /** * If the first line in the paragraph should be kept with the last line of * previous paragraph. Can return: Boolean or NothingEnum enumerator. */ keepWithPrevious: boolean | NothingEnum; /** * The alignment of kenten characters relative to the parent characters. . Can * return: KentenAlignment enumerator or NothingEnum enumerator. */ kentenAlignment: KentenAlignment | NothingEnum; /** * The character set used for the custom kenten character. Note: Valid only * when kenten kind is custom. . Can return: KentenCharacterSet enumerator or * NothingEnum enumerator. */ kentenCharacterSet: KentenCharacterSet | NothingEnum; /** * The character used for kenten. Note: Valid only when kenten kind is custom. * Can return: String or NothingEnum enumerator. */ kentenCustomCharacter: string | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of * kenten characters. Can return: Swatch, String or NothingEnum enumerator. */ kentenFillColor: string | Swatch | NothingEnum; /** * The font to use for kenten characters. Can return: Font, String or * NothingEnum enumerator. */ kentenFont: Font | string | NothingEnum; /** * The size (in points) of kenten characters. Can return: Real or NothingEnum * enumerator. */ kentenFontSize: number | NothingEnum; /** * The font style of kenten characters. Can return: String or NothingEnum * enumerator. */ kentenFontStyle: string | NothingEnum; /** * The style of kenten characters. Can return: KentenCharacter enumerator or * NothingEnum enumerator. */ kentenKind: KentenCharacter | NothingEnum; /** * The method of overprinting the kenten fill. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ kentenOverprintFill: AdornmentOverprint | NothingEnum; /** * The method of overprinting the kenten stroke. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ kentenOverprintStroke: AdornmentOverprint | NothingEnum; /** * The distance between kenten characters and their parent characters. Can * return: Real or NothingEnum enumerator. */ kentenPlacement: number | NothingEnum; /** * The kenten position relative to the parent character. Can return: * RubyKentenPosition enumerator or NothingEnum enumerator. */ kentenPosition: RubyKentenPosition | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * kenten characters. Can return: Swatch, String or NothingEnum enumerator. */ kentenStrokeColor: string | Swatch | NothingEnum; /** * The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100). * Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ kentenStrokeTint: number | NothingEnum; /** * The fill tint (as a percentage) of kenten characters. (Range: 0 to 100). Can * return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ kentenTint: number | NothingEnum; /** * The stroke weight (in points) of kenten characters. Can return: Real or * NothingEnum enumerator. */ kentenWeight: number | NothingEnum; /** * The horizontal size of kenten characters as a percent of the original size. * Can return: Real or NothingEnum enumerator. */ kentenXScale: number | NothingEnum; /** * The vertical size of kenten charachers as a percent of the original size. . * Can return: Real or NothingEnum enumerator. */ kentenYScale: number | NothingEnum; /** * The type of pair kerning. Can return: String or NothingEnum enumerator. */ kerningMethod: string | NothingEnum; /** * The amount of space to add or remove between characters, specified in * thousands of an em. . Can return: Real or NothingEnum enumerator. */ kerningValue: number | NothingEnum; /** * The keyboard direction of the character. Can return: * CharacterDirectionOptions enumerator or NothingEnum enumerator. */ keyboardDirection: CharacterDirectionOptions | NothingEnum; /** * The type of hanging punctuation to allow. Note: Valid only when a kinsoku * set is in effect. Can return: KinsokuHangTypes enumerator or NothingEnum * enumerator. */ kinsokuHangType: KinsokuHangTypes | NothingEnum; /** * The kinsoku set that determines legitimate line breaks. Can return: * KinsokuTable, KinsokuSet enumerator, String or NothingEnum enumerator. */ kinsokuSet: KinsokuSet | KinsokuTable | string | NothingEnum; /** * The type of kinsoku processing for preventing kinsoku characters from * beginning or ending a line. Note: Valid only when a kinsoku set is defined. * Can return: KinsokuType enumerator or NothingEnum enumerator. */ kinsokuType: KinsokuType | NothingEnum; /** * The amount to indent the last line in the paragraph. Can return: Unit or * NothingEnum enumerator. */ lastLineIndent: number | NothingEnum; /** * The leading applied to the text. Can return: Unit, Leading enumerator or * NothingEnum enumerator. */ leading: Leading | number | NothingEnum; /** * The amount of space before each character. Can return: Real or NothingEnum * enumerator. */ leadingAki: number | NothingEnum; /** * The point from which leading is measured from line to line. Can return: * LeadingModel enumerator or NothingEnum enumerator. */ leadingModel: LeadingModel | NothingEnum; /** * The width of the left indent. Can return: Unit or NothingEnum enumerator. */ leftIndent: number | NothingEnum; /** * If true, replaces specific character combinations (e.g., fl, fi) with * ligature characters. Can return: Boolean or NothingEnum enumerator. */ ligatures: boolean | NothingEnum; /** * The XML tag applied to the element. Can return: String or NothingEnum * enumerator. Can also accept: XMLTag. */ markupTag: string | XMLTag | NothingEnum; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. Can return: Real (0 - * 1000) or NothingEnum enumerator. */ miterLimit: number | NothingEnum; /** * The mojikumi table. For information, see mojikumi table defaults. Can * return: MojikumiTable, String, MojikumiTableDefaults enumerator or * NothingEnum enumerator. */ mojikumi: MojikumiTable | MojikumiTableDefaults | string | NothingEnum; /** * If true, keeps the text on the same line. . Can return: Boolean or * NothingEnum enumerator. */ noBreak: boolean | NothingEnum; /** * If true, apply the numbering restart policy. Can return: Boolean or * NothingEnum enumerator. */ numberingApplyRestartPolicy: boolean | NothingEnum; /** * The character style to be used for the number string. Can return: * CharacterStyle, String or NothingEnum enumerator. */ numberingCharacterStyle: CharacterStyle | string | NothingEnum; /** * Continue the numbering at this level. Can return: Boolean or NothingEnum * enumerator. */ numberingContinue: boolean | NothingEnum; /** * The number string expression for numbering. Can return: String or * NothingEnum enumerator. */ numberingExpression: string | NothingEnum; /** * Numbering format options. Can return: NumberingStyle enumerator, String or * NothingEnum enumerator. */ numberingFormat: NumberingStyle | string | NothingEnum; /** * The level of the paragraph. Can return: Long Integer or NothingEnum * enumerator. */ numberingLevel: number | NothingEnum; /** * Numbering restart policies. Can return: NumberingRestartPolicy or * NothingEnum enumerator. */ readonly numberingRestartPolicies: NumberingRestartPolicy | NothingEnum; /** * Determines starting number in a numbered list. Can return: Long Integer or * NothingEnum enumerator. */ numberingStartAt: number | NothingEnum; /** * If true, uses contextual alternate forms in OpenType fonts. Can return: * Boolean or NothingEnum enumerator. */ otfContextualAlternate: boolean | NothingEnum; /** * If true, uses discretionary ligatures in OpenType fonts. Can return: Boolean * or NothingEnum enumerator. */ otfDiscretionaryLigature: boolean | NothingEnum; /** * The figure style in OpenType fonts. Can return: OTFFigureStyle enumerator or * NothingEnum enumerator. */ otfFigureStyle: OTFFigureStyle | NothingEnum; /** * If true, uses fractions in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfFraction: boolean | NothingEnum; /** * If true, switches hiragana fonts, which have different glyphs for horizontal * and vertical. . Can return: Boolean or NothingEnum enumerator. */ otfHVKana: boolean | NothingEnum; /** * If true, use historical forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfHistorical: boolean | NothingEnum; /** * If true, use alternate justification forms in OpenType fonts. Can return: * Boolean or NothingEnum enumerator. */ otfJustificationAlternate: boolean | NothingEnum; /** * If true, uses localized forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfLocale: boolean | NothingEnum; /** * If true, uses mark positioning in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfMark: boolean | NothingEnum; /** * If true, uses ordinals in OpenType fonts. Can return: Boolean or NothingEnum * enumerator. */ otfOrdinal: boolean | NothingEnum; /** * If true, use overlapping swash forms in OpenType fonts. Can return: Boolean * or NothingEnum enumerator. */ otfOverlapSwash: boolean | NothingEnum; /** * If true, kerns according to proportional CJK metrics in OpenType fonts. Can * return: Boolean or NothingEnum enumerator. */ otfProportionalMetrics: boolean | NothingEnum; /** * If true, applies italics to half-width alphanumerics. . Can return: Boolean * or NothingEnum enumerator. */ otfRomanItalics: boolean | NothingEnum; /** * If true, use a slashed zeroes in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfSlashedZero: boolean | NothingEnum; /** * If true, use stretched alternate forms in OpenType fonts. Can return: * Boolean or NothingEnum enumerator. */ otfStretchedAlternate: boolean | NothingEnum; /** * If true, use stylistic alternate forms in OpenType fonts. Can return: * Boolean or NothingEnum enumerator. */ otfStylisticAlternate: boolean | NothingEnum; /** * The stylistic sets to use in OpenType fonts. Can return: Long Integer or * NothingEnum enumerator. */ otfStylisticSets: number | NothingEnum; /** * If true, uses swash forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfSwash: boolean | NothingEnum; /** * If true, uses titling forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfTitling: boolean | NothingEnum; /** * If true, the fill color of the characters will overprint. Can return: * Boolean or NothingEnum enumerator. */ overprintFill: boolean | NothingEnum; /** * If true, the stroke of the characters will overprint. Can return: Boolean or * NothingEnum enumerator. */ overprintStroke: boolean | NothingEnum; /** * Paragraph direction. Can return: ParagraphDirectionOptions enumerator or * NothingEnum enumerator. */ paragraphDirection: ParagraphDirectionOptions | NothingEnum; /** * If true, the gyoudori mode applies to the entire paragraph. If false, the * gyoudori mode applies to each line in the paragraph. Can return: Boolean or * NothingEnum enumerator. */ paragraphGyoudori: boolean | NothingEnum; /** * Paragraph justification. Can return: ParagraphJustificationOptions * enumerator or NothingEnum enumerator. */ paragraphJustification: ParagraphJustificationOptions | NothingEnum; /** * Paragraph kashida width. 0 is none, 1 is short, 2 is medium, 3 is long. Can * return: Real or NothingEnum enumerator. */ paragraphKashidaWidth: number | NothingEnum; /** * The parent of the ChangeGrepPreference (a Application). */ readonly parent: Application; /** * The text size. Can return: Unit or NothingEnum enumerator. */ pointSize: number | NothingEnum; /** * The text position relative to the baseline. Can return: Position enumerator * or NothingEnum enumerator. */ position: Position | NothingEnum; /** * The OpenType positional form. Can return: PositionalForms enumerator or * NothingEnum enumerator. */ positionalForm: PositionalForms | NothingEnum; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, disallows line breaks in numbers. If false, lines can break between * digits in multi-digit numbers. Can return: Boolean or NothingEnum * enumerator. */ rensuuji: boolean | NothingEnum; /** * The width of the right indent. Can return: Unit or NothingEnum enumerator. */ rightIndent: number | NothingEnum; /** * If true, rotates Roman characters in vertical text. Can return: Boolean or * NothingEnum enumerator. */ rotateSingleByteCharacters: boolean | NothingEnum; /** * The ruby alignment. Can return: RubyAlignments enumerator or NothingEnum * enumerator. */ rubyAlignment: RubyAlignments | NothingEnum; /** * If true, auto aligns ruby. Can return: Boolean or NothingEnum enumerator. */ rubyAutoAlign: boolean | NothingEnum; /** * If true, automatically scales ruby to the specified percent of parent text * size. For information on specifying a percent, see ruby parent scaling * percent. . Can return: Boolean or NothingEnum enumerator. */ rubyAutoScaling: boolean | NothingEnum; /** * If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to * fit one em. Can return: Boolean or NothingEnum enumerator. */ rubyAutoTcyAutoScale: boolean | NothingEnum; /** * The number of digits included in auto tcy (tate-chuu-yoko) in ruby. Can * return: Short Integer or NothingEnum enumerator. */ rubyAutoTcyDigits: number | NothingEnum; /** * If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. Can * return: Boolean or NothingEnum enumerator. */ rubyAutoTcyIncludeRoman: boolean | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby * characters. Can return: Swatch, String or NothingEnum enumerator. */ rubyFill: string | Swatch | NothingEnum; /** * The font applied to ruby characters. Can return: Font, String or NothingEnum * enumerator. */ rubyFont: Font | string | NothingEnum; /** * The size (in points) of ruby characters. Can return: Real or NothingEnum * enumerator. */ rubyFontSize: number | NothingEnum; /** * The font style of ruby characters. Can return: String or NothingEnum * enumerator. */ rubyFontStyle: string | NothingEnum; /** * If true, uses OpenType Pro fonts for ruby. Can return: Boolean or * NothingEnum enumerator. */ rubyOpenTypePro: boolean | NothingEnum; /** * If true, constrains ruby overhang to the specified amount. For information * on specifying an amount, see ruby parent overhang amount. . Can return: * Boolean or NothingEnum enumerator. */ rubyOverhang: boolean | NothingEnum; /** * The method of overprinting the ruby fill. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ rubyOverprintFill: AdornmentOverprint | NothingEnum; /** * The method of overprinting the ruby stroke. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ rubyOverprintStroke: AdornmentOverprint | NothingEnum; /** * The amount by which ruby characters can overhang the parent text. Can * return: RubyOverhang enumerator or NothingEnum enumerator. */ rubyParentOverhangAmount: RubyOverhang | NothingEnum; /** * The amount (as a percentage) to scale the parent text size to determine the * ruby text size. Can return: Real or NothingEnum enumerator. */ rubyParentScalingPercent: number | NothingEnum; /** * The ruby spacing relative to the parent text. . Can return: * RubyParentSpacing enumerator or NothingEnum enumerator. */ rubyParentSpacing: RubyParentSpacing | NothingEnum; /** * The position of ruby characters relative to the parent text. Can return: * RubyKentenPosition enumerator or NothingEnum enumerator. */ rubyPosition: RubyKentenPosition | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * ruby characters. Can return: Swatch, String or NothingEnum enumerator. */ rubyStroke: string | Swatch | NothingEnum; /** * The stroke tint (as a percentage) of ruby characters. Can return: Real or * NothingEnum enumerator. */ rubyStrokeTint: number | NothingEnum; /** * The tint (as a percentage) of the ruby fill color. (Range: 0 to 100). Can * return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ rubyTint: number | NothingEnum; /** * The ruby type. Can return: RubyTypes enumerator or NothingEnum enumerator. */ rubyType: RubyTypes | NothingEnum; /** * The stroke weight (in points) of ruby characters. Can return: Real or * NothingEnum enumerator. */ rubyWeight: number | NothingEnum; /** * The amount of horizontal space between ruby and parent characters. Can * return: Real or NothingEnum enumerator. */ rubyXOffset: number | NothingEnum; /** * The horizontal size of ruby characters, specified as a percent of the * original size. Can return: Real or NothingEnum enumerator. */ rubyXScale: number | NothingEnum; /** * The amount of vertical space between ruby and parent characters. Can return: * Real or NothingEnum enumerator. */ rubyYOffset: number | NothingEnum; /** * The vertical size of ruby characters, specified as a percent of the original * size. Can return: Real or NothingEnum enumerator. */ rubyYScale: number | NothingEnum; /** * The space between paragraphs using same style. Can return: Unit, Spacing * enumerator or NothingEnum enumerator. */ sameParaStyleSpacing: Spacing | number | NothingEnum; /** * If true, the line changes size when characters are scaled. . Can return: * Boolean or NothingEnum enumerator. */ scaleAffectsLineHeight: boolean | NothingEnum; /** * If true, applies shatai rotation. Can return: Boolean or NothingEnum * enumerator. */ shataiAdjustRotation: boolean | NothingEnum; /** * If true, adjusts shatai tsume. Can return: Boolean or NothingEnum * enumerator. */ shataiAdjustTsume: boolean | NothingEnum; /** * The shatai lens angle (in degrees). Can return: Real or NothingEnum * enumerator. */ shataiDegreeAngle: number | NothingEnum; /** * The amount (as a percentage) of shatai obliquing to apply. Can return: Real * or NothingEnum enumerator. */ shataiMagnification: number | NothingEnum; /** * The alignment to use for lines that contain a single word. Can return: * SingleWordJustification enumerator or NothingEnum enumerator. */ singleWordJustification: SingleWordJustification | NothingEnum; /** * The skew angle of the ChangeGrepPreference. Can return: Real or NothingEnum * enumerator. */ skew: number | NothingEnum; /** * The height of the paragraph space below. Can return: Unit or NothingEnum * enumerator. */ spaceAfter: number | NothingEnum; /** * The height of the paragraph space above. Can return: Unit or NothingEnum * enumerator. */ spaceBefore: number | NothingEnum; /** * The minimum space after a span or a split column. Can return: Unit or * NothingEnum enumerator. */ spanColumnMinSpaceAfter: number | NothingEnum; /** * The minimum space before a span or a split column. Can return: Unit or * NothingEnum enumerator. */ spanColumnMinSpaceBefore: number | NothingEnum; /** * Whether a paragraph should be a single column, span columns or split * columns. Can return: SpanColumnTypeOptions enumerator or NothingEnum * enumerator. */ spanColumnType: SpanColumnTypeOptions | NothingEnum; /** * The number of columns a paragraph spans or the number of split columns. Can * return: Short Integer (1 - 40), SpanColumnCountOptions enumerator or * NothingEnum enumerator. */ spanSplitColumnCount: number | SpanColumnCountOptions | NothingEnum; /** * The inside gutter if the paragraph splits columns. Can return: Unit or * NothingEnum enumerator. */ splitColumnInsideGutter: number | NothingEnum; /** * The outside gutter if the paragraph splits columns. Can return: Unit or * NothingEnum enumerator. */ splitColumnOutsideGutter: number | NothingEnum; /** * The location at which to start the paragraph. Can return: StartParagraph * enumerator or NothingEnum enumerator. */ startParagraph: StartParagraph | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the * strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator. */ strikeThroughColor: string | Swatch | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator. */ strikeThroughGapColor: string | Swatch | NothingEnum; /** * If true, the gap color of the strikethrough stroke will overprint. Note: * Valid when strike through type is not solid. Can return: Boolean or * NothingEnum enumerator. */ strikeThroughGapOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 * to 100) Note: Valid when strike through type is not solid. Can return: Real * or NothingEnum enumerator. * @remarks Range: 0 to 100 */ strikeThroughGapTint: number | NothingEnum; /** * The amount by which to offset the strikethrough stroke from the text * baseline. Can return: Unit or NothingEnum enumerator. */ strikeThroughOffset: number | NothingEnum; /** * If true, the strikethrough stroke will overprint. Can return: Boolean or * NothingEnum enumerator. */ strikeThroughOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100). * Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ strikeThroughTint: number | NothingEnum; /** * The stroke type of the strikethrough stroke. Can return: StrokeStyle, String * or NothingEnum enumerator. */ strikeThroughType: string | StrokeStyle | NothingEnum; /** * The stroke weight of the strikethrough stroke. Can return: Unit or * NothingEnum enumerator. */ strikeThroughWeight: number | NothingEnum; /** * If true, draws a strikethrough line through the text. Can return: Boolean or * NothingEnum enumerator. */ strikeThru: boolean | NothingEnum; /** * The stroke alignment applied to the text. Can return: TextStrokeAlign * enumerator or NothingEnum enumerator. */ strokeAlignment: TextStrokeAlign | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink), applied as a stroke color, * to search for or change to. Can return: String or NothingEnum enumerator. * Can also accept: Swatch. */ strokeColor: string | Swatch | NothingEnum; /** * The tint (as a percentage) of the stroke color of the ChangeGrepPreference. * (To specify a tint percentage, use a number in the range of 0 to 100; to use * the inherited or overridden value, use -1.). Can return: Real or NothingEnum * enumerator. * @remarks Range: 0 to 100 */ strokeTint: number | NothingEnum; /** * The stroke weight applied to the characters of the text. Can return: Unit or * NothingEnum enumerator. */ strokeWeight: number | NothingEnum; /** * If true, makes the character horizontal in vertical text. Can return: * Boolean or NothingEnum enumerator. */ tatechuyoko: boolean | NothingEnum; /** * The horizontal offset for horizontal characters in vertical text. Can * return: Real or NothingEnum enumerator. */ tatechuyokoXOffset: number | NothingEnum; /** * The vertical offset for horizontal characters in vertical text. Can return: * Real or NothingEnum enumerator. */ tatechuyokoYOffset: number | NothingEnum; /** * The amount by which to loosen or tighten a block of text, specified in * thousands of an em. Can return: Real or NothingEnum enumerator. */ tracking: number | NothingEnum; /** * The amount of space after each character. Can return: Real or NothingEnum * enumerator. */ trailingAki: number | NothingEnum; /** * If true, ideographic spaces will not wrap to the next line like text * characters. Can return: Boolean or NothingEnum enumerator. */ treatIdeographicSpaceAsSpace: boolean | NothingEnum; /** * The amount of horizontal character compression. Can return: Real or * NothingEnum enumerator. */ tsume: number | NothingEnum; /** * If true, underlines the text. Can return: Boolean or NothingEnum enumerator. */ underline: boolean | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the underline * stroke. . Can return: Swatch, String or NothingEnum enumerator. */ underlineColor: string | Swatch | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * underline stroke. Note: Valid when underline type is not solid. Can return: * Swatch, String or NothingEnum enumerator. */ underlineGapColor: string | Swatch | NothingEnum; /** * If true, the gap color of the underline stroke will overprint. Can return: * Boolean or NothingEnum enumerator. */ underlineGapOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the gap color of the underline stroke. (Range: * 0 to 100) Note: Valid when underline type is not solid. Can return: Real or * NothingEnum enumerator. * @remarks Range: 0 to 100 */ underlineGapTint: number | NothingEnum; /** * The amount by which to offset the underline from the text baseline. Can * return: Unit or NothingEnum enumerator. */ underlineOffset: number | NothingEnum; /** * If true, the underline stroke color will overprint. Can return: Boolean or * NothingEnum enumerator. */ underlineOverprint: boolean | NothingEnum; /** * The underline stroke tint (as a percentage). (Range: 0 to 100). Can return: * Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ underlineTint: number | NothingEnum; /** * The stroke type of the underline stroke. Can return: StrokeStyle, String or * NothingEnum enumerator. */ underlineType: string | StrokeStyle | NothingEnum; /** * The stroke weight of the underline stroke. Can return: Unit or NothingEnum * enumerator. */ underlineWeight: number | NothingEnum; /** * The vertical scaling applied to the ChangeGrepPreference. Can return: Real * or NothingEnum enumerator. */ verticalScale: number | NothingEnum; /** * If true, turns on warichu. Can return: Boolean or NothingEnum enumerator. */ warichu: boolean | NothingEnum; /** * The warichu alignment. Can return: WarichuAlignment enumerator or * NothingEnum enumerator. */ warichuAlignment: WarichuAlignment | NothingEnum; /** * The minimum number of characters allowed after a line break. . Can return: * Short Integer or NothingEnum enumerator. */ warichuCharsAfterBreak: number | NothingEnum; /** * The minimum number of characters allowed before a line break. Can return: * Short Integer or NothingEnum enumerator. */ warichuCharsBeforeBreak: number | NothingEnum; /** * The gap between lines of warichu characters. Can return: Real or NothingEnum * enumerator. */ warichuLineSpacing: number | NothingEnum; /** * The number of lines of warichu within a single normal line. Can return: * Short Integer or NothingEnum enumerator. */ warichuLines: number | NothingEnum; /** * The amount (as a percentage) to scale parent text size to determine warichu * size. Can return: Real or NothingEnum enumerator. */ warichuSize: number | NothingEnum; /** * The x (horizontal) offset for diacritic adjustment. Can return: Real or * NothingEnum enumerator. */ xOffsetDiacritic: number | NothingEnum; /** * The y (vertical) offset for diacritic adjustment. Can return: Real or * NothingEnum enumerator. */ yOffsetDiacritic: number | NothingEnum; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ChangeGrepPreference[]; /** * If true, Nth design axis of variable font is hidden. * @param nthAxisIndex Index of design axis. */ isNthDesignAxisHidden(nthAxisIndex: number): boolean; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Set Nth design axis of a variable font. * @param nthAxisIndex Index of design axis. * @param nthAxisValue Value of nth design axis. */ setNthDesignAxis(nthAxisIndex: number, nthAxisValue: number): void; /** * Generates a string which, if executed, will return the ChangeGrepPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Marking options for changed text. */ declare enum ChangeMarkings { /** * Does not mark changed text. */ NONE = 1852796517, /** * Outlines changed text. */ OUTLINE = 1869900910, /** * Uses a strikethrough to mark changed text. */ STRIKETHROUGH = 1699968114, /** * Underlines changed text. */ UNDERLINE_SINGLE = 1700097636, } /** * Change object preferences. */ declare class ChangeObjectPreference extends Preference { /** * The metadata property to use as source of actual text. Can return: Ordered * array containing namespacePrefix:String, propertyPath:String or NothingEnum * enumerator. */ actualMetadataProperty: any[] | string | NothingEnum; /** * The source type of actual text. Can return: SourceType enumerator or * NothingEnum enumerator. */ actualTextSourceType: SourceType | NothingEnum; /** * The metadata property to use as source of alternate text. Can return: * Ordered array containing namespacePrefix:String, propertyPath:String or * NothingEnum enumerator. */ altMetadataProperty: any[] | string | NothingEnum; /** * The source type of alternate text. Can return: SourceType enumerator or * NothingEnum enumerator. */ altTextSourceType: SourceType | NothingEnum; /** * The point in the anchored object to position. Can return: AnchorPoint * enumerator or NothingEnum enumerator. */ anchorPoint: AnchorPoint | NothingEnum; /** * The space above an above-line anchored object. Can return: Unit or * NothingEnum enumerator. */ anchorSpaceAbove: number | NothingEnum; /** * The horizontal (x) offset of the anchored object. Can return: Unit or * NothingEnum enumerator. */ anchorXoffset: number | NothingEnum; /** * The vertical (y) offset of the anchored object. Corresponds to the space * after property for above line positioning. Can return: Unit or NothingEnum * enumerator. */ anchorYoffset: number | NothingEnum; /** * The position of the anchored object relative to the anchor. Can return: * AnchorPosition enumerator or NothingEnum enumerator. */ anchoredPosition: AnchorPosition | NothingEnum; /** * The applied object style(s). Can return: String or NothingEnum enumerator. * Can also accept: ObjectStyle. */ appliedObjectStyles: ObjectStyle | string | NothingEnum; /** * The tag type of page item. Can return: TagType enumerator or NothingEnum * enumerator. */ applyTagType: TagType | NothingEnum; /** * If true, text wraps on the master spread apply to that spread only, and not * to any pages the master spread has been applied to. Can return: Boolean or * NothingEnum enumerator. */ applyToMasterPageOnly: boolean | NothingEnum; /** * The arrowhead alignment applied to the ChangeObjectPreference. Can return: * ArrowHeadAlignmentEnum enumerator or NothingEnum enumerator. */ arrowHeadAlignment: ArrowHeadAlignmentEnum | NothingEnum; /** * The reference point for auto sizing of text frame. Reference point is * automatically adjusted to the suitable value depending on the auto-sizing * type value. As an example, top left reference point becomes top center for * height only dimension. Can return: AutoSizingReferenceEnum enumerator or * NothingEnum enumerator. */ autoSizingReferencePoint: AutoSizingReferenceEnum | NothingEnum; /** * Auto-sizing type of text frame. Based on type, reference value is * automatically adjusted. For example, for height only type, top-left * reference point becomes top-center. Recommended to change auto-sizing type, * after setting other auto-sizing attributes. Can return: AutoSizingTypeEnum * enumerator or NothingEnum enumerator. */ autoSizingType: AutoSizingTypeEnum | NothingEnum; /** * The grid line color, specified either as an array of three doubles, each in * the range 0 to 255 and representing R, G, and B values, or as a UI color. * Can return: Array of 3 Reals (0 - 255) or UIColors enumerator or NothingEnum * enumerator. */ baselineFrameGridColor: (number[][] | NothingEnum | UIColors)[]; /** * The distance between grid lines. Can return: Unit (1 - 8640 points) or * NothingEnum enumerator. */ baselineFrameGridIncrement: number | NothingEnum; /** * The location (top of page, top margin, top of frame, or frame inset) on * which to base the custom baseline grid. Can return: * BaselineFrameGridRelativeOption enumerator or NothingEnum enumerator. */ baselineFrameGridRelativeOption: BaselineFrameGridRelativeOption | NothingEnum; /** * The amount in measurement units to crop the bottom edge of a graphic. Can * return: Unit or NothingEnum enumerator. */ bottomCrop: number | NothingEnum; /** * The shape to apply to the bottom left corner of rectangular shapes. Can * return: CornerOptions enumerator or NothingEnum enumerator. */ bottomLeftCornerOption: CornerOptions | NothingEnum; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes. Can return: Unit or NothingEnum * enumerator. */ bottomLeftCornerRadius: number | NothingEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. Can * return: CornerOptions enumerator or NothingEnum enumerator. */ bottomRightCornerOption: CornerOptions | NothingEnum; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes. Can return: Unit or NothingEnum * enumerator. */ bottomRightCornerRadius: number | NothingEnum; /** * Transparency settings for the content of the ChangeObjectPreference. Can * return: FindChangeContentTransparencySetting or NothingEnum enumerator. */ readonly contentTransparencySettings: FindChangeContentTransparencySetting | NothingEnum; /** * The contour type. Can return: ContourOptionsTypes enumerator or NothingEnum * enumerator. */ contourType: ContourOptionsTypes | NothingEnum; /** * The custom actual text entered by the user. Can return: String or * NothingEnum enumerator. */ customActualText: string | NothingEnum; /** * The custom alternate text entered by the user. Can return: String or * NothingEnum enumerator. */ customAltText: string | NothingEnum; /** * The end shape of an open path. Can return: EndCap enumerator or NothingEnum * enumerator. */ endCap: EndCap | NothingEnum; /** * The corner join applied to the ChangeObjectPreference. Can return: EndJoin * enumerator or NothingEnum enumerator. */ endJoin: EndJoin | NothingEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * ChangeObjectPreference. . Can return: Swatch or NothingEnum enumerator. Can * also accept: String. */ fillColor: string | Swatch | NothingEnum; /** * The percent of tint to use in the ChangeObjectPreference's fill color. (To * specify a tint percent, use a number in the range of 0 to 100; to use the * inherited or overridden value, use -1.). Can return: Real or NothingEnum * enumerator. * @remarks Range: 0 to 100 */ fillTint: number | NothingEnum; /** * Transparency settings for the fill applied to the ChangeObjectPreference. * Can return: FindChangeFillTransparencySetting or NothingEnum enumerator. */ readonly fillTransparencySettings: FindChangeFillTransparencySetting | NothingEnum; /** * The distance between the baseline of the text and the top inset of the text * frame or cell. Can return: FirstBaseline enumerator or NothingEnum * enumerator. */ firstBaselineOffset: FirstBaseline | NothingEnum; /** * The point with which to align the image empty when fitting in a frame. For * information, see frame fitting options. Can return: AnchorPoint enumerator * or NothingEnum enumerator. */ fittingAlignment: AnchorPoint | NothingEnum; /** * The frame fitting option to apply to placed or pasted content if the frame * is empty. Can be applied to a frame, object style, or document or to the * application. Can return: EmptyFrameFittingOptions enumerator or NothingEnum * enumerator. */ fittingOnEmptyFrame: EmptyFrameFittingOptions | NothingEnum; /** * If true, enable overrides to document footnote options. Can return: Boolean * or NothingEnum enumerator. */ footnotesEnableOverrides: boolean | NothingEnum; /** * Minimum Spacing Before First Footnote. Can return: Unit (0 - 8640 points) or * NothingEnum enumerator. */ footnotesMinimumSpacing: number | NothingEnum; /** * Space between footnotes. Can return: Unit (0 - 8640 points) or NothingEnum * enumerator. */ footnotesSpaceBetween: number | NothingEnum; /** * If true, enable straddling footnotes. Can return: Boolean or NothingEnum * enumerator. */ footnotesSpanAcrossColumns: boolean | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. Can * return: Swatch or NothingEnum enumerator. */ gapColor: Swatch | NothingEnum; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.). Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ gapTint: number | NothingEnum; /** * If true, generates interlaced GIFs. Note: Not valid when image conversion is * JPEG. Can return: Boolean or NothingEnum enumerator. */ gifOptionsInterlaced: boolean | NothingEnum; /** * The color palette for GIF conversion. Note: Not valid when image conversion * is JPEG. . Can return: GIFOptionsPalette enumerator or NothingEnum * enumerator. */ gifOptionsPalette: GIFOptionsPalette | NothingEnum; /** * The angle of a linear gradient applied to the fill of the * ChangeObjectPreference. (Range: -180 to 180). Can return: Real or * NothingEnum enumerator. */ gradientFillAngle: number | NothingEnum; /** * The angle of a linear gradient applied to the stroke of the * ChangeObjectPreference. (Range: -180 to 180). Can return: Real or * NothingEnum enumerator. */ gradientStrokeAngle: number | NothingEnum; /** * The horizontal reference point on the page. Valid only when anchored * position is custom. Can return: AnchoredRelativeTo enumerator or NothingEnum * enumerator. */ horizontalReferencePoint: AnchoredRelativeTo | NothingEnum; /** * If true, ignores text wrap settings for drawn or placed objects in the text * frame. . Can return: Boolean or NothingEnum enumerator. */ ignoreWrap: boolean | NothingEnum; /** * Alignment applied to images. Can return: ImageAlignmentType enumerator or * NothingEnum enumerator. */ imageAlignment: ImageAlignmentType | NothingEnum; /** * Allows user to select the image format for conversion. Can return: * ImageFormat enumerator or NothingEnum enumerator. */ imageConversionType: ImageFormat | NothingEnum; /** * The export resolution. Can return: ImageResolution enumerator or NothingEnum * enumerator. */ imageExportResolution: ImageResolution | NothingEnum; /** * Image page break settings to be used with objects. Can return: * ImagePageBreakType enumerator or NothingEnum enumerator. */ imagePageBreak: ImagePageBreakType | NothingEnum; /** * Space After applied to images. Can return: Real (0 - 8640) or NothingEnum * enumerator. */ imageSpaceAfter: number | NothingEnum; /** * Space Before applied to images. Can return: Real (0 - 8640) or NothingEnum * enumerator. */ imageSpaceBefore: number | NothingEnum; /** * If true, creates interior clipping paths within the surrounding clipping * path. Note: Valid only when clipping type is alpha channel or detect edges. * . Can return: Boolean or NothingEnum enumerator. */ includeInsideEdges: boolean | NothingEnum; /** * The amount to offset text from the edges of the text frame, specified either * as a single value applied uniformly to all sides of the text frame or as an * array of 4 values in the format [top inset, left inset, bottom inset, right * inset]. Can return: Unit (0 - 8640 points), Array of 4 Units (0 - 8640 * points) or NothingEnum enumerator. */ insetSpacing: (number[][] | number | NothingEnum)[]; /** * If true, inverts the text wrap. Can return: Boolean or NothingEnum * enumerator. */ inverse: boolean | NothingEnum; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The formatting method for converted JPEG images. Note: Not valid when image * conversion is GIF. Can return: JPEGOptionsFormat enumerator or NothingEnum * enumerator. */ jpegOptionsFormat: JPEGOptionsFormat | NothingEnum; /** * The quality of converted JPEG images. Note: Not valid when image conversion * is GIF. . Can return: JPEGOptionsQuality enumerator or NothingEnum * enumerator. */ jpegOptionsQuality: JPEGOptionsQuality | NothingEnum; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000). Can return: Real or NothingEnum enumerator. * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number | NothingEnum; /** * The amount in measurement units to crop the left edge of a graphic. Can * return: Unit or NothingEnum enumerator. */ leftCrop: number | NothingEnum; /** * The arrowhead applied to the start of the path. . Can return: ArrowHead * enumerator or NothingEnum enumerator. */ leftLineEnd: ArrowHead | NothingEnum; /** * If true, prevents manual positioning of the anchored object. Can return: * Boolean or NothingEnum enumerator. */ lockPosition: boolean | NothingEnum; /** * The minimum distance between the baseline of the text and the top inset of * the text frame or cell. Can return: Unit (0 - 8640 points) or NothingEnum * enumerator. */ minimumFirstBaselineOffset: number | NothingEnum; /** * The minimum height for auto-sizing of the text frame. Can return: Unit or * NothingEnum enumerator. */ minimumHeightForAutoSizing: number | NothingEnum; /** * The minimum width for auto-sizing of the text frame. Can return: Unit or * NothingEnum enumerator. */ minimumWidthForAutoSizing: number | NothingEnum; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. Can return: Real (1 - * 500) or NothingEnum enumerator. */ miterLimit: number | NothingEnum; /** * If true, the ChangeObjectPreference does not print. Can return: Boolean or * NothingEnum enumerator. */ nonprinting: boolean | NothingEnum; /** * If true, adjust the position of characters at the edges of the frame to * provide a better appearance. Can return: Boolean or NothingEnum enumerator. */ opticalMarginAlignment: boolean | NothingEnum; /** * The point size used as the basis for calculating optical margin alignment. * (Range: 0.1 to 1296). Can return: Unit (0.1 - 1296 points) or NothingEnum * enumerator. */ opticalMarginSize: number | NothingEnum; /** * If true, the ChangeObjectPreference's fill color overprints any underlying * objects. If false, the fill color knocks out the underlying colors. Can * return: Boolean or NothingEnum enumerator. */ overprintFill: boolean | NothingEnum; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. Can return: Boolean or NothingEnum * enumerator. */ overprintGap: boolean | NothingEnum; /** * If true, the ChangeObjectPreference's stroke color overprints any underlying * objects. If false, the stroke color knocks out the underlying colors. Can * return: Boolean or NothingEnum enumerator. */ overprintStroke: boolean | NothingEnum; /** * The parent of the ChangeObjectPreference (a Application). */ readonly parent: Application; /** * If true, pins the position of the anchored object within the text frame top * and bottom. Can return: Boolean or NothingEnum enumerator. */ pinPosition: boolean | NothingEnum; /** * The point in the referenced object relative to which to position the * anchored object. Notes: Valid only when anchored position is custom. Can * return: AnchorPoint enumerator or NothingEnum enumerator. */ positionReferencePoint: AnchorPoint | NothingEnum; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * Preserve Appearance from Layout. Can return: * PreserveAppearanceFromLayoutEnum enumerator or NothingEnum enumerator. */ preserveAppearanceFromLayout: PreserveAppearanceFromLayoutEnum | NothingEnum; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000). Can return: Real or NothingEnum enumerator. * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number | NothingEnum; /** * The amount in measurement units to crop the right edge of a graphic. Can * return: Unit or NothingEnum enumerator. */ rightCrop: number | NothingEnum; /** * The arrowhead applied to the end of the path. Can return: ArrowHead * enumerator or NothingEnum enumerator. */ rightLineEnd: ArrowHead | NothingEnum; /** * If true, the position of the anchored object is relative to the binding * spine of the page or spread. Can return: Boolean or NothingEnum enumerator. */ spineRelative: boolean | NothingEnum; /** * The amount to offset the baseline grid. Can return: Unit (0 - 8640 points) * or NothingEnum enumerator. */ startingOffsetForBaselineFrameGrid: number | NothingEnum; /** * The direction of the story. Can return: StoryDirectionOptions enumerator or * NothingEnum enumerator. */ storyDirection: StoryDirectionOptions | NothingEnum; /** * The stroke alignment applied to the ChangeObjectPreference. Can return: * StrokeAlignment enumerator or NothingEnum enumerator. */ strokeAlignment: StrokeAlignment | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the ChangeObjectPreference. Can return: Swatch or NothingEnum enumerator. * Can also accept: String. */ strokeColor: string | Swatch | NothingEnum; /** * The corner adjustment applied to the ChangeObjectPreference. Can return: * StrokeCornerAdjustment enumerator or NothingEnum enumerator. */ strokeCornerAdjustment: StrokeCornerAdjustment | NothingEnum; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. Can return: Array of Units or NothingEnum enumerator. */ strokeDashAndGap: (number[] | NothingEnum)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.). Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ strokeTint: number | NothingEnum; /** * Transparency settings for the stroke. Can return: * FindChangeStrokeTransparencySetting or NothingEnum enumerator. */ readonly strokeTransparencySettings: FindChangeStrokeTransparencySetting | NothingEnum; /** * The name of the stroke style to apply. Can return: StrokeStyle or * NothingEnum enumerator. Can also accept: String. */ strokeType: string | StrokeStyle | NothingEnum; /** * The weight (in points) to apply to the ChangeObjectPreference's stroke. Can * return: Unit or NothingEnum enumerator. */ strokeWeight: number | NothingEnum; /** * The number of columns in the text frame. Note: Depending on the value of use * fixed column width, the number of columns can change automatically when the * text frame size changes. Can return: Long Integer (1 - 40) or NothingEnum * enumerator. */ textColumnCount: number | NothingEnum; /** * The column width of the columns in the text frame. Can return: Unit (0 - * 8640 points) or NothingEnum enumerator. */ textColumnFixedWidth: number | NothingEnum; /** * The space between columns in the text frame. Can return: Unit (0 - 8640 * points) or NothingEnum enumerator. */ textColumnGutter: number | NothingEnum; /** * The text wrap mode. . Can return: TextWrapModes enumerator or NothingEnum * enumerator. */ textWrapMode: TextWrapModes | NothingEnum; /** * The minimum space between text and the edges of the wrapped object. Specify * four values in the format [top, left, bottom, right]. . Can return: Ordered * array containing top:Unit, left:Unit, bottom:Unit, right:Unit or NothingEnum * enumerator. */ textWrapOffset: any[] | number | NothingEnum; /** * Text wrap side options. Can return: TextWrapSideOptions enumerator or * NothingEnum enumerator. */ textWrapSide: TextWrapSideOptions | NothingEnum; /** * The amount in measurement units to crop the top edge of a graphic. Can * return: Unit or NothingEnum enumerator. */ topCrop: number | NothingEnum; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. Can return: * CornerOptions enumerator or NothingEnum enumerator. */ topLeftCornerOption: CornerOptions | NothingEnum; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes. Can * return: Unit or NothingEnum enumerator. */ topLeftCornerRadius: number | NothingEnum; /** * The shape to apply to the top right corner of rectangular shapes. Can * return: CornerOptions enumerator or NothingEnum enumerator. */ topRightCornerOption: CornerOptions | NothingEnum; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes. Can return: Unit or NothingEnum * enumerator. */ topRightCornerRadius: number | NothingEnum; /** * Transparency settings. Can return: FindChangeTransparencySetting or * NothingEnum enumerator. */ readonly transparencySettings: FindChangeTransparencySetting | NothingEnum; /** * If true, uses a custom baseline frame grid. Can return: Boolean or * NothingEnum enumerator. */ useCustomBaselineFrameGrid: boolean | NothingEnum; /** * If true, maintains column width when the text frame is resized. If false, * causes columns to resize when the text frame is resized. Note: When true, * resizing the frame can change the number of columns in the frame. Can * return: Boolean or NothingEnum enumerator. */ useFixedColumnWidth: boolean | NothingEnum; /** * If true, image page break settings will be used in objects. Can return: * Boolean or NothingEnum enumerator. */ useImagePageBreak: boolean | NothingEnum; /** * If true, minimum height value is used during the auto-sizing of text frame. * . Can return: Boolean or NothingEnum enumerator. */ useMinimumHeightForAutoSizing: boolean | NothingEnum; /** * If true, minimum width value is used during the auto-sizing of text frame. . * Can return: Boolean or NothingEnum enumerator. */ useMinimumWidthForAutoSizing: boolean | NothingEnum; /** * If true, line-breaks are not introduced after auto sizing. . Can return: * Boolean or NothingEnum enumerator. */ useNoLineBreaksForAutoSizing: boolean | NothingEnum; /** * If true, the text wrap path has been explicitly modified by the user. Can * return: Boolean or NothingEnum enumerator. */ readonly userModifiedWrap: boolean | NothingEnum; /** * The vertical alignment of the text content. . Can return: * VerticalJustification enumerator or NothingEnum enumerator. */ verticalJustification: VerticalJustification | NothingEnum; /** * The vertical reference point on the page. Valid when anchored position is * custom. Can return: VerticallyRelativeTo enumerator or NothingEnum * enumerator. */ verticalReferencePoint: VerticallyRelativeTo | NothingEnum; /** * The maximum amount of vertical space between two paragraphs. Note: Valid * only when vertical justification is justified; the specified amount is * applied in addition to the space before or space after values defined for * the paragraph. Can return: Unit (0 - 8640 points) or NothingEnum enumerator. */ verticalThreshold: number | NothingEnum; /** * Provides the actual text for the object */ actualText(): string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Provides the alternate text for the object */ altText(): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ChangeObjectPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * ChangeObjectPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Changed text color options. */ declare enum ChangeTextColorChoices { /** * The text color for changed text is the same as the text color defined in * track changes preferences. For information, see text color for added text, * text color for deleted text, or text color for moved text. */ CHANGE_USES_CHANGE_PREF_COLOR = 1700098147, /** * The text color for changed text is the same as the galley text color. */ CHANGE_USES_GALLEY_TEXT_COLOR = 1700095843, } /** * Change text preferences. */ declare class ChangeTextPreference extends Preference { /** * If true, words unassociated with a hyphenation dictionary can break to the * next line on any character. Can return: Boolean or NothingEnum enumerator. */ allowArbitraryHyphenation: boolean | NothingEnum; /** * The character style to search for or change to. Can return: String or * NothingEnum enumerator. Can also accept: CharacterStyle. */ appliedCharacterStyle: CharacterStyle | string | NothingEnum; /** * The conditions to search for or change to. Specify the "nothing" enum for * "Any" or an empty list for "[Unconditional]". Can return: Array of Strings * or NothingEnum enumerator. Can also accept: Array of Conditions. */ appliedConditions: (Conditions | string[] | NothingEnum)[]; /** * The font applied to the ChangeTextPreference, specified as either a font * object or the name of font family. Can return: Font, String or NothingEnum * enumerator. */ appliedFont: Font | string | NothingEnum; /** * The language to search for or change to. Can return: String or NothingEnum * enumerator. Can also accept: Language or LanguageWithVendors. */ appliedLanguage: Language | string | LanguageWithVendors | NothingEnum; /** * The list to be part of. Can return: NumberingList, String or NothingEnum * enumerator. */ appliedNumberingList: NumberingList | string | NothingEnum; /** * The paragraph style to search for or change to. Can return: String or * NothingEnum enumerator. Can also accept: ParagraphStyle. */ appliedParagraphStyle: ParagraphStyle | string | NothingEnum; /** * The percent of the type size to use for auto leading. (Range: 0 to 500). Can * return: Real or NothingEnum enumerator. * @remarks Range: 0 to 500 */ autoLeading: number | NothingEnum; /** * The number of half-width characters at or below which the characters * automatically run horizontally in vertical text. Can return: Short Integer * or NothingEnum enumerator. */ autoTcy: number | NothingEnum; /** * If true, auto tcy includes Roman characters. Can return: Boolean or * NothingEnum enumerator. */ autoTcyIncludeRoman: boolean | NothingEnum; /** * If true or set to an enumeration value, balances ragged lines. Note: Not * valid with a single-line text composer. Can return: Boolean, * BalanceLinesStyle enumerator or NothingEnum enumerator. */ balanceRaggedLines: BalanceLinesStyle | boolean | NothingEnum; /** * The baseline shift applied to the text. Can return: Unit or NothingEnum * enumerator. */ baselineShift: number | NothingEnum; /** * Bullet character. Can return: Bullet or NothingEnum enumerator. */ readonly bulletChar: Bullet | NothingEnum; /** * List type for bullets and numbering. Can return: ListType enumerator or * NothingEnum enumerator. */ bulletsAndNumberingListType: ListType | NothingEnum; /** * The character style to be used for the text after string. Can return: * CharacterStyle, String or NothingEnum enumerator. */ bulletsCharacterStyle: CharacterStyle | string | NothingEnum; /** * The text after string expression for bullets. Can return: String or * NothingEnum enumerator. */ bulletsTextAfter: string | NothingEnum; /** * If true, adds the double period (..), ellipse (...), and double hyphen (--) * to the selected kinsoku set. Note: Valid only when a kinsoku set is in * effect. Can return: Boolean or NothingEnum enumerator. */ bunriKinshi: boolean | NothingEnum; /** * The capitalization scheme. Can return: Capitalization enumerator or * NothingEnum enumerator. */ capitalization: Capitalization | NothingEnum; /** * The change case mode, changes the case of the found text. Can return: * ChangecaseMode enumerator or NothingEnum enumerator. */ changeCaseMode: ChangecaseMode | NothingEnum; /** * The change conditions mode, change either replaces applied conditions or * adds to applied conditions. Can return: ChangeConditionsModes enumerator or * NothingEnum enumerator. */ changeConditionsMode: ChangeConditionsModes | NothingEnum; /** * The replacement ChangeTextPreference. Can return: String or NothingEnum * enumerator. */ changeTo: string | NothingEnum; /** * The alignment of small characters to the largest character in the line. Can * return: CharacterAlignment enumerator or NothingEnum enumerator. */ characterAlignment: CharacterAlignment | NothingEnum; /** * The direction of the character. Can return: CharacterDirectionOptions * enumerator or NothingEnum enumerator. */ characterDirection: CharacterDirectionOptions | NothingEnum; /** * The rotation angle (in degrees) of individual characters. Note: The rotation * is counterclockwise. Can return: Real or NothingEnum enumerator. */ characterRotation: number | NothingEnum; /** * If true, uses grid tracking to track non-Roman characters in CJK grids. Can * return: Boolean or NothingEnum enumerator. */ cjkGridTracking: boolean | NothingEnum; /** * The text composer to use to compose the text. Can return: String or * NothingEnum enumerator. */ composer: string | NothingEnum; /** * Value of Design Axes. Can return: Array of Reals or NothingEnum enumerator. */ designAxes: (number[] | NothingEnum)[]; /** * Position of diacriticical characters. Can return: DiacriticPositionOptions * enumerator or NothingEnum enumerator. */ diacriticPosition: DiacriticPositionOptions | NothingEnum; /** * The digits type. Can return: DigitsTypeOptions enumerator or NothingEnum * enumerator. */ digitsType: DigitsTypeOptions | NothingEnum; /** * The number of characters to drop cap. Can return: Short Integer (0 - 150) or * NothingEnum enumerator. */ dropCapCharacters: number | NothingEnum; /** * The number of lines to drop cap. Can return: Short Integer (0 - 25) or * NothingEnum enumerator. */ dropCapLines: number | NothingEnum; /** * Details about the drop cap based on the glyph outlines. 1 = left side * bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid. * Can return: Long Integer or NothingEnum enumerator. */ dropcapDetail: number | NothingEnum; /** * The stroke join type applied to the characters of the text. Can return: * OutlineJoin enumerator or NothingEnum enumerator. */ endJoin: OutlineJoin | NothingEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink), applied as a fill color, * to search for or change to. Can return: String or NothingEnum enumerator. * Can also accept: Swatch. */ fillColor: string | Swatch | NothingEnum; /** * The tint (as a percentage) of the fill color of the ChangeTextPreference. * (To specify a tint percentage, use a number in the range of 0 to 100; to use * the inherited or overridden value, use -1.). Can return: Real or NothingEnum * enumerator. * @remarks Range: 0 to 100 */ fillTint: number | NothingEnum; /** * The amount to indent the first line. Can return: Unit or NothingEnum * enumerator. */ firstLineIndent: number | NothingEnum; /** * The name of the font style. Can return: String or NothingEnum enumerator. */ fontStyle: string | NothingEnum; /** * The glyph variant to substitute for standard glyphs. Can return: * AlternateGlyphForms enumerator or NothingEnum enumerator. */ glyphForm: AlternateGlyphForms | NothingEnum; /** * The angle of a linear gradient applied to the fill of the text. (Range: -180 * to 180). Can return: Real or NothingEnum enumerator. */ gradientFillAngle: number | NothingEnum; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the text. Can return: Real or NothingEnum enumerator. */ gradientFillLength: number | NothingEnum; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the text, in the format [x, y]. Can return: Array of 2 Units or * NothingEnum enumerator. */ gradientFillStart: (number[][] | NothingEnum)[]; /** * The angle of a linear gradient applied to the stroke of the text. (Range: * -180 to 180). Can return: Real or NothingEnum enumerator. */ gradientStrokeAngle: number | NothingEnum; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the text. Can return: Real or NothingEnum enumerator. */ gradientStrokeLength: number | NothingEnum; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the text, in the format [x, y]. Can return: Array of 2 Units or * NothingEnum enumerator. */ gradientStrokeStart: (number[][] | NothingEnum)[]; /** * The alignment to the frame grid or baseline grid. Can return: GridAlignment * enumerator or NothingEnum enumerator. */ gridAlignment: GridAlignment | NothingEnum; /** * The manual gyoudori setting. Can return: Short Integer or NothingEnum * enumerator. */ gridGyoudori: number | NothingEnum; /** * The horizontal scaling applied to the ChangeTextPreference. Can return: Real * or NothingEnum enumerator. */ horizontalScale: number | NothingEnum; /** * If true, allows the last word in a text column to be hyphenated. Can return: * Boolean or NothingEnum enumerator. */ hyphenateAcrossColumns: boolean | NothingEnum; /** * If true, allows hyphenation in the last word in a paragraph. Note: Valid * only when hyphenation is true. Can return: Boolean or NothingEnum * enumerator. */ hyphenateLastWord: boolean | NothingEnum; /** * If true, ignores optical edge alignment for the paragraph. Can return: * Boolean or NothingEnum enumerator. */ ignoreEdgeAlignment: boolean | NothingEnum; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The number of grid squares in which to arrange the text. . Can return: Short * Integer or NothingEnum enumerator. */ jidori: number | NothingEnum; /** * The paragraph alignment. Can return: Justification enumerator or NothingEnum * enumerator. */ justification: Justification | NothingEnum; /** * Use of Kashidas for justification. Can return: KashidasOptions enumerator or * NothingEnum enumerator. */ kashidas: KashidasOptions | NothingEnum; /** * If true, keeps all lines of the paragraph together. If false, allows * paragraphs to break across pages or columns. Can return: Boolean or * NothingEnum enumerator. */ keepAllLinesTogether: boolean | NothingEnum; /** * The minimum number of lines to keep together in a paragraph before allowing * a page break. Can return: Short Integer (1 - 50) or NothingEnum enumerator. */ keepFirstLines: number | NothingEnum; /** * The minimum number of lines to keep together in a paragraph after a page * break. Can return: Short Integer (1 - 50) or NothingEnum enumerator. */ keepLastLines: number | NothingEnum; /** * If true, keeps a specified number of lines together when the paragraph * breaks across columns or text frames. Can return: Boolean or NothingEnum * enumerator. */ keepLinesTogether: boolean | NothingEnum; /** * If true, forces the rule above the paragraph to remain in the frame bounds. * Note: Valid only when rule above is true. Can return: Boolean or NothingEnum * enumerator. */ keepRuleAboveInFrame: boolean | NothingEnum; /** * The minimum number of lines to keep with the next paragraph. Can return: * Short Integer (0 - 5) or NothingEnum enumerator. */ keepWithNext: number | NothingEnum; /** * If the first line in the paragraph should be kept with the last line of * previous paragraph. Can return: Boolean or NothingEnum enumerator. */ keepWithPrevious: boolean | NothingEnum; /** * The alignment of kenten characters relative to the parent characters. . Can * return: KentenAlignment enumerator or NothingEnum enumerator. */ kentenAlignment: KentenAlignment | NothingEnum; /** * The character set used for the custom kenten character. Note: Valid only * when kenten kind is custom. . Can return: KentenCharacterSet enumerator or * NothingEnum enumerator. */ kentenCharacterSet: KentenCharacterSet | NothingEnum; /** * The character used for kenten. Note: Valid only when kenten kind is custom. * Can return: String or NothingEnum enumerator. */ kentenCustomCharacter: string | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of * kenten characters. Can return: Swatch, String or NothingEnum enumerator. */ kentenFillColor: string | Swatch | NothingEnum; /** * The font to use for kenten characters. Can return: Font, String or * NothingEnum enumerator. */ kentenFont: Font | string | NothingEnum; /** * The size (in points) of kenten characters. Can return: Real or NothingEnum * enumerator. */ kentenFontSize: number | NothingEnum; /** * The font style of kenten characters. Can return: String or NothingEnum * enumerator. */ kentenFontStyle: string | NothingEnum; /** * The style of kenten characters. Can return: KentenCharacter enumerator or * NothingEnum enumerator. */ kentenKind: KentenCharacter | NothingEnum; /** * The method of overprinting the kenten fill. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ kentenOverprintFill: AdornmentOverprint | NothingEnum; /** * The method of overprinting the kenten stroke. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ kentenOverprintStroke: AdornmentOverprint | NothingEnum; /** * The distance between kenten characters and their parent characters. Can * return: Real or NothingEnum enumerator. */ kentenPlacement: number | NothingEnum; /** * The kenten position relative to the parent character. Can return: * RubyKentenPosition enumerator or NothingEnum enumerator. */ kentenPosition: RubyKentenPosition | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * kenten characters. Can return: Swatch, String or NothingEnum enumerator. */ kentenStrokeColor: string | Swatch | NothingEnum; /** * The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100). * Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ kentenStrokeTint: number | NothingEnum; /** * The fill tint (as a percentage) of kenten characters. (Range: 0 to 100). Can * return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ kentenTint: number | NothingEnum; /** * The stroke weight (in points) of kenten characters. Can return: Real or * NothingEnum enumerator. */ kentenWeight: number | NothingEnum; /** * The horizontal size of kenten characters as a percent of the original size. * Can return: Real or NothingEnum enumerator. */ kentenXScale: number | NothingEnum; /** * The vertical size of kenten charachers as a percent of the original size. . * Can return: Real or NothingEnum enumerator. */ kentenYScale: number | NothingEnum; /** * The type of pair kerning. Can return: String or NothingEnum enumerator. */ kerningMethod: string | NothingEnum; /** * The amount of space to add or remove between characters, specified in * thousands of an em. . Can return: Real or NothingEnum enumerator. */ kerningValue: number | NothingEnum; /** * The keyboard direction of the character. Can return: * CharacterDirectionOptions enumerator or NothingEnum enumerator. */ keyboardDirection: CharacterDirectionOptions | NothingEnum; /** * The type of hanging punctuation to allow. Note: Valid only when a kinsoku * set is in effect. Can return: KinsokuHangTypes enumerator or NothingEnum * enumerator. */ kinsokuHangType: KinsokuHangTypes | NothingEnum; /** * The kinsoku set that determines legitimate line breaks. Can return: * KinsokuTable, KinsokuSet enumerator, String or NothingEnum enumerator. */ kinsokuSet: KinsokuSet | KinsokuTable | string | NothingEnum; /** * The type of kinsoku processing for preventing kinsoku characters from * beginning or ending a line. Note: Valid only when a kinsoku set is defined. * Can return: KinsokuType enumerator or NothingEnum enumerator. */ kinsokuType: KinsokuType | NothingEnum; /** * The amount to indent the last line in the paragraph. Can return: Unit or * NothingEnum enumerator. */ lastLineIndent: number | NothingEnum; /** * The leading applied to the text. Can return: Unit, Leading enumerator or * NothingEnum enumerator. */ leading: Leading | number | NothingEnum; /** * The amount of space before each character. Can return: Real or NothingEnum * enumerator. */ leadingAki: number | NothingEnum; /** * The point from which leading is measured from line to line. Can return: * LeadingModel enumerator or NothingEnum enumerator. */ leadingModel: LeadingModel | NothingEnum; /** * The width of the left indent. Can return: Unit or NothingEnum enumerator. */ leftIndent: number | NothingEnum; /** * If true, replaces specific character combinations (e.g., fl, fi) with * ligature characters. Can return: Boolean or NothingEnum enumerator. */ ligatures: boolean | NothingEnum; /** * The XML tag applied to the element. Can return: String or NothingEnum * enumerator. Can also accept: XMLTag. */ markupTag: string | XMLTag | NothingEnum; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. Can return: Real (0 - * 1000) or NothingEnum enumerator. */ miterLimit: number | NothingEnum; /** * The mojikumi table. For information, see mojikumi table defaults. Can * return: MojikumiTable, String, MojikumiTableDefaults enumerator or * NothingEnum enumerator. */ mojikumi: MojikumiTable | MojikumiTableDefaults | string | NothingEnum; /** * If true, keeps the text on the same line. . Can return: Boolean or * NothingEnum enumerator. */ noBreak: boolean | NothingEnum; /** * If true, apply the numbering restart policy. Can return: Boolean or * NothingEnum enumerator. */ numberingApplyRestartPolicy: boolean | NothingEnum; /** * The character style to be used for the number string. Can return: * CharacterStyle, String or NothingEnum enumerator. */ numberingCharacterStyle: CharacterStyle | string | NothingEnum; /** * Continue the numbering at this level. Can return: Boolean or NothingEnum * enumerator. */ numberingContinue: boolean | NothingEnum; /** * The number string expression for numbering. Can return: String or * NothingEnum enumerator. */ numberingExpression: string | NothingEnum; /** * Numbering format options. Can return: NumberingStyle enumerator, String or * NothingEnum enumerator. */ numberingFormat: NumberingStyle | string | NothingEnum; /** * The level of the paragraph. Can return: Long Integer or NothingEnum * enumerator. */ numberingLevel: number | NothingEnum; /** * Numbering restart policies. Can return: NumberingRestartPolicy or * NothingEnum enumerator. */ readonly numberingRestartPolicies: NumberingRestartPolicy | NothingEnum; /** * Determines starting number in a numbered list. Can return: Long Integer or * NothingEnum enumerator. */ numberingStartAt: number | NothingEnum; /** * If true, uses contextual alternate forms in OpenType fonts. Can return: * Boolean or NothingEnum enumerator. */ otfContextualAlternate: boolean | NothingEnum; /** * If true, uses discretionary ligatures in OpenType fonts. Can return: Boolean * or NothingEnum enumerator. */ otfDiscretionaryLigature: boolean | NothingEnum; /** * The figure style in OpenType fonts. Can return: OTFFigureStyle enumerator or * NothingEnum enumerator. */ otfFigureStyle: OTFFigureStyle | NothingEnum; /** * If true, uses fractions in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfFraction: boolean | NothingEnum; /** * If true, switches hiragana fonts, which have different glyphs for horizontal * and vertical. . Can return: Boolean or NothingEnum enumerator. */ otfHVKana: boolean | NothingEnum; /** * If true, use historical forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfHistorical: boolean | NothingEnum; /** * If true, use alternate justification forms in OpenType fonts. Can return: * Boolean or NothingEnum enumerator. */ otfJustificationAlternate: boolean | NothingEnum; /** * If true, uses localized forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfLocale: boolean | NothingEnum; /** * If true, uses mark positioning in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfMark: boolean | NothingEnum; /** * If true, uses ordinals in OpenType fonts. Can return: Boolean or NothingEnum * enumerator. */ otfOrdinal: boolean | NothingEnum; /** * If true, use overlapping swash forms in OpenType fonts. Can return: Boolean * or NothingEnum enumerator. */ otfOverlapSwash: boolean | NothingEnum; /** * If true, kerns according to proportional CJK metrics in OpenType fonts. Can * return: Boolean or NothingEnum enumerator. */ otfProportionalMetrics: boolean | NothingEnum; /** * If true, applies italics to half-width alphanumerics. . Can return: Boolean * or NothingEnum enumerator. */ otfRomanItalics: boolean | NothingEnum; /** * If true, use a slashed zeroes in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfSlashedZero: boolean | NothingEnum; /** * If true, use stretched alternate forms in OpenType fonts. Can return: * Boolean or NothingEnum enumerator. */ otfStretchedAlternate: boolean | NothingEnum; /** * If true, use stylistic alternate forms in OpenType fonts. Can return: * Boolean or NothingEnum enumerator. */ otfStylisticAlternate: boolean | NothingEnum; /** * The stylistic sets to use in OpenType fonts. Can return: Long Integer or * NothingEnum enumerator. */ otfStylisticSets: number | NothingEnum; /** * If true, uses swash forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfSwash: boolean | NothingEnum; /** * If true, uses titling forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfTitling: boolean | NothingEnum; /** * If true, the fill color of the characters will overprint. Can return: * Boolean or NothingEnum enumerator. */ overprintFill: boolean | NothingEnum; /** * If true, the stroke of the characters will overprint. Can return: Boolean or * NothingEnum enumerator. */ overprintStroke: boolean | NothingEnum; /** * Paragraph direction. Can return: ParagraphDirectionOptions enumerator or * NothingEnum enumerator. */ paragraphDirection: ParagraphDirectionOptions | NothingEnum; /** * If true, the gyoudori mode applies to the entire paragraph. If false, the * gyoudori mode applies to each line in the paragraph. Can return: Boolean or * NothingEnum enumerator. */ paragraphGyoudori: boolean | NothingEnum; /** * Paragraph justification. Can return: ParagraphJustificationOptions * enumerator or NothingEnum enumerator. */ paragraphJustification: ParagraphJustificationOptions | NothingEnum; /** * Paragraph kashida width. 0 is none, 1 is short, 2 is medium, 3 is long. Can * return: Real or NothingEnum enumerator. */ paragraphKashidaWidth: number | NothingEnum; /** * The parent of the ChangeTextPreference (a Application). */ readonly parent: Application; /** * The text size. Can return: Unit or NothingEnum enumerator. */ pointSize: number | NothingEnum; /** * The text position relative to the baseline. Can return: Position enumerator * or NothingEnum enumerator. */ position: Position | NothingEnum; /** * The OpenType positional form. Can return: PositionalForms enumerator or * NothingEnum enumerator. */ positionalForm: PositionalForms | NothingEnum; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, disallows line breaks in numbers. If false, lines can break between * digits in multi-digit numbers. Can return: Boolean or NothingEnum * enumerator. */ rensuuji: boolean | NothingEnum; /** * The width of the right indent. Can return: Unit or NothingEnum enumerator. */ rightIndent: number | NothingEnum; /** * If true, rotates Roman characters in vertical text. Can return: Boolean or * NothingEnum enumerator. */ rotateSingleByteCharacters: boolean | NothingEnum; /** * The ruby alignment. Can return: RubyAlignments enumerator or NothingEnum * enumerator. */ rubyAlignment: RubyAlignments | NothingEnum; /** * If true, auto aligns ruby. Can return: Boolean or NothingEnum enumerator. */ rubyAutoAlign: boolean | NothingEnum; /** * If true, automatically scales ruby to the specified percent of parent text * size. For information on specifying a percent, see ruby parent scaling * percent. . Can return: Boolean or NothingEnum enumerator. */ rubyAutoScaling: boolean | NothingEnum; /** * If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to * fit one em. Can return: Boolean or NothingEnum enumerator. */ rubyAutoTcyAutoScale: boolean | NothingEnum; /** * The number of digits included in auto tcy (tate-chuu-yoko) in ruby. Can * return: Short Integer or NothingEnum enumerator. */ rubyAutoTcyDigits: number | NothingEnum; /** * If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. Can * return: Boolean or NothingEnum enumerator. */ rubyAutoTcyIncludeRoman: boolean | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby * characters. Can return: Swatch, String or NothingEnum enumerator. */ rubyFill: string | Swatch | NothingEnum; /** * The font applied to ruby characters. Can return: Font, String or NothingEnum * enumerator. */ rubyFont: Font | string | NothingEnum; /** * The size (in points) of ruby characters. Can return: Real or NothingEnum * enumerator. */ rubyFontSize: number | NothingEnum; /** * The font style of ruby characters. Can return: String or NothingEnum * enumerator. */ rubyFontStyle: string | NothingEnum; /** * If true, uses OpenType Pro fonts for ruby. Can return: Boolean or * NothingEnum enumerator. */ rubyOpenTypePro: boolean | NothingEnum; /** * If true, constrains ruby overhang to the specified amount. For information * on specifying an amount, see ruby parent overhang amount. . Can return: * Boolean or NothingEnum enumerator. */ rubyOverhang: boolean | NothingEnum; /** * The method of overprinting the ruby fill. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ rubyOverprintFill: AdornmentOverprint | NothingEnum; /** * The method of overprinting the ruby stroke. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ rubyOverprintStroke: AdornmentOverprint | NothingEnum; /** * The amount by which ruby characters can overhang the parent text. Can * return: RubyOverhang enumerator or NothingEnum enumerator. */ rubyParentOverhangAmount: RubyOverhang | NothingEnum; /** * The amount (as a percentage) to scale the parent text size to determine the * ruby text size. Can return: Real or NothingEnum enumerator. */ rubyParentScalingPercent: number | NothingEnum; /** * The ruby spacing relative to the parent text. . Can return: * RubyParentSpacing enumerator or NothingEnum enumerator. */ rubyParentSpacing: RubyParentSpacing | NothingEnum; /** * The position of ruby characters relative to the parent text. Can return: * RubyKentenPosition enumerator or NothingEnum enumerator. */ rubyPosition: RubyKentenPosition | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * ruby characters. Can return: Swatch, String or NothingEnum enumerator. */ rubyStroke: string | Swatch | NothingEnum; /** * The stroke tint (as a percentage) of ruby characters. Can return: Real or * NothingEnum enumerator. */ rubyStrokeTint: number | NothingEnum; /** * The tint (as a percentage) of the ruby fill color. (Range: 0 to 100). Can * return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ rubyTint: number | NothingEnum; /** * The ruby type. Can return: RubyTypes enumerator or NothingEnum enumerator. */ rubyType: RubyTypes | NothingEnum; /** * The stroke weight (in points) of ruby characters. Can return: Real or * NothingEnum enumerator. */ rubyWeight: number | NothingEnum; /** * The amount of horizontal space between ruby and parent characters. Can * return: Real or NothingEnum enumerator. */ rubyXOffset: number | NothingEnum; /** * The horizontal size of ruby characters, specified as a percent of the * original size. Can return: Real or NothingEnum enumerator. */ rubyXScale: number | NothingEnum; /** * The amount of vertical space between ruby and parent characters. Can return: * Real or NothingEnum enumerator. */ rubyYOffset: number | NothingEnum; /** * The vertical size of ruby characters, specified as a percent of the original * size. Can return: Real or NothingEnum enumerator. */ rubyYScale: number | NothingEnum; /** * The space between paragraphs using same style. Can return: Unit, Spacing * enumerator or NothingEnum enumerator. */ sameParaStyleSpacing: Spacing | number | NothingEnum; /** * If true, the line changes size when characters are scaled. . Can return: * Boolean or NothingEnum enumerator. */ scaleAffectsLineHeight: boolean | NothingEnum; /** * If true, applies shatai rotation. Can return: Boolean or NothingEnum * enumerator. */ shataiAdjustRotation: boolean | NothingEnum; /** * If true, adjusts shatai tsume. Can return: Boolean or NothingEnum * enumerator. */ shataiAdjustTsume: boolean | NothingEnum; /** * The shatai lens angle (in degrees). Can return: Real or NothingEnum * enumerator. */ shataiDegreeAngle: number | NothingEnum; /** * The amount (as a percentage) of shatai obliquing to apply. Can return: Real * or NothingEnum enumerator. */ shataiMagnification: number | NothingEnum; /** * The alignment to use for lines that contain a single word. Can return: * SingleWordJustification enumerator or NothingEnum enumerator. */ singleWordJustification: SingleWordJustification | NothingEnum; /** * The skew angle of the ChangeTextPreference. Can return: Real or NothingEnum * enumerator. */ skew: number | NothingEnum; /** * The height of the paragraph space below. Can return: Unit or NothingEnum * enumerator. */ spaceAfter: number | NothingEnum; /** * The height of the paragraph space above. Can return: Unit or NothingEnum * enumerator. */ spaceBefore: number | NothingEnum; /** * The minimum space after a span or a split column. Can return: Unit or * NothingEnum enumerator. */ spanColumnMinSpaceAfter: number | NothingEnum; /** * The minimum space before a span or a split column. Can return: Unit or * NothingEnum enumerator. */ spanColumnMinSpaceBefore: number | NothingEnum; /** * Whether a paragraph should be a single column, span columns or split * columns. Can return: SpanColumnTypeOptions enumerator or NothingEnum * enumerator. */ spanColumnType: SpanColumnTypeOptions | NothingEnum; /** * The number of columns a paragraph spans or the number of split columns. Can * return: Short Integer (1 - 40), SpanColumnCountOptions enumerator or * NothingEnum enumerator. */ spanSplitColumnCount: number | SpanColumnCountOptions | NothingEnum; /** * The inside gutter if the paragraph splits columns. Can return: Unit or * NothingEnum enumerator. */ splitColumnInsideGutter: number | NothingEnum; /** * The outside gutter if the paragraph splits columns. Can return: Unit or * NothingEnum enumerator. */ splitColumnOutsideGutter: number | NothingEnum; /** * The location at which to start the paragraph. Can return: StartParagraph * enumerator or NothingEnum enumerator. */ startParagraph: StartParagraph | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the * strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator. */ strikeThroughColor: string | Swatch | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator. */ strikeThroughGapColor: string | Swatch | NothingEnum; /** * If true, the gap color of the strikethrough stroke will overprint. Note: * Valid when strike through type is not solid. Can return: Boolean or * NothingEnum enumerator. */ strikeThroughGapOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 * to 100) Note: Valid when strike through type is not solid. Can return: Real * or NothingEnum enumerator. * @remarks Range: 0 to 100 */ strikeThroughGapTint: number | NothingEnum; /** * The amount by which to offset the strikethrough stroke from the text * baseline. Can return: Unit or NothingEnum enumerator. */ strikeThroughOffset: number | NothingEnum; /** * If true, the strikethrough stroke will overprint. Can return: Boolean or * NothingEnum enumerator. */ strikeThroughOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100). * Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ strikeThroughTint: number | NothingEnum; /** * The stroke type of the strikethrough stroke. Can return: StrokeStyle, String * or NothingEnum enumerator. */ strikeThroughType: string | StrokeStyle | NothingEnum; /** * The stroke weight of the strikethrough stroke. Can return: Unit or * NothingEnum enumerator. */ strikeThroughWeight: number | NothingEnum; /** * If true, draws a strikethrough line through the text. Can return: Boolean or * NothingEnum enumerator. */ strikeThru: boolean | NothingEnum; /** * The stroke alignment applied to the text. Can return: TextStrokeAlign * enumerator or NothingEnum enumerator. */ strokeAlignment: TextStrokeAlign | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink), applied as a stroke color, * to search for or change to. Can return: String or NothingEnum enumerator. * Can also accept: Swatch. */ strokeColor: string | Swatch | NothingEnum; /** * The tint (as a percentage) of the stroke color of the ChangeTextPreference. * (To specify a tint percentage, use a number in the range of 0 to 100; to use * the inherited or overridden value, use -1.). Can return: Real or NothingEnum * enumerator. * @remarks Range: 0 to 100 */ strokeTint: number | NothingEnum; /** * The stroke weight applied to the characters of the text. Can return: Unit or * NothingEnum enumerator. */ strokeWeight: number | NothingEnum; /** * If true, makes the character horizontal in vertical text. Can return: * Boolean or NothingEnum enumerator. */ tatechuyoko: boolean | NothingEnum; /** * The horizontal offset for horizontal characters in vertical text. Can * return: Real or NothingEnum enumerator. */ tatechuyokoXOffset: number | NothingEnum; /** * The vertical offset for horizontal characters in vertical text. Can return: * Real or NothingEnum enumerator. */ tatechuyokoYOffset: number | NothingEnum; /** * The amount by which to loosen or tighten a block of text, specified in * thousands of an em. Can return: Real or NothingEnum enumerator. */ tracking: number | NothingEnum; /** * The amount of space after each character. Can return: Real or NothingEnum * enumerator. */ trailingAki: number | NothingEnum; /** * If true, ideographic spaces will not wrap to the next line like text * characters. Can return: Boolean or NothingEnum enumerator. */ treatIdeographicSpaceAsSpace: boolean | NothingEnum; /** * The amount of horizontal character compression. Can return: Real or * NothingEnum enumerator. */ tsume: number | NothingEnum; /** * If true, underlines the text. Can return: Boolean or NothingEnum enumerator. */ underline: boolean | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the underline * stroke. . Can return: Swatch, String or NothingEnum enumerator. */ underlineColor: string | Swatch | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * underline stroke. Note: Valid when underline type is not solid. Can return: * Swatch, String or NothingEnum enumerator. */ underlineGapColor: string | Swatch | NothingEnum; /** * If true, the gap color of the underline stroke will overprint. Can return: * Boolean or NothingEnum enumerator. */ underlineGapOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the gap color of the underline stroke. (Range: * 0 to 100) Note: Valid when underline type is not solid. Can return: Real or * NothingEnum enumerator. * @remarks Range: 0 to 100 */ underlineGapTint: number | NothingEnum; /** * The amount by which to offset the underline from the text baseline. Can * return: Unit or NothingEnum enumerator. */ underlineOffset: number | NothingEnum; /** * If true, the underline stroke color will overprint. Can return: Boolean or * NothingEnum enumerator. */ underlineOverprint: boolean | NothingEnum; /** * The underline stroke tint (as a percentage). (Range: 0 to 100). Can return: * Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ underlineTint: number | NothingEnum; /** * The stroke type of the underline stroke. Can return: StrokeStyle, String or * NothingEnum enumerator. */ underlineType: string | StrokeStyle | NothingEnum; /** * The stroke weight of the underline stroke. Can return: Unit or NothingEnum * enumerator. */ underlineWeight: number | NothingEnum; /** * The vertical scaling applied to the ChangeTextPreference. Can return: Real * or NothingEnum enumerator. */ verticalScale: number | NothingEnum; /** * If true, turns on warichu. Can return: Boolean or NothingEnum enumerator. */ warichu: boolean | NothingEnum; /** * The warichu alignment. Can return: WarichuAlignment enumerator or * NothingEnum enumerator. */ warichuAlignment: WarichuAlignment | NothingEnum; /** * The minimum number of characters allowed after a line break. . Can return: * Short Integer or NothingEnum enumerator. */ warichuCharsAfterBreak: number | NothingEnum; /** * The minimum number of characters allowed before a line break. Can return: * Short Integer or NothingEnum enumerator. */ warichuCharsBeforeBreak: number | NothingEnum; /** * The gap between lines of warichu characters. Can return: Real or NothingEnum * enumerator. */ warichuLineSpacing: number | NothingEnum; /** * The number of lines of warichu within a single normal line. Can return: * Short Integer or NothingEnum enumerator. */ warichuLines: number | NothingEnum; /** * The amount (as a percentage) to scale parent text size to determine warichu * size. Can return: Real or NothingEnum enumerator. */ warichuSize: number | NothingEnum; /** * The x (horizontal) offset for diacritic adjustment. Can return: Real or * NothingEnum enumerator. */ xOffsetDiacritic: number | NothingEnum; /** * The y (vertical) offset for diacritic adjustment. Can return: Real or * NothingEnum enumerator. */ yOffsetDiacritic: number | NothingEnum; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ChangeTextPreference[]; /** * If true, Nth design axis of variable font is hidden. * @param nthAxisIndex Index of design axis. */ isNthDesignAxisHidden(nthAxisIndex: number): boolean; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Set Nth design axis of a variable font. * @param nthAxisIndex Index of design axis. * @param nthAxisValue Value of nth design axis. */ setNthDesignAxis(nthAxisIndex: number, nthAxisValue: number): void; /** * Generates a string which, if executed, will return the ChangeTextPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Change transliterate preferences. */ declare class ChangeTransliteratePreference extends Preference { /** * If true, words unassociated with a hyphenation dictionary can break to the * next line on any character. Can return: Boolean or NothingEnum enumerator. */ allowArbitraryHyphenation: boolean | NothingEnum; /** * The character style to search for or change to. Can return: String or * NothingEnum enumerator. Can also accept: CharacterStyle. */ appliedCharacterStyle: CharacterStyle | string | NothingEnum; /** * The font applied to the ChangeTransliteratePreference, specified as either a * font object or the name of font family. Can return: Font, String or * NothingEnum enumerator. */ appliedFont: Font | string | NothingEnum; /** * The language to search for or change to. Can return: String or NothingEnum * enumerator. Can also accept: Language or LanguageWithVendors. */ appliedLanguage: Language | string | LanguageWithVendors | NothingEnum; /** * The list to be part of. Can return: NumberingList, String or NothingEnum * enumerator. */ appliedNumberingList: NumberingList | string | NothingEnum; /** * The paragraph style to search for or change to. Can return: String or * NothingEnum enumerator. Can also accept: ParagraphStyle. */ appliedParagraphStyle: ParagraphStyle | string | NothingEnum; /** * The percent of the type size to use for auto leading. (Range: 0 to 500). Can * return: Real or NothingEnum enumerator. * @remarks Range: 0 to 500 */ autoLeading: number | NothingEnum; /** * The number of half-width characters at or below which the characters * automatically run horizontally in vertical text. Can return: Short Integer * or NothingEnum enumerator. */ autoTcy: number | NothingEnum; /** * If true, auto tcy includes Roman characters. Can return: Boolean or * NothingEnum enumerator. */ autoTcyIncludeRoman: boolean | NothingEnum; /** * If true or set to an enumeration value, balances ragged lines. Note: Not * valid with a single-line text composer. Can return: Boolean, * BalanceLinesStyle enumerator or NothingEnum enumerator. */ balanceRaggedLines: BalanceLinesStyle | boolean | NothingEnum; /** * The baseline shift applied to the text. Can return: Unit or NothingEnum * enumerator. */ baselineShift: number | NothingEnum; /** * Bullet character. Can return: Bullet or NothingEnum enumerator. */ readonly bulletChar: Bullet | NothingEnum; /** * The alignment of the bullet character. Can return: ListAlignment enumerator * or NothingEnum enumerator. */ bulletsAlignment: ListAlignment | NothingEnum; /** * List type for bullets and numbering. Can return: ListType enumerator or * NothingEnum enumerator. */ bulletsAndNumberingListType: ListType | NothingEnum; /** * The character style to be used for the text after string. Can return: * CharacterStyle, String or NothingEnum enumerator. */ bulletsCharacterStyle: CharacterStyle | string | NothingEnum; /** * The text after string expression for bullets. Can return: String or * NothingEnum enumerator. */ bulletsTextAfter: string | NothingEnum; /** * If true, adds the double period (..), ellipse (...), and double hyphen (--) * to the selected kinsoku set. Note: Valid only when a kinsoku set is in * effect. Can return: Boolean or NothingEnum enumerator. */ bunriKinshi: boolean | NothingEnum; /** * The capitalization scheme. Can return: Capitalization enumerator or * NothingEnum enumerator. */ capitalization: Capitalization | NothingEnum; /** * The character type to which to change the found character type. Can return: * FindChangeTransliterateCharacterTypes enumerator or NothingEnum enumerator. */ changeCharacterType: FindChangeTransliterateCharacterTypes | NothingEnum; /** * The alignment of small characters to the largest character in the line. Can * return: CharacterAlignment enumerator or NothingEnum enumerator. */ characterAlignment: CharacterAlignment | NothingEnum; /** * The rotation angle (in degrees) of individual characters. Note: The rotation * is counterclockwise. Can return: Real or NothingEnum enumerator. */ characterRotation: number | NothingEnum; /** * If true, uses grid tracking to track non-Roman characters in CJK grids. Can * return: Boolean or NothingEnum enumerator. */ cjkGridTracking: boolean | NothingEnum; /** * The text composer to use to compose the text. Can return: String or * NothingEnum enumerator. */ composer: string | NothingEnum; /** * Value of Design Axes. Can return: Array of Reals or NothingEnum enumerator. */ designAxes: (number[] | NothingEnum)[]; /** * The number of characters to drop cap. Can return: Short Integer (0 - 150) or * NothingEnum enumerator. */ dropCapCharacters: number | NothingEnum; /** * The number of lines to drop cap. Can return: Short Integer (0 - 25) or * NothingEnum enumerator. */ dropCapLines: number | NothingEnum; /** * Details about the drop cap based on the glyph outlines. 1 = left side * bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid. * Can return: Long Integer or NothingEnum enumerator. */ dropcapDetail: number | NothingEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink), applied as a fill color, * to search for or change to. Can return: String or NothingEnum enumerator. * Can also accept: Swatch. */ fillColor: string | Swatch | NothingEnum; /** * The tint (as a percentage) of the fill color of the * ChangeTransliteratePreference. (To specify a tint percentage, use a number * in the range of 0 to 100; to use the inherited or overridden value, use * -1.). Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ fillTint: number | NothingEnum; /** * The amount to indent the first line. Can return: Unit or NothingEnum * enumerator. */ firstLineIndent: number | NothingEnum; /** * The name of the font style. Can return: String or NothingEnum enumerator. */ fontStyle: string | NothingEnum; /** * The glyph variant to substitute for standard glyphs. Can return: * AlternateGlyphForms enumerator or NothingEnum enumerator. */ glyphForm: AlternateGlyphForms | NothingEnum; /** * The angle of a linear gradient applied to the fill of the text. (Range: -180 * to 180). Can return: Real or NothingEnum enumerator. */ gradientFillAngle: number | NothingEnum; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the text. Can return: Real or NothingEnum enumerator. */ gradientFillLength: number | NothingEnum; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the text, in the format [x, y]. Can return: Array of 2 Units or * NothingEnum enumerator. */ gradientFillStart: (number[][] | NothingEnum)[]; /** * The angle of a linear gradient applied to the stroke of the text. (Range: * -180 to 180). Can return: Real or NothingEnum enumerator. */ gradientStrokeAngle: number | NothingEnum; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the text. Can return: Real or NothingEnum enumerator. */ gradientStrokeLength: number | NothingEnum; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the text, in the format [x, y]. Can return: Array of 2 Units or * NothingEnum enumerator. */ gradientStrokeStart: (number[][] | NothingEnum)[]; /** * The alignment to the frame grid or baseline grid. Can return: GridAlignment * enumerator or NothingEnum enumerator. */ gridAlignment: GridAlignment | NothingEnum; /** * The manual gyoudori setting. Can return: Short Integer or NothingEnum * enumerator. */ gridGyoudori: number | NothingEnum; /** * The horizontal scaling applied to the ChangeTransliteratePreference. Can * return: Real or NothingEnum enumerator. */ horizontalScale: number | NothingEnum; /** * If true, allows the last word in a text column to be hyphenated. Can return: * Boolean or NothingEnum enumerator. */ hyphenateAcrossColumns: boolean | NothingEnum; /** * If true, allows hyphenation in the last word in a paragraph. Note: Valid * only when hyphenation is true. Can return: Boolean or NothingEnum * enumerator. */ hyphenateLastWord: boolean | NothingEnum; /** * If true, ignores optical edge alignment for the paragraph. Can return: * Boolean or NothingEnum enumerator. */ ignoreEdgeAlignment: boolean | NothingEnum; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The number of grid squares in which to arrange the text. . Can return: Short * Integer or NothingEnum enumerator. */ jidori: number | NothingEnum; /** * The paragraph alignment. Can return: Justification enumerator or NothingEnum * enumerator. */ justification: Justification | NothingEnum; /** * If true, keeps all lines of the paragraph together. If false, allows * paragraphs to break across pages or columns. Can return: Boolean or * NothingEnum enumerator. */ keepAllLinesTogether: boolean | NothingEnum; /** * The minimum number of lines to keep together in a paragraph before allowing * a page break. Can return: Short Integer (1 - 50) or NothingEnum enumerator. */ keepFirstLines: number | NothingEnum; /** * The minimum number of lines to keep together in a paragraph after a page * break. Can return: Short Integer (1 - 50) or NothingEnum enumerator. */ keepLastLines: number | NothingEnum; /** * If true, keeps a specified number of lines together when the paragraph * breaks across columns or text frames. Can return: Boolean or NothingEnum * enumerator. */ keepLinesTogether: boolean | NothingEnum; /** * If true, forces the rule above the paragraph to remain in the frame bounds. * Note: Valid only when rule above is true. Can return: Boolean or NothingEnum * enumerator. */ keepRuleAboveInFrame: boolean | NothingEnum; /** * The minimum number of lines to keep with the next paragraph. Can return: * Short Integer (0 - 5) or NothingEnum enumerator. */ keepWithNext: number | NothingEnum; /** * The alignment of kenten characters relative to the parent characters. . Can * return: KentenAlignment enumerator or NothingEnum enumerator. */ kentenAlignment: KentenAlignment | NothingEnum; /** * The character set used for the custom kenten character. Note: Valid only * when kenten kind is custom. . Can return: KentenCharacterSet enumerator or * NothingEnum enumerator. */ kentenCharacterSet: KentenCharacterSet | NothingEnum; /** * The character used for kenten. Note: Valid only when kenten kind is custom. * Can return: String or NothingEnum enumerator. */ kentenCustomCharacter: string | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of * kenten characters. Can return: Swatch, String or NothingEnum enumerator. */ kentenFillColor: string | Swatch | NothingEnum; /** * The font to use for kenten characters. Can return: Font, String or * NothingEnum enumerator. */ kentenFont: Font | string | NothingEnum; /** * The size (in points) of kenten characters. Can return: Real or NothingEnum * enumerator. */ kentenFontSize: number | NothingEnum; /** * The font style of kenten characters. Can return: String or NothingEnum * enumerator. */ kentenFontStyle: string | NothingEnum; /** * The style of kenten characters. Can return: KentenCharacter enumerator or * NothingEnum enumerator. */ kentenKind: KentenCharacter | NothingEnum; /** * The method of overprinting the kenten fill. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ kentenOverprintFill: AdornmentOverprint | NothingEnum; /** * The method of overprinting the kenten stroke. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ kentenOverprintStroke: AdornmentOverprint | NothingEnum; /** * The distance between kenten characters and their parent characters. Can * return: Real or NothingEnum enumerator. */ kentenPlacement: number | NothingEnum; /** * The kenten position relative to the parent character. Can return: * RubyKentenPosition enumerator or NothingEnum enumerator. */ kentenPosition: RubyKentenPosition | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * kenten characters. Can return: Swatch, String or NothingEnum enumerator. */ kentenStrokeColor: string | Swatch | NothingEnum; /** * The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100). * Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ kentenStrokeTint: number | NothingEnum; /** * The fill tint (as a percentage) of kenten characters. (Range: 0 to 100). Can * return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ kentenTint: number | NothingEnum; /** * The stroke weight (in points) of kenten characters. Can return: Real or * NothingEnum enumerator. */ kentenWeight: number | NothingEnum; /** * The horizontal size of kenten characters as a percent of the original size. * Can return: Real or NothingEnum enumerator. */ kentenXScale: number | NothingEnum; /** * The vertical size of kenten charachers as a percent of the original size. . * Can return: Real or NothingEnum enumerator. */ kentenYScale: number | NothingEnum; /** * The type of pair kerning. Can return: String or NothingEnum enumerator. */ kerningMethod: string | NothingEnum; /** * The amount of space to add or remove between characters, specified in * thousands of an em. . Can return: Real or NothingEnum enumerator. */ kerningValue: number | NothingEnum; /** * The type of hanging punctuation to allow. Note: Valid only when a kinsoku * set is in effect. Can return: KinsokuHangTypes enumerator or NothingEnum * enumerator. */ kinsokuHangType: KinsokuHangTypes | NothingEnum; /** * The kinsoku set that determines legitimate line breaks. Can return: * KinsokuTable, KinsokuSet enumerator, String or NothingEnum enumerator. */ kinsokuSet: KinsokuSet | KinsokuTable | string | NothingEnum; /** * The type of kinsoku processing for preventing kinsoku characters from * beginning or ending a line. Note: Valid only when a kinsoku set is defined. * Can return: KinsokuType enumerator or NothingEnum enumerator. */ kinsokuType: KinsokuType | NothingEnum; /** * The amount to indent the last line in the paragraph. Can return: Unit or * NothingEnum enumerator. */ lastLineIndent: number | NothingEnum; /** * The leading applied to the text. Can return: Unit, Leading enumerator or * NothingEnum enumerator. */ leading: Leading | number | NothingEnum; /** * The amount of space before each character. Can return: Real or NothingEnum * enumerator. */ leadingAki: number | NothingEnum; /** * The point from which leading is measured from line to line. Can return: * LeadingModel enumerator or NothingEnum enumerator. */ leadingModel: LeadingModel | NothingEnum; /** * The width of the left indent. Can return: Unit or NothingEnum enumerator. */ leftIndent: number | NothingEnum; /** * If true, replaces specific character combinations (e.g., fl, fi) with * ligature characters. Can return: Boolean or NothingEnum enumerator. */ ligatures: boolean | NothingEnum; /** * The XML tag applied to the element. Can return: String or NothingEnum * enumerator. Can also accept: XMLTag. */ markupTag: string | XMLTag | NothingEnum; /** * The mojikumi table. For information, see mojikumi table defaults. Can * return: MojikumiTable, String, MojikumiTableDefaults enumerator or * NothingEnum enumerator. */ mojikumi: MojikumiTable | MojikumiTableDefaults | string | NothingEnum; /** * If true, keeps the text on the same line. . Can return: Boolean or * NothingEnum enumerator. */ noBreak: boolean | NothingEnum; /** * The alignment of the number. Can return: ListAlignment enumerator or * NothingEnum enumerator. */ numberingAlignment: ListAlignment | NothingEnum; /** * If true, apply the numbering restart policy. Can return: Boolean or * NothingEnum enumerator. */ numberingApplyRestartPolicy: boolean | NothingEnum; /** * The character style to be used for the number string. Can return: * CharacterStyle, String or NothingEnum enumerator. */ numberingCharacterStyle: CharacterStyle | string | NothingEnum; /** * Continue the numbering at this level. Can return: Boolean or NothingEnum * enumerator. */ numberingContinue: boolean | NothingEnum; /** * The number string expression for numbering. Can return: String or * NothingEnum enumerator. */ numberingExpression: string | NothingEnum; /** * Numbering format options. Can return: NumberingStyle enumerator, String or * NothingEnum enumerator. */ numberingFormat: NumberingStyle | string | NothingEnum; /** * The level of the paragraph. Can return: Long Integer or NothingEnum * enumerator. */ numberingLevel: number | NothingEnum; /** * Determines starting number in a numbered list. Can return: Long Integer or * NothingEnum enumerator. */ numberingStartAt: number | NothingEnum; /** * If true, uses contextual alternate forms in OpenType fonts. Can return: * Boolean or NothingEnum enumerator. */ otfContextualAlternate: boolean | NothingEnum; /** * If true, uses discretionary ligatures in OpenType fonts. Can return: Boolean * or NothingEnum enumerator. */ otfDiscretionaryLigature: boolean | NothingEnum; /** * The figure style in OpenType fonts. Can return: OTFFigureStyle enumerator or * NothingEnum enumerator. */ otfFigureStyle: OTFFigureStyle | NothingEnum; /** * If true, uses fractions in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfFraction: boolean | NothingEnum; /** * If true, switches hiragana fonts, which have different glyphs for horizontal * and vertical. . Can return: Boolean or NothingEnum enumerator. */ otfHVKana: boolean | NothingEnum; /** * If true, use historical forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfHistorical: boolean | NothingEnum; /** * If true, uses localized forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfLocale: boolean | NothingEnum; /** * If true, uses mark positioning in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfMark: boolean | NothingEnum; /** * If true, uses ordinals in OpenType fonts. Can return: Boolean or NothingEnum * enumerator. */ otfOrdinal: boolean | NothingEnum; /** * If true, kerns according to proportional CJK metrics in OpenType fonts. Can * return: Boolean or NothingEnum enumerator. */ otfProportionalMetrics: boolean | NothingEnum; /** * If true, applies italics to half-width alphanumerics. . Can return: Boolean * or NothingEnum enumerator. */ otfRomanItalics: boolean | NothingEnum; /** * If true, use a slashed zeroes in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfSlashedZero: boolean | NothingEnum; /** * The stylistic sets to use in OpenType fonts. Can return: Long Integer or * NothingEnum enumerator. */ otfStylisticSets: number | NothingEnum; /** * If true, uses swash forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfSwash: boolean | NothingEnum; /** * If true, uses titling forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfTitling: boolean | NothingEnum; /** * If true, the fill color of the characters will overprint. Can return: * Boolean or NothingEnum enumerator. */ overprintFill: boolean | NothingEnum; /** * If true, the stroke of the characters will overprint. Can return: Boolean or * NothingEnum enumerator. */ overprintStroke: boolean | NothingEnum; /** * If true, the gyoudori mode applies to the entire paragraph. If false, the * gyoudori mode applies to each line in the paragraph. Can return: Boolean or * NothingEnum enumerator. */ paragraphGyoudori: boolean | NothingEnum; /** * The parent of the ChangeTransliteratePreference (a Application). */ readonly parent: Application; /** * The text size. Can return: Unit or NothingEnum enumerator. */ pointSize: number | NothingEnum; /** * The text position relative to the baseline. Can return: Position enumerator * or NothingEnum enumerator. */ position: Position | NothingEnum; /** * The OpenType positional form. Can return: PositionalForms enumerator or * NothingEnum enumerator. */ positionalForm: PositionalForms | NothingEnum; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, disallows line breaks in numbers. If false, lines can break between * digits in multi-digit numbers. Can return: Boolean or NothingEnum * enumerator. */ rensuuji: boolean | NothingEnum; /** * The width of the right indent. Can return: Unit or NothingEnum enumerator. */ rightIndent: number | NothingEnum; /** * If true, rotates Roman characters in vertical text. Can return: Boolean or * NothingEnum enumerator. */ rotateSingleByteCharacters: boolean | NothingEnum; /** * The ruby alignment. Can return: RubyAlignments enumerator or NothingEnum * enumerator. */ rubyAlignment: RubyAlignments | NothingEnum; /** * If true, auto aligns ruby. Can return: Boolean or NothingEnum enumerator. */ rubyAutoAlign: boolean | NothingEnum; /** * If true, automatically scales ruby to the specified percent of parent text * size. For information on specifying a percent, see ruby parent scaling * percent. . Can return: Boolean or NothingEnum enumerator. */ rubyAutoScaling: boolean | NothingEnum; /** * If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to * fit one em. Can return: Boolean or NothingEnum enumerator. */ rubyAutoTcyAutoScale: boolean | NothingEnum; /** * The number of digits included in auto tcy (tate-chuu-yoko) in ruby. Can * return: Short Integer or NothingEnum enumerator. */ rubyAutoTcyDigits: number | NothingEnum; /** * If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. Can * return: Boolean or NothingEnum enumerator. */ rubyAutoTcyIncludeRoman: boolean | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby * characters. Can return: Swatch, String or NothingEnum enumerator. */ rubyFill: string | Swatch | NothingEnum; /** * The font applied to ruby characters. Can return: Font, String or NothingEnum * enumerator. */ rubyFont: Font | string | NothingEnum; /** * The size (in points) of ruby characters. Can return: Real or NothingEnum * enumerator. */ rubyFontSize: number | NothingEnum; /** * The font style of ruby characters. Can return: String or NothingEnum * enumerator. */ rubyFontStyle: string | NothingEnum; /** * If true, uses OpenType Pro fonts for ruby. Can return: Boolean or * NothingEnum enumerator. */ rubyOpenTypePro: boolean | NothingEnum; /** * If true, constrains ruby overhang to the specified amount. For information * on specifying an amount, see ruby parent overhang amount. . Can return: * Boolean or NothingEnum enumerator. */ rubyOverhang: boolean | NothingEnum; /** * The method of overprinting the ruby fill. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ rubyOverprintFill: AdornmentOverprint | NothingEnum; /** * The method of overprinting the ruby stroke. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ rubyOverprintStroke: AdornmentOverprint | NothingEnum; /** * The amount by which ruby characters can overhang the parent text. Can * return: RubyOverhang enumerator or NothingEnum enumerator. */ rubyParentOverhangAmount: RubyOverhang | NothingEnum; /** * The amount (as a percentage) to scale the parent text size to determine the * ruby text size. Can return: Real or NothingEnum enumerator. */ rubyParentScalingPercent: number | NothingEnum; /** * The ruby spacing relative to the parent text. . Can return: * RubyParentSpacing enumerator or NothingEnum enumerator. */ rubyParentSpacing: RubyParentSpacing | NothingEnum; /** * The position of ruby characters relative to the parent text. Can return: * RubyKentenPosition enumerator or NothingEnum enumerator. */ rubyPosition: RubyKentenPosition | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * ruby characters. Can return: Swatch, String or NothingEnum enumerator. */ rubyStroke: string | Swatch | NothingEnum; /** * The stroke tint (as a percentage) of ruby characters. Can return: Real or * NothingEnum enumerator. */ rubyStrokeTint: number | NothingEnum; /** * The tint (as a percentage) of the ruby fill color. (Range: 0 to 100). Can * return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ rubyTint: number | NothingEnum; /** * The ruby type. Can return: RubyTypes enumerator or NothingEnum enumerator. */ rubyType: RubyTypes | NothingEnum; /** * The stroke weight (in points) of ruby characters. Can return: Real or * NothingEnum enumerator. */ rubyWeight: number | NothingEnum; /** * The amount of horizontal space between ruby and parent characters. Can * return: Real or NothingEnum enumerator. */ rubyXOffset: number | NothingEnum; /** * The horizontal size of ruby characters, specified as a percent of the * original size. Can return: Real or NothingEnum enumerator. */ rubyXScale: number | NothingEnum; /** * The amount of vertical space between ruby and parent characters. Can return: * Real or NothingEnum enumerator. */ rubyYOffset: number | NothingEnum; /** * The vertical size of ruby characters, specified as a percent of the original * size. Can return: Real or NothingEnum enumerator. */ rubyYScale: number | NothingEnum; /** * The space between paragraphs using same style. Can return: Unit, Spacing * enumerator or NothingEnum enumerator. */ sameParaStyleSpacing: Spacing | number | NothingEnum; /** * If true, the line changes size when characters are scaled. . Can return: * Boolean or NothingEnum enumerator. */ scaleAffectsLineHeight: boolean | NothingEnum; /** * If true, applies shatai rotation. Can return: Boolean or NothingEnum * enumerator. */ shataiAdjustRotation: boolean | NothingEnum; /** * If true, adjusts shatai tsume. Can return: Boolean or NothingEnum * enumerator. */ shataiAdjustTsume: boolean | NothingEnum; /** * The shatai lens angle (in degrees). Can return: Real or NothingEnum * enumerator. */ shataiDegreeAngle: number | NothingEnum; /** * The amount (as a percentage) of shatai obliquing to apply. Can return: Real * or NothingEnum enumerator. */ shataiMagnification: number | NothingEnum; /** * The alignment to use for lines that contain a single word. Can return: * SingleWordJustification enumerator or NothingEnum enumerator. */ singleWordJustification: SingleWordJustification | NothingEnum; /** * The skew angle of the ChangeTransliteratePreference. Can return: Real or * NothingEnum enumerator. */ skew: number | NothingEnum; /** * The height of the paragraph space below. Can return: Unit or NothingEnum * enumerator. */ spaceAfter: number | NothingEnum; /** * The height of the paragraph space above. Can return: Unit or NothingEnum * enumerator. */ spaceBefore: number | NothingEnum; /** * The location at which to start the paragraph. Can return: StartParagraph * enumerator or NothingEnum enumerator. */ startParagraph: StartParagraph | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the * strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator. */ strikeThroughColor: string | Swatch | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator. */ strikeThroughGapColor: string | Swatch | NothingEnum; /** * If true, the gap color of the strikethrough stroke will overprint. Note: * Valid when strike through type is not solid. Can return: Boolean or * NothingEnum enumerator. */ strikeThroughGapOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 * to 100) Note: Valid when strike through type is not solid. Can return: Real * or NothingEnum enumerator. * @remarks Range: 0 to 100 */ strikeThroughGapTint: number | NothingEnum; /** * The amount by which to offset the strikethrough stroke from the text * baseline. Can return: Unit or NothingEnum enumerator. */ strikeThroughOffset: number | NothingEnum; /** * If true, the strikethrough stroke will overprint. Can return: Boolean or * NothingEnum enumerator. */ strikeThroughOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100). * Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ strikeThroughTint: number | NothingEnum; /** * The stroke type of the strikethrough stroke. Can return: StrokeStyle, String * or NothingEnum enumerator. */ strikeThroughType: string | StrokeStyle | NothingEnum; /** * The stroke weight of the strikethrough stroke. Can return: Unit or * NothingEnum enumerator. */ strikeThroughWeight: number | NothingEnum; /** * If true, draws a strikethrough line through the text. Can return: Boolean or * NothingEnum enumerator. */ strikeThru: boolean | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink), applied as a stroke color, * to search for or change to. Can return: String or NothingEnum enumerator. * Can also accept: Swatch. */ strokeColor: string | Swatch | NothingEnum; /** * The tint (as a percentage) of the stroke color of the * ChangeTransliteratePreference. (To specify a tint percentage, use a number * in the range of 0 to 100; to use the inherited or overridden value, use * -1.). Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ strokeTint: number | NothingEnum; /** * The stroke weight applied to the characters of the text. Can return: Unit or * NothingEnum enumerator. */ strokeWeight: number | NothingEnum; /** * If true, makes the character horizontal in vertical text. Can return: * Boolean or NothingEnum enumerator. */ tatechuyoko: boolean | NothingEnum; /** * The horizontal offset for horizontal characters in vertical text. Can * return: Real or NothingEnum enumerator. */ tatechuyokoXOffset: number | NothingEnum; /** * The vertical offset for horizontal characters in vertical text. Can return: * Real or NothingEnum enumerator. */ tatechuyokoYOffset: number | NothingEnum; /** * The amount by which to loosen or tighten a block of text, specified in * thousands of an em. Can return: Real or NothingEnum enumerator. */ tracking: number | NothingEnum; /** * The amount of space after each character. Can return: Real or NothingEnum * enumerator. */ trailingAki: number | NothingEnum; /** * If true, ideographic spaces will not wrap to the next line like text * characters. Can return: Boolean or NothingEnum enumerator. */ treatIdeographicSpaceAsSpace: boolean | NothingEnum; /** * The amount of horizontal character compression. Can return: Real or * NothingEnum enumerator. */ tsume: number | NothingEnum; /** * If true, underlines the text. Can return: Boolean or NothingEnum enumerator. */ underline: boolean | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the underline * stroke. . Can return: Swatch, String or NothingEnum enumerator. */ underlineColor: string | Swatch | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * underline stroke. Note: Valid when underline type is not solid. Can return: * Swatch, String or NothingEnum enumerator. */ underlineGapColor: string | Swatch | NothingEnum; /** * If true, the gap color of the underline stroke will overprint. Can return: * Boolean or NothingEnum enumerator. */ underlineGapOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the gap color of the underline stroke. (Range: * 0 to 100) Note: Valid when underline type is not solid. Can return: Real or * NothingEnum enumerator. * @remarks Range: 0 to 100 */ underlineGapTint: number | NothingEnum; /** * The amount by which to offset the underline from the text baseline. Can * return: Unit or NothingEnum enumerator. */ underlineOffset: number | NothingEnum; /** * If true, the underline stroke color will overprint. Can return: Boolean or * NothingEnum enumerator. */ underlineOverprint: boolean | NothingEnum; /** * The underline stroke tint (as a percentage). (Range: 0 to 100). Can return: * Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ underlineTint: number | NothingEnum; /** * The stroke type of the underline stroke. Can return: StrokeStyle, String or * NothingEnum enumerator. */ underlineType: string | StrokeStyle | NothingEnum; /** * The stroke weight of the underline stroke. Can return: Unit or NothingEnum * enumerator. */ underlineWeight: number | NothingEnum; /** * The vertical scaling applied to the ChangeTransliteratePreference. Can * return: Real or NothingEnum enumerator. */ verticalScale: number | NothingEnum; /** * If true, turns on warichu. Can return: Boolean or NothingEnum enumerator. */ warichu: boolean | NothingEnum; /** * The warichu alignment. Can return: WarichuAlignment enumerator or * NothingEnum enumerator. */ warichuAlignment: WarichuAlignment | NothingEnum; /** * The minimum number of characters allowed after a line break. . Can return: * Short Integer or NothingEnum enumerator. */ warichuCharsAfterBreak: number | NothingEnum; /** * The minimum number of characters allowed before a line break. Can return: * Short Integer or NothingEnum enumerator. */ warichuCharsBeforeBreak: number | NothingEnum; /** * The gap between lines of warichu characters. Can return: Real or NothingEnum * enumerator. */ warichuLineSpacing: number | NothingEnum; /** * The number of lines of warichu within a single normal line. Can return: * Short Integer or NothingEnum enumerator. */ warichuLines: number | NothingEnum; /** * The amount (as a percentage) to scale parent text size to determine warichu * size. Can return: Real or NothingEnum enumerator. */ warichuSize: number | NothingEnum; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ChangeTransliteratePreference[]; /** * If true, Nth design axis of variable font is hidden. * @param nthAxisIndex Index of design axis. */ isNthDesignAxisHidden(nthAxisIndex: number): boolean; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Set Nth design axis of a variable font. * @param nthAxisIndex Index of design axis. * @param nthAxisValue Value of nth design axis. */ setNthDesignAxis(nthAxisIndex: number, nthAxisValue: number): void; /** * Generates a string which, if executed, will return the * ChangeTransliteratePreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Change type options. */ declare enum ChangeTypes { /** * Deleted text. */ DELETED_TEXT = 1799644524, /** * Added text. */ INSERTED_TEXT = 1799974515, /** * Moved text. */ MOVED_TEXT = 1800236918, } /** * Change bar location options. */ declare enum ChangebarLocations { /** * Change bars are in the left margin. */ LEFT_ALIGN = 1818584692, /** * Change bars are in the right margin. */ RIGHT_ALIGN = 1919379572, } /** * Text case options. */ declare enum ChangecaseMode { /** * Makes all letters lowercase. */ LOWERCASE = 1667460195, /** * Makes the first letter of each sentence uppercase. */ SENTENCECASE = 1667461987, /** * Makes the first letter of each word uppercase. */ TITLECASE = 1667462243, /** * Makes all letters uppercase. */ UPPERCASE = 1667462499, } /** * A collection of changes. */ declare class Changes { /** Returns the Change with the specified index or name. */ [index: number]: Change; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Change in the collection. */ anyItem(): Change; /** * Displays the number of elements in the Change. */ count(): number; /** * Returns every Change in the collection. */ everyItem(): Change; /** * Returns the first Change in the collection. */ firstItem(): Change; /** * Returns the Change with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Change; /** * Returns the Changes within the specified range. * @param from The Change, index, or name at the beginning of the range. Can accept: Change, Long Integer or String. * @param to The Change, index, or name at the end of the range. Can accept: Change, Long Integer or String. */ itemByRange(from: Change | number | string, to: Change | number | string): Change[]; /** * Returns the last Change in the collection. */ lastItem(): Change; /** * Returns the middle Change in the collection. */ middleItem(): Change; /** * Returns the Change whose index follows the specified Change in the * collection. * @param obj The Change whose index comes before the desired Change. */ nextItem(obj: Change): Change; /** * Returns the Change with the index previous to the specified index. * @param obj The index of the Change that follows the desired Change. */ previousItem(obj: Change): Change; /** * Generates a string which, if executed, will return the Change. */ toSource(): string; } /** * Chapter numbering preferences. */ declare class ChapterNumberPreference extends Preference { /** * Chapter number. */ chapterNumber: number; /** * Chapter number formatting options. Can return: NumberingStyle enumerator or * String. */ chapterNumberFormat: NumberingStyle | string; /** * Source for generating the chapter number. */ chapterNumberSource: ChapterNumberSources; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the ChapterNumberPreference (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ChapterNumberPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * ChapterNumberPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Chapter number sources. */ declare enum ChapterNumberSources { /** * Continue chapter number from previous document. */ CONTINUE_FROM_PREVIOUS_DOCUMENT = 1668178800, /** * Chapter number same as previous document. */ SAME_AS_PREVIOUS_DOCUMENT = 1668182896, /** * User-defined chapter number. */ USER_DEFINED = 1668183396, } /** * The preferences for a chapter number variable. */ declare class ChapterNumberVariablePreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The format for the variable. */ format: VariableNumberingStyles; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the ChapterNumberVariablePreference (a TextVariable). */ readonly parent: TextVariable; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The text that follows the value of the variable. (Limit: 128 characters) */ textAfter: string; /** * The text that precedes the value of the variable. (Limit: 128 characters) */ textBefore: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ChapterNumberVariablePreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * ChapterNumberVariablePreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A char style mapping. */ declare class CharStyleMapping { /** * The destination style name property. */ destinationStyleName: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the CharStyleMapping within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The type of the mapping rule. */ mappingRuleType: MapType; /** * The parent of the CharStyleMapping (a Application, Document, Story or * XmlStory). */ readonly parent: Document | Story | Application | XmlStory; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The source style name property. */ sourceStyleName: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): CharStyleMapping[]; /** * deletes a style mapping. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the CharStyleMapping. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of char style mappings. */ declare class CharStyleMappings { /** Returns the CharStyleMapping with the specified index or name. */ [index: number]: CharStyleMapping; /** * The number of objects in the collection. */ readonly length: number; /** * Adds a style mapping. * @param sourceStyleName The source style name. * @param destinationStyleName The destination style name. * @param mappingRuleType The mapping type * @param withProperties Initial values for properties of the new CharStyleMapping (Optional) */ add(sourceStyleName: string, destinationStyleName: string, mappingRuleType: MapType, withProperties?: Object): CharStyleMapping; /** * Returns any CharStyleMapping in the collection. */ anyItem(): CharStyleMapping; /** * Displays the number of elements in the CharStyleMapping. */ count(): number; /** * Returns every CharStyleMapping in the collection. */ everyItem(): CharStyleMapping; /** * Returns the first CharStyleMapping in the collection. */ firstItem(): CharStyleMapping; /** * Returns the CharStyleMapping with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): CharStyleMapping; /** * Returns the CharStyleMappings within the specified range. * @param from The CharStyleMapping, index, or name at the beginning of the range. Can accept: CharStyleMapping, Long Integer or String. * @param to The CharStyleMapping, index, or name at the end of the range. Can accept: CharStyleMapping, Long Integer or String. */ itemByRange(from: CharStyleMapping | number | string, to: CharStyleMapping | number | string): CharStyleMapping[]; /** * Returns the last CharStyleMapping in the collection. */ lastItem(): CharStyleMapping; /** * Returns the middle CharStyleMapping in the collection. */ middleItem(): CharStyleMapping; /** * Returns the CharStyleMapping whose index follows the specified * CharStyleMapping in the collection. * @param obj The CharStyleMapping whose index comes before the desired CharStyleMapping. */ nextItem(obj: CharStyleMapping): CharStyleMapping; /** * Returns the CharStyleMapping with the index previous to the specified index. * @param obj The index of the CharStyleMapping that follows the desired CharStyleMapping. */ previousItem(obj: CharStyleMapping): CharStyleMapping; /** * Generates a string which, if executed, will return the CharStyleMapping. */ toSource(): string; } /** * A text character. */ declare class Character extends Text { /** * If true, aligns the baseline of the text to the baseline grid. */ alignToBaseline: boolean; /** * Lists all graphics contained by the Character. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the Character. */ readonly allPageItems: PageItem[]; /** * If true, words unassociated with a hyphenation dictionary can break to the * next line on any character. */ allowArbitraryHyphenation: boolean; /** * The character style applied to the text. Can also accept: String. */ appliedCharacterStyle: CharacterStyle | string; /** * The applied conditions. */ appliedConditions: Condition[]; /** * The font applied to the Character, specified as either a font object or the * name of font family. Can return: Font or String. */ appliedFont: Font | string; /** * The language of the text. Can return: LanguageWithVendors or Language. Can * also accept: String. */ appliedLanguage: LanguageWithVendors | string | Language; /** * The applied character styles dictated by nested styles. */ readonly appliedNestedStyles: CharacterStyle[]; /** * The list to be part of. Can return: NumberingList or String. */ appliedNumberingList: NumberingList | string; /** * The paragraph style applied to the text. Can also accept: String. */ appliedParagraphStyle: ParagraphStyle | string; /** * The maximum ascent of any character in the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly ascent: number | string; /** * The XML elements associated with the Character. */ readonly associatedXMLElements: XMLItem[]; /** * The percent of the type size to use for auto leading. (Range: 0 to 500). * @remarks Range: 0 to 500 */ autoLeading: number; /** * The number of half-width characters at or below which the characters * automatically run horizontally in vertical text. */ autoTcy: number; /** * If true, auto tcy includes Roman characters. */ autoTcyIncludeRoman: boolean; /** * If true or set to an enumeration value, balances ragged lines. Note: Not * valid with a single-line text composer. Can return: Boolean or * BalanceLinesStyle enumerator. */ balanceRaggedLines: boolean | BalanceLinesStyle; /** * The vertical offset of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly baseline: number | string; /** * The baseline shift applied to the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ baselineShift: number | string; /** * Bullet character. */ readonly bulletChar: Bullet; /** * The alignment of the bullet character. */ bulletsAlignment: ListAlignment; /** * List type for bullets and numbering. */ bulletsAndNumberingListType: ListType; /** * The character style to be used for the text after string. Can return: * CharacterStyle or String. */ bulletsCharacterStyle: CharacterStyle | string; /** * The text after string expression for bullets. */ bulletsTextAfter: string; /** * If true, adds the double period (..), ellipse (...), and double hyphen (--) * to the selected kinsoku set. Note: Valid only when a kinsoku set is in * effect. */ bunriKinshi: boolean; /** * A collection of buttons. */ readonly buttons: Buttons; /** * The capitalization scheme. */ capitalization: Capitalization; /** * The alignment of small characters to the largest character in the line. */ characterAlignment: CharacterAlignment; /** * The direction of the character. */ characterDirection: CharacterDirectionOptions; /** * The rotation angle (in degrees) of individual characters. Note: The rotation * is counterclockwise. */ characterRotation: number; /** * A collection of characters. */ readonly characters: Characters; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * If true, uses grid tracking to track non-Roman characters in CJK grids. */ cjkGridTracking: boolean; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * The text composer to use to compose the text. */ composer: string; /** * The contents of the text. Can return: String or SpecialCharacters * enumerator. */ contents: string | SpecialCharacters; /** * The maximum descent of any character in the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly descent: number | string; /** * Value of Design Axes */ designAxes: number[]; /** * The desired width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ desiredGlyphScaling: number; /** * The desired letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) */ desiredLetterSpacing: number; /** * The desired word spacing, specified as a percentage of the font word space * value. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ desiredWordSpacing: number; /** * Position of diacriticical characters. */ diacriticPosition: DiacriticPositionOptions; /** * The digits type. */ digitsType: DigitsTypeOptions; /** * The number of characters to drop cap. * @remarks Range: 0 to 150 */ dropCapCharacters: number; /** * The number of lines to drop cap. * @remarks Range: 0 to 25 */ dropCapLines: number; /** * The character style to apply to the drop cap. Can also accept: String. */ dropCapStyle: CharacterStyle | string; /** * Details about the drop cap based on the glyph outlines. 1 = left side * bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid. */ dropcapDetail: number; /** * Vertical offset of the end of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly endBaseline: number | string; /** * Horizontal offset of the end of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly endHorizontalOffset: number | string; /** * The stroke join type applied to the characters of the text. */ endJoin: OutlineJoin; /** * A collection of endnote text ranges. */ readonly endnoteRanges: EndnoteRanges; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * Character. . Can also accept: String. */ fillColor: Swatch | string; /** * The tint (as a percentage) of the fill color of the Character. (To specify a * tint percentage, use a number in the range of 0 to 100; to use the inherited * or overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * The amount to indent the first line. * @remarks Measurement unit — also accepts a string such as "12mm". */ firstLineIndent: number | string; /** * The name of the font style. */ fontStyle: string; /** * A collection of footnotes. */ readonly footnotes: Footnotes; /** * A collection of form fields. */ readonly formFields: FormFields; /** * The glyph variant to substitute for standard glyphs. */ glyphForm: AlternateGlyphForms; /** * The angle of a linear gradient applied to the fill of the text. (Range: -180 * to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the text. */ gradientFillLength: number; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the text. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the text. */ gradientStrokeLength: number; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * If true, aligns only the first line to the frame grid or baseline grid. If * false, aligns all lines to the grid. */ gridAlignFirstLineOnly: boolean; /** * The alignment to the frame grid or baseline grid. */ gridAlignment: GridAlignment; /** * The manual gyoudori setting. */ gridGyoudori: number; /** * A collection of groups. */ readonly groups: Groups; /** * A collection of hidden text objects. */ readonly hiddenTexts: HiddenTexts; /** * The horizontal offset of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly horizontalOffset: number | string; /** * The horizontal scaling applied to the Character. */ horizontalScale: number; /** * The relative desirability of better spacing vs. fewer hyphens. A lower value * results in greater use of hyphens. (Range: 0 to 100) * @remarks Range: 0 to 10 */ hyphenWeight: number; /** * If true, allows the last word in a text column to be hyphenated. */ hyphenateAcrossColumns: boolean; /** * The mininum number of letters at the beginning of a word that can be broken * by a hyphen. * @remarks Range: 1 to 15 */ hyphenateAfterFirst: number; /** * The minimum number of letters at the end of a word that can be broken by a * hyphen. * @remarks Range: 1 to 15 */ hyphenateBeforeLast: number; /** * If true, allows hyphenation of capitalized words. */ hyphenateCapitalizedWords: boolean; /** * The maximum number of hyphens that can appear on consecutive lines. To * specify unlimited consecutive lines, use zero. * @remarks Range: 0 to 25 */ hyphenateLadderLimit: number; /** * If true, allows hyphenation in the last word in a paragraph. Note: Valid * only when hyphenation is true. */ hyphenateLastWord: boolean; /** * The minimum number of letters a word must have in order to qualify for * hyphenation. * @remarks Range: 3 to 25 */ hyphenateWordsLongerThan: number; /** * If true, allows hyphenation. */ hyphenation: boolean; /** * The amount of white space allowed at the end of a line of non-justified text * before hypenation begins. Note: Valid when composer is single-line composer. * @remarks Measurement unit — also accepts a string such as "12mm". */ hyphenationZone: number | string; /** * If true, ignores optical edge alignment for the paragraph. */ ignoreEdgeAlignment: boolean; /** * The index of the text in the collection or parent object. */ readonly index: number; /** * A collection of insertion points. */ readonly insertionPoints: InsertionPoints; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The number of grid squares in which to arrange the text. */ jidori: number; /** * The paragraph alignment. */ justification: Justification; /** * Use of Kashidas for justification */ kashidas: KashidasOptions; /** * If true, keeps all lines of the paragraph together. If false, allows * paragraphs to break across pages or columns. */ keepAllLinesTogether: boolean; /** * The minimum number of lines to keep together in a paragraph before allowing * a page break. * @remarks Range: 1 to 50 */ keepFirstLines: number; /** * The minimum number of lines to keep together in a paragraph after a page * break. * @remarks Range: 1 to 50 */ keepLastLines: number; /** * If true, keeps a specified number of lines together when the paragraph * breaks across columns or text frames. */ keepLinesTogether: boolean; /** * If true, forces the rule above the paragraph to remain in the frame bounds. * Note: Valid only when rule above is true. */ keepRuleAboveInFrame: boolean; /** * The minimum number of lines to keep with the next paragraph. * @remarks Range: 0 to 5 */ keepWithNext: number; /** * If the first line in the paragraph should be kept with the last line of * previous paragraph. */ keepWithPrevious: boolean; /** * The alignment of kenten characters relative to the parent characters. */ kentenAlignment: KentenAlignment; /** * The character set used for the custom kenten character. Note: Valid only * when kenten kind is custom. */ kentenCharacterSet: KentenCharacterSet; /** * The character used for kenten. Note: Valid only when kenten kind is custom. */ kentenCustomCharacter: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of * kenten characters. Can return: Swatch or String. */ kentenFillColor: Swatch | string; /** * The font to use for kenten characters. Can return: Font or String. */ kentenFont: Font | string; /** * The size (in points) of kenten characters. */ kentenFontSize: number; /** * The font style of kenten characters. Can return: String or NothingEnum * enumerator. */ kentenFontStyle: string | NothingEnum; /** * The style of kenten characters. */ kentenKind: KentenCharacter; /** * The method of overprinting the kenten fill. */ kentenOverprintFill: AdornmentOverprint; /** * The method of overprinting the kenten stroke. */ kentenOverprintStroke: AdornmentOverprint; /** * The distance between kenten characters and their parent characters. */ kentenPlacement: number; /** * The kenten position relative to the parent character. */ kentenPosition: RubyKentenPosition; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * kenten characters. Can return: Swatch or String. */ kentenStrokeColor: Swatch | string; /** * The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenStrokeTint: number; /** * The fill tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenTint: number; /** * The stroke weight (in points) of kenten characters. */ kentenWeight: number; /** * The horizontal size of kenten characters as a percent of the original size. */ kentenXScale: number; /** * The vertical size of kenten charachers as a percent of the original size. */ kentenYScale: number; /** * The type of pair kerning. */ kerningMethod: string; /** * The amount of space to add or remove between characters, specified in * thousands of an em. */ kerningValue: number; /** * The keyboard direction of the character. */ keyboardDirection: CharacterDirectionOptions; /** * The type of hanging punctuation to allow. Note: Valid only when a kinsoku * set is in effect. */ kinsokuHangType: KinsokuHangTypes; /** * The kinsoku set that determines legitimate line breaks. Can return: * KinsokuTable, KinsokuSet enumerator or String. */ kinsokuSet: KinsokuSet | KinsokuTable | string; /** * The type of kinsoku processing for preventing kinsoku characters from * beginning or ending a line. Note: Valid only when a kinsoku set is defined. */ kinsokuType: KinsokuType; /** * The amount to indent the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ lastLineIndent: number | string; /** * The leading applied to the text. Can return: Unit or Leading enumerator. */ leading: number | Leading; /** * The amount of space before each character. */ leadingAki: number; /** * The point from which leading is measured from line to line. */ leadingModel: LeadingModel; /** * The width of the left indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ leftIndent: number | string; /** * The number of objects in the collection. */ readonly length: number; /** * If true, replaces specific character combinations (e.g., fl, fi) with * ligature characters. */ ligatures: boolean; /** * A collection of lines. */ readonly lines: Lines; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * The maximum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ maximumGlyphScaling: number; /** * The maximum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ maximumLetterSpacing: number; /** * The maximum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ maximumWordSpacing: number; /** * If true, consecutive para borders with completely similar properties are * merged. */ mergeConsecutiveParaBorders: boolean; /** * The minimum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ minimumGlyphScaling: number; /** * The minimum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ minimumLetterSpacing: number; /** * The minimum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ minimumWordSpacing: number; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 0 to 1000 */ miterLimit: number; /** * The mojikumi table. For information, see mojikumi table defaults. Can * return: MojikumiTable, String or MojikumiTableDefaults enumerator. */ mojikumi: MojikumiTable | string | MojikumiTableDefaults; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * A collection of nested GREP styles. */ readonly nestedGrepStyles: NestedGrepStyles; /** * A collection of nested line styles. */ readonly nestedLineStyles: NestedLineStyles; /** * A collection of nested styles. */ readonly nestedStyles: NestedStyles; /** * If true, keeps the text on the same line. */ noBreak: boolean; /** * A collection of notes. */ readonly notes: Notes; /** * The alignment of the number. */ numberingAlignment: ListAlignment; /** * If true, apply the numbering restart policy. */ numberingApplyRestartPolicy: boolean; /** * The character style to be used for the number string. Can return: * CharacterStyle or String. */ numberingCharacterStyle: CharacterStyle | string; /** * Continue the numbering at this level. */ numberingContinue: boolean; /** * The number string expression for numbering. */ numberingExpression: string; /** * Numbering format options. Can return: NumberingStyle enumerator or String. */ numberingFormat: NumberingStyle | string; /** * The level of the paragraph. */ numberingLevel: number; /** * Numbering restart policies. */ readonly numberingRestartPolicies: NumberingRestartPolicy; /** * Determines starting number in a numbered list. */ numberingStartAt: number; /** * OpenType features. Can return: Array of Array of 2 Strings or Long Integers. */ opentypeFeatures: (string[][] | number[])[]; /** * If true, uses contextual alternate forms in OpenType fonts. */ otfContextualAlternate: boolean; /** * If true, uses discretionary ligatures in OpenType fonts. */ otfDiscretionaryLigature: boolean; /** * The figure style in OpenType fonts. */ otfFigureStyle: OTFFigureStyle; /** * If true, uses fractions in OpenType fonts. */ otfFraction: boolean; /** * If true, switches hiragana fonts, which have different glyphs for horizontal * and vertical. */ otfHVKana: boolean; /** * If true, use historical forms in OpenType fonts. */ otfHistorical: boolean; /** * If true, use alternate justification forms in OpenType fonts */ otfJustificationAlternate: boolean; /** * If true, uses localized forms in OpenType fonts. */ otfLocale: boolean; /** * If true, uses mark positioning in OpenType fonts. */ otfMark: boolean; /** * If true, uses ordinals in OpenType fonts. */ otfOrdinal: boolean; /** * If true, use overlapping swash forms in OpenType fonts */ otfOverlapSwash: boolean; /** * If true, kerns according to proportional CJK metrics in OpenType fonts. */ otfProportionalMetrics: boolean; /** * If true, applies italics to half-width alphanumerics. */ otfRomanItalics: boolean; /** * If true, use a slashed zeroes in OpenType fonts. */ otfSlashedZero: boolean; /** * If true, use stretched alternate forms in OpenType fonts */ otfStretchedAlternate: boolean; /** * If true, use stylistic alternate forms in OpenType fonts */ otfStylisticAlternate: boolean; /** * The stylistic sets to use in OpenType fonts. */ otfStylisticSets: number; /** * If true, uses swash forms in OpenType fonts. */ otfSwash: boolean; /** * If true, uses titling forms in OpenType fonts. */ otfTitling: boolean; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the fill color of the characters will overprint. */ overprintFill: boolean; /** * If true, the stroke of the characters will overprint. */ overprintStroke: boolean; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphBorderBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLeftCornerRadius: number | string; /** * The bottom line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLineWeight: number | string; /** * The distance to offset the bottom edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph border. */ paragraphBorderBottomOrigin: ParagraphBorderBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphBorderBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomRightCornerRadius: number | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * stroke. Can return: Swatch or String. */ paragraphBorderColor: Swatch | string; /** * If true, then paragraph border is also displayed at the points where the * paragraph splits across frames or columns. */ paragraphBorderDisplayIfSplits: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * border gap. Note: Valid only when the border type is not solid. Can return: * Swatch or String. */ paragraphBorderGapColor: Swatch | string; /** * If true, the paragraph border gap will overprint. Note: Valid only when * border type is not solid. */ paragraphBorderGapOverprint: boolean; /** * The tint (as a percentage) of the paragraph border gap. Note: Valid only * when the border type is not solid. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderGapTint: number; /** * The left line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftLineWeight: number | string; /** * The distance to offset the left edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftOffset: number | string; /** * If true, the paragraph border is on. */ paragraphBorderOn: boolean; /** * If true, the paragraph border will overprint. */ paragraphBorderOverprint: boolean; /** * The right line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightLineWeight: number | string; /** * The distance to offset the right edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightOffset: number | string; /** * The end shape of an open path. */ paragraphBorderStrokeEndCap: EndCap; /** * The corner join applied to the Character. */ paragraphBorderStrokeEndJoin: EndJoin; /** * The tint (as a percentage) of the paragraph stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphBorderTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLeftCornerRadius: number | string; /** * The top line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLineWeight: number | string; /** * The distance to offset the top edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph border. */ paragraphBorderTopOrigin: ParagraphBorderTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphBorderTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopRightCornerRadius: number | string; /** * The type of the border for the paragraph. Can return: StrokeStyle or String. */ paragraphBorderType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph border. */ paragraphBorderWidth: ParagraphBorderEnum; /** * Paragraph direction. */ paragraphDirection: ParagraphDirectionOptions; /** * If true, the gyoudori mode applies to the entire paragraph. If false, the * gyoudori mode applies to each line in the paragraph. */ paragraphGyoudori: boolean; /** * Paragraph justification. */ paragraphJustification: ParagraphJustificationOptions; /** * Paragraph kashida width. 0 is none, 1 is short, 2 is medium, 3 is long */ paragraphKashidaWidth: number; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphShadingBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomLeftCornerRadius: number | string; /** * The distance to offset the bottom edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph shading. */ paragraphShadingBottomOrigin: ParagraphShadingBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphShadingBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomRightCornerRadius: number | string; /** * If true, forces the shading of the paragraph to be clipped with respect to * frame shape. */ paragraphShadingClipToFrame: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * shading. Can return: Swatch or String. */ paragraphShadingColor: Swatch | string; /** * The distance to offset the left edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingLeftOffset: number | string; /** * If true, the paragraph shading is On. */ paragraphShadingOn: boolean; /** * If true, the paragraph shading will overprint. */ paragraphShadingOverprint: boolean; /** * The distance to offset the right edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingRightOffset: number | string; /** * If true, suppress printing of the shading of the paragraph. */ paragraphShadingSuppressPrinting: boolean; /** * The tint (as a percentage) of the paragraph shading. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphShadingTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphShadingTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopLeftCornerRadius: number | string; /** * The distance to offset the top edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph shading. */ paragraphShadingTopOrigin: ParagraphShadingTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphShadingTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopRightCornerRadius: number | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph shading. */ paragraphShadingWidth: ParagraphShadingWidthEnum; /** * A collection of paragraphs. */ readonly paragraphs: Paragraphs; /** * The parent of the Character (a XmlStory, TextPath, TextFrame, * EndnoteTextFrame, Text, InsertionPoint, TextStyleRange, Paragraph, * TextColumn, Line, Word, Character, Story, Cell, XMLElement, Endnote, * Footnote, Note, Change or HiddenText). */ readonly parent: Cell | Change | Character | Endnote | EndnoteTextFrame | Footnote | InsertionPoint | Line | Note | Paragraph | Story | Text | TextColumn | TextFrame | TextPath | TextStyleRange | Word | XMLElement | HiddenText | XmlStory; /** * The story that contains the text. */ readonly parentStory: Story; /** * An array of the text frames that contain the text. Can return: Array of * TextFrames or TextPaths. */ readonly parentTextFrames: (TextFrames | TextPaths)[]; /** * The text size. * @remarks Measurement unit — also accepts a string such as "12mm". */ pointSize: number | string; /** * A collection of polygons. */ readonly polygons: Polygons; /** * The text position relative to the baseline. */ position: Position; /** * The OpenType positional form. */ positionalForm: PositionalForms; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The hyphenation style chosen for the provider. */ providerHyphenationStyle: HyphenationStyleEnum; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * If true, disallows line breaks in numbers. If false, lines can break between * digits in multi-digit numbers. */ rensuuji: boolean; /** * The width of the right indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ rightIndent: number | string; /** * If true, rotates Roman characters in vertical text. */ rotateSingleByteCharacters: boolean; /** * The ruby alignment. */ rubyAlignment: RubyAlignments; /** * If true, auto aligns ruby. */ rubyAutoAlign: boolean; /** * If true, automatically scales ruby to the specified percent of parent text * size. For information on specifying a percent, see ruby parent scaling * percent. */ rubyAutoScaling: boolean; /** * If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to * fit one em. */ rubyAutoTcyAutoScale: boolean; /** * The number of digits included in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyDigits: number; /** * If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyIncludeRoman: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby * characters. Can return: Swatch or String. */ rubyFill: Swatch | string; /** * If true, ruby is on. */ rubyFlag: boolean; /** * The font applied to ruby characters. Can return: Font or String. */ rubyFont: Font | string; /** * The size (in points) of ruby characters. */ rubyFontSize: number; /** * The font style of ruby characters. Can return: String or NothingEnum * enumerator. */ rubyFontStyle: string | NothingEnum; /** * If true, uses OpenType Pro fonts for ruby. */ rubyOpenTypePro: boolean; /** * If true, constrains ruby overhang to the specified amount. For information * on specifying an amount, see ruby parent overhang amount. */ rubyOverhang: boolean; /** * The method of overprinting the ruby fill. */ rubyOverprintFill: AdornmentOverprint; /** * The method of overprinting the ruby stroke. */ rubyOverprintStroke: AdornmentOverprint; /** * The amount by which ruby characters can overhang the parent text. */ rubyParentOverhangAmount: RubyOverhang; /** * The amount (as a percentage) to scale the parent text size to determine the * ruby text size. */ rubyParentScalingPercent: number; /** * The ruby spacing relative to the parent text. */ rubyParentSpacing: RubyParentSpacing; /** * The position of ruby characters relative to the parent text. */ rubyPosition: RubyKentenPosition; /** * The ruby string contents. */ rubyString: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * ruby characters. Can return: Swatch or String. */ rubyStroke: Swatch | string; /** * The stroke tint (as a percentage) of ruby characters. */ rubyStrokeTint: number; /** * The tint (as a percentage) of the ruby fill color. (Range: 0 to 100) * @remarks Range: 0 to 100 */ rubyTint: number; /** * The ruby type. */ rubyType: RubyTypes; /** * The stroke weight (in points) of ruby characters. */ rubyWeight: number; /** * The amount of horizontal space between ruby and parent characters. */ rubyXOffset: number; /** * The horizontal size of ruby characters, specified as a percent of the * original size. */ rubyXScale: number; /** * The amount of vertical space between ruby and parent characters. */ rubyYOffset: number; /** * The vertical size of ruby characters, specified as a percent of the original * size. */ rubyYScale: number; /** * If true, places a rule above the paragraph. */ ruleAbove: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule above. Can return: Swatch or String. */ ruleAboveColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule above. Note: Valid only when the paragraph rule above * type is not solid. Can return: Swatch or String. */ ruleAboveGapColor: Swatch | string; /** * If true, the stroke gap of the paragraph rule above will overprint. Note: * Valid only the rule above type is not solid. */ ruleAboveGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule. * (Range: 0 to 100) Note: Valid only when the rule above type is not solid. * @remarks Range: 0 to 100 */ ruleAboveGapTint: number; /** * The distance to indent the left edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLeftIndent: number | string; /** * The line weight of the rule above. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLineWeight: number | string; /** * The amount to offset the paragraph rule above from the baseline of the first * line the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveOffset: number | string; /** * If true, the paragraph rule above will overprint. */ ruleAboveOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleAboveTint: number; /** * The stroke type of the rule above the paragraph. Can return: StrokeStyle or * String. */ ruleAboveType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule above. */ ruleAboveWidth: RuleWidth; /** * If true, applies a paragraph rule below. */ ruleBelow: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule below. Can return: Swatch or String. */ ruleBelowColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule below. Note: Valid only when the paragraph rule below * type is not solid. Can return: Swatch or String. */ ruleBelowGapColor: Swatch | string; /** * If true, the gap color of the rule below will overprint. */ ruleBelowGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule * below. (Range: 0 to 100) Note: Valid only when the paragraph rule below type * is not solid. * @remarks Range: 0 to 100 */ ruleBelowGapTint: number; /** * The distance to indent the left edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLeftIndent: number | string; /** * The line weight of the rule below. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLineWeight: number | string; /** * The amount to offset the the paragraph rule below from the baseline of the * last line of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowOffset: number | string; /** * If true, the rule below will overprint. */ ruleBelowOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleBelowTint: number; /** * The stroke type of the rule below the paragraph. Can return: StrokeStyle or * String. */ ruleBelowType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule below. */ ruleBelowWidth: RuleWidth; /** * The space between paragraphs using same style. Can return: Unit or Spacing * enumerator. */ sameParaStyleSpacing: number | Spacing; /** * If true, the line changes size when characters are scaled. */ scaleAffectsLineHeight: boolean; /** * If true, applies shatai rotation. */ shataiAdjustRotation: boolean; /** * If true, adjusts shatai tsume. */ shataiAdjustTsume: boolean; /** * The shatai lens angle (in degrees). */ shataiDegreeAngle: number; /** * The amount (as a percentage) of shatai obliquing to apply. */ shataiMagnification: number; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * The alignment to use for lines that contain a single word. */ singleWordJustification: SingleWordJustification; /** * The skew angle of the Character. */ skew: number; /** * The height of the paragraph space below. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceAfter: number | string; /** * The height of the paragraph space above. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceBefore: number | string; /** * The minimum space after a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceAfter: number | string; /** * The minimum space before a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceBefore: number | string; /** * Whether a paragraph should be a single column, span columns or split columns */ spanColumnType: SpanColumnTypeOptions; /** * The number of columns a paragraph spans or the number of split columns. Can * return: Short Integer (1 - 40) or SpanColumnCountOptions enumerator. */ spanSplitColumnCount: number | SpanColumnCountOptions; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The inside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnInsideGutter: number | string; /** * The outside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnOutsideGutter: number | string; /** * The location at which to start the paragraph. */ startParagraph: StartParagraph; /** * The swatch (color, gradient, tint, or mixed ink) applied to the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughGapColor: Swatch | string; /** * If true, the gap color of the strikethrough stroke will overprint. Note: * Valid when strike through type is not solid. */ strikeThroughGapOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 * to 100) Note: Valid when strike through type is not solid. * @remarks Range: 0 to 100 */ strikeThroughGapTint: number; /** * The amount by which to offset the strikethrough stroke from the text * baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughOffset: number | string; /** * If true, the strikethrough stroke will overprint. */ strikeThroughOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ strikeThroughTint: number; /** * The stroke type of the strikethrough stroke. Can return: StrokeStyle or * String. */ strikeThroughType: StrokeStyle | string; /** * The stroke weight of the strikethrough stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughWeight: number | string; /** * If true, draws a strikethrough line through the text. */ strikeThru: boolean; /** * The stroke alignment applied to the text. */ strokeAlignment: TextStrokeAlign; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the Character. Can also accept: String. */ strokeColor: Swatch | string; /** * The tint (as a percentage) of the stroke color of the Character. (To specify * a tint percentage, use a number in the range of 0 to 100; to use the * inherited or overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * The stroke weight applied to the characters of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * If true, the applied style has been overridden with additional attributes. */ readonly styleOverridden: boolean; /** * A list of the tab stops in the paragraph. Can return: Array of Arrays of * Property Name/Value Pairs. */ tabList: any[][][]; /** * A collection of tab stops. */ readonly tabStops: TabStops; /** * A collection of tables. */ readonly tables: Tables; /** * If true, makes the character horizontal in vertical text. */ tatechuyoko: boolean; /** * The horizontal offset for horizontal characters in vertical text. */ tatechuyokoXOffset: number; /** * The vertical offset for horizontal characters in vertical text. */ tatechuyokoYOffset: number; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text columns. */ readonly textColumns: TextColumns; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * A collection of text style ranges. */ readonly textStyleRanges: TextStyleRanges; /** * A collection of text variable instances. */ readonly textVariableInstances: TextVariableInstances; /** * A collection of text objects. */ readonly texts: Texts; /** * The amount by which to loosen or tighten a block of text, specified in * thousands of an em. */ tracking: number; /** * The amount of space after each character. */ trailingAki: number; /** * If true, ideographic spaces will not wrap to the next line like text * characters. */ treatIdeographicSpaceAsSpace: boolean; /** * The amount of horizontal character compression. */ tsume: number; /** * If true, underlines the text. */ underline: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the underline * stroke. . Can return: Swatch or String. */ underlineColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * underline stroke. Note: Valid when underline type is not solid. Can return: * Swatch or String. */ underlineGapColor: Swatch | string; /** * If true, the gap color of the underline stroke will overprint. */ underlineGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of the underline stroke. (Range: * 0 to 100) Note: Valid when underline type is not solid. * @remarks Range: 0 to 100 */ underlineGapTint: number; /** * The amount by which to offset the underline from the text baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineOffset: number | string; /** * If true, the underline stroke color will overprint. */ underlineOverprint: boolean; /** * The underline stroke tint (as a percentage). (Range: 0 to 100) * @remarks Range: 0 to 100 */ underlineTint: number; /** * The stroke type of the underline stroke. Can return: StrokeStyle or String. */ underlineType: StrokeStyle | string; /** * The stroke weight of the underline stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineWeight: number | string; /** * The vertical scaling applied to the Character. */ verticalScale: number; /** * If true, turns on warichu. */ warichu: boolean; /** * The warichu alignment. */ warichuAlignment: WarichuAlignment; /** * The minimum number of characters allowed after a line break. */ warichuCharsAfterBreak: number; /** * The minimum number of characters allowed before a line break. */ warichuCharsBeforeBreak: number; /** * The gap between lines of warichu characters. */ warichuLineSpacing: number; /** * The number of lines of warichu within a single normal line. */ warichuLines: number; /** * The amount (as a percentage) to scale parent text size to determine warichu * size. */ warichuSize: number; /** * A collection of words. */ readonly words: Words; /** * The x (horizontal) offset for diacritic adjustment. */ xOffsetDiacritic: number; /** * The y (vertical) offset for diacritic adjustment. */ yOffsetDiacritic: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Apply a character style. * @param using The character style to apply. */ applyCharacterStyle(using: CharacterStyle): void; /** * Apply one or more conditions. * @param using The condition(s) to apply * @param removeExisting If true, remove existing conditions. (Optional) */ applyConditions(using: Condition[], removeExisting?: boolean): void; /** * Apply a paragraph style. * @param using The paragraph style to apply. * @param clearingOverrides If true, clear any text attributes before applying the style. (Optional) */ applyParagraphStyle(using: ParagraphStyle, clearingOverrides?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds glyphs that match the find what value and replaces the glyphs with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value and replaces the text * with the change character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeTransliterate(reverseOrder?: boolean): Text[]; /** * Sets the case of the text. * @param using The text case option. */ changecase(using: ChangecaseMode): void; /** * Clears the specified types of override. * @param overridesToClear The types of override to clear. (Optional) */ clearOverrides(overridesToClear?: OverrideType): void; /** * Convert bullets and numbering to text. */ convertBulletsAndNumberingToText(): void; /** * Converts the text to a note. */ convertToNote(): Note; /** * Converts the text to a table. * @param columnSeparator The character that starts a new column in the new table. (Optional) * @param rowSeparator The character starts a new row in the new table. (Optional) * @param numberOfColumns The number of columns in the table. Note: Valid only when the column and row separator characters are the same. (Optional) */ convertToTable(columnSeparator?: string, rowSeparator?: string, numberOfColumns?: number): Table; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Character. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Character. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Converts text to outlines. Each line of text becomes a polygon object. When * the converted text is a single letter that has no internal spaces or * detached parts, the polygon contains only a single path. Note: To determine * whether a font allows the creation of outlines, see allow outlines. * @param deleteOriginal If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) */ createOutlines(deleteOriginal?: boolean): PageItem[]; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Character. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create thumbnail for selected text using the applied style and overrides * with the given properties. * @param previewText Text to use as sample * @param pointSize Text font size (in points) * @param space Color space RGB, CMYK or LAB * @param colorValue Color values * @param to The path to the export file. * @param charOrParaStyle The applied style type to use. */ createStyleThumbnailWithProperties(previewText: string, pointSize: number, space: ColorSpace, colorValue: number[], to: File, charOrParaStyle: StyleType): boolean; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Character. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create thumbnail for selected text with the given properties. * @param previewText Text to use as sample * @param pointSize Text font size (in points) * @param space Color space RGB, CMYK or LAB * @param colorValue Color values * @param to The path to the export file. */ createThumbnailWithProperties(previewText: string, pointSize: number, space: ColorSpace, colorValue: number[], to: File): boolean; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Character. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Duplicates the text in the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional) */ duplicate(to: LocationOptions, reference?: Cell | Column | Row | Story | Table | Text | PageItem): Text; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Finds glyphs that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGrep(reverseOrder?: boolean): Text[]; /** * Finds hyperlink sources that intersecting with specified text range. * @param sortOrder The sort order of found ranges. (Optional) */ findHyperlinks(sortOrder?: RangeSortOrder): HyperlinkTextSource[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findTransliterate(reverseOrder?: boolean): Text[]; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Character[]; /** * If true, Nth design axis of variable font is hidden. * @param nthAxisIndex Index of design axis. */ isNthDesignAxisHidden(nthAxisIndex: number): boolean; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the text to the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional) */ move(to: LocationOptions, reference?: Cell | Column | Row | Story | Table | Text | PageItem): Text; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Recomposes the text in the Character. */ recompose(): void; /** * Deletes the Character. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Selects the object. * @param existingSelection The selection status of the Character in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Set Nth design axis of a variable font. * @param nthAxisIndex Index of design axis. * @param nthAxisValue Value of nth design axis. */ setNthDesignAxis(nthAxisIndex: number, nthAxisValue: number): void; /** * Jump to the text range. */ showText(): void; /** * If true, text has local overrides * @param charOrParaStyle Style type to look at. * @param charStyleAsOverride Whether to consider character styles as overrides or not (Optional) */ textHasOverrides(charOrParaStyle: StyleType, charStyleAsOverride?: boolean): boolean; /** * Generates a string which, if executed, will return the Character. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for aligning small characters to the largest character in the line. */ declare enum CharacterAlignment { /** * Aligns small characters in a line to the large character. */ ALIGN_BASELINE = 1247896172, /** * Aligns small characters in horizontal text to the bottom of the em box of * large characters. In vertical text, aligns characters to the left of the em * box. */ ALIGN_EM_BOTTOM = 1247896173, /** * Aligns small characters to the center of the em box of large characters. */ ALIGN_EM_CENTER = 1247896436, /** * Aligns small characters in horizontal text to the top of the em box of large * characters. In vertical text, aligns characters to the right of the em box. */ ALIGN_EM_TOP = 1247900784, /** * Aligns small characters in horizontal text to the bottom of the ICF of large * characters. In vertical text, aligns characters to the left of the ICF. */ ALIGN_ICF_BOTTOM = 1248420461, /** * Aligns small characters in horizontal text to the top of the ICF of large * characters. In vertical text, aligns characters to the right of the ICF. */ ALIGN_ICF_TOP = 1248425072, } /** * Character count location options. */ declare enum CharacterCountLocation { /** * Displays the character count at the bottom of the frame. */ BOTTOM_ALIGN = 1651471469, /** * Displays the character count on the left side of the frame. */ LEFT_ALIGN = 1818584692, /** * Hides the character count. */ NONE = 1852796517, /** * Displays the character count on the right side of the frame. */ RIGHT_ALIGN = 1919379572, /** * Displays the character count at the top of the frame. */ TOP_ALIGN = 1953460256, } /** * Character direction. */ declare enum CharacterDirectionOptions { /** * Default direction */ DEFAULT_DIRECTION = 1147496036, /** * Left to right direction */ LEFT_TO_RIGHT_DIRECTION = 1278366308, /** * Right to left direction */ RIGHT_TO_LEFT_DIRECTION = 1379028068, } /** * A character style. */ declare class CharacterStyle { /** * The font applied to the CharacterStyle, specified as either a font object or * the name of font family. Can return: Font, String or NothingEnum enumerator. */ appliedFont: Font | string | NothingEnum; /** * The language of the text. Can return: LanguageWithVendors, Language or * NothingEnum enumerator. Can also accept: String. */ appliedLanguage: Language | LanguageWithVendors | string | NothingEnum; /** * The style that this style is based on. Can return: CharacterStyle or String. */ basedOn: CharacterStyle | string; /** * The baseline shift applied to the text. Can return: Unit or NothingEnum * enumerator. */ baselineShift: number | NothingEnum; /** * The capitalization scheme. Can return: Capitalization enumerator or * NothingEnum enumerator. */ capitalization: Capitalization | NothingEnum; /** * The alignment of small characters to the largest character in the line. Can * return: CharacterAlignment enumerator or NothingEnum enumerator. */ characterAlignment: CharacterAlignment | NothingEnum; /** * The direction of the character. Can return: CharacterDirectionOptions * enumerator or NothingEnum enumerator. */ characterDirection: CharacterDirectionOptions | NothingEnum; /** * The rotation angle (in degrees) of individual characters. Note: The rotation * is counterclockwise. Can return: Real or NothingEnum enumerator. */ characterRotation: number | NothingEnum; /** * If true, uses grid tracking to track non-Roman characters in CJK grids. Can * return: Boolean or NothingEnum enumerator. */ cjkGridTracking: boolean | NothingEnum; /** * Value of Design Axes. Can return: Array of Reals or NothingEnum enumerator. */ designAxes: (number[] | NothingEnum)[]; /** * Position of diacriticical characters. Can return: DiacriticPositionOptions * enumerator or NothingEnum enumerator. */ diacriticPosition: DiacriticPositionOptions | NothingEnum; /** * The digits type. Can return: DigitsTypeOptions enumerator or NothingEnum * enumerator. */ digitsType: DigitsTypeOptions | NothingEnum; /** * Emit CSS. Can return: Boolean or NothingEnum enumerator. */ emitCss: boolean | NothingEnum; /** * The stroke join type applied to the characters of the text. Can return: * OutlineJoin enumerator or NothingEnum enumerator. */ endJoin: OutlineJoin | NothingEnum; /** * The epub aria role as recommended by IDPF. Can return: String or NothingEnum * enumerator. */ epubAriaRole: string | NothingEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * CharacterStyle. . Can return: Swatch or NothingEnum enumerator. Can also * accept: String. */ fillColor: string | Swatch | NothingEnum; /** * The tint (as a percentage) of the fill color of the CharacterStyle. (To * specify a tint percentage, use a number in the range of 0 to 100; to use the * inherited or overridden value, use -1.). Can return: Real or NothingEnum * enumerator. * @remarks Range: 0 to 100 */ fillTint: number | NothingEnum; /** * The name of the font style. Can return: String or NothingEnum enumerator. */ fontStyle: string | NothingEnum; /** * The glyph variant to substitute for standard glyphs. Can return: * AlternateGlyphForms enumerator or NothingEnum enumerator. */ glyphForm: AlternateGlyphForms | NothingEnum; /** * The angle of a linear gradient applied to the fill of the text. (Range: -180 * to 180). Can return: Real or NothingEnum enumerator. */ gradientFillAngle: number | NothingEnum; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the text. Can return: Real or NothingEnum enumerator. */ gradientFillLength: number | NothingEnum; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the text, in the format [x, y]. Can return: Array of 2 Units or * NothingEnum enumerator. */ gradientFillStart: (number[][] | NothingEnum)[]; /** * The angle of a linear gradient applied to the stroke of the text. (Range: * -180 to 180). Can return: Real or NothingEnum enumerator. */ gradientStrokeAngle: number | NothingEnum; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the text. Can return: Real or NothingEnum enumerator. */ gradientStrokeLength: number | NothingEnum; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the text, in the format [x, y]. Can return: Array of 2 Units or * NothingEnum enumerator. */ gradientStrokeStart: (number[][] | NothingEnum)[]; /** * The horizontal scaling applied to the CharacterStyle. Can return: Real or * NothingEnum enumerator. */ horizontalScale: number | NothingEnum; /** * The unique ID of the CharacterStyle. */ readonly id: number; /** * If true, the style was imported from another document. Can return: Boolean * or NothingEnum enumerator. */ readonly imported: boolean | NothingEnum; /** * If true, class attribute will be generated for the style. Can return: * Boolean or NothingEnum enumerator. */ includeClass: boolean | NothingEnum; /** * The index of the CharacterStyle within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The number of grid squares in which to arrange the text. . Can return: Short * Integer or NothingEnum enumerator. */ jidori: number | NothingEnum; /** * Use of Kashidas for justification. Can return: KashidasOptions enumerator or * NothingEnum enumerator. */ kashidas: KashidasOptions | NothingEnum; /** * The alignment of kenten characters relative to the parent characters. . Can * return: KentenAlignment enumerator or NothingEnum enumerator. */ kentenAlignment: KentenAlignment | NothingEnum; /** * The character set used for the custom kenten character. Note: Valid only * when kenten kind is custom. . Can return: KentenCharacterSet enumerator or * NothingEnum enumerator. */ kentenCharacterSet: KentenCharacterSet | NothingEnum; /** * The character used for kenten. Note: Valid only when kenten kind is custom. * Can return: String or NothingEnum enumerator. */ kentenCustomCharacter: string | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of * kenten characters. Can return: Swatch, String or NothingEnum enumerator. */ kentenFillColor: string | Swatch | NothingEnum; /** * The font to use for kenten characters. Can return: Font, String or * NothingEnum enumerator. */ kentenFont: Font | string | NothingEnum; /** * The size (in points) of kenten characters. Can return: Real or NothingEnum * enumerator. */ kentenFontSize: number | NothingEnum; /** * The font style of kenten characters. Can return: String or NothingEnum * enumerator. */ kentenFontStyle: string | NothingEnum; /** * The style of kenten characters. Can return: KentenCharacter enumerator or * NothingEnum enumerator. */ kentenKind: KentenCharacter | NothingEnum; /** * The method of overprinting the kenten fill. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ kentenOverprintFill: AdornmentOverprint | NothingEnum; /** * The method of overprinting the kenten stroke. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ kentenOverprintStroke: AdornmentOverprint | NothingEnum; /** * The distance between kenten characters and their parent characters. Can * return: Real or NothingEnum enumerator. */ kentenPlacement: number | NothingEnum; /** * The kenten position relative to the parent character. Can return: * RubyKentenPosition enumerator or NothingEnum enumerator. */ kentenPosition: RubyKentenPosition | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * kenten characters. Can return: Swatch, String or NothingEnum enumerator. */ kentenStrokeColor: string | Swatch | NothingEnum; /** * The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100). * Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ kentenStrokeTint: number | NothingEnum; /** * The fill tint (as a percentage) of kenten characters. (Range: 0 to 100). Can * return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ kentenTint: number | NothingEnum; /** * The stroke weight (in points) of kenten characters. Can return: Real or * NothingEnum enumerator. */ kentenWeight: number | NothingEnum; /** * The horizontal size of kenten characters as a percent of the original size. * Can return: Real or NothingEnum enumerator. */ kentenXScale: number | NothingEnum; /** * The vertical size of kenten charachers as a percent of the original size. . * Can return: Real or NothingEnum enumerator. */ kentenYScale: number | NothingEnum; /** * The type of pair kerning. Can return: String or NothingEnum enumerator. */ kerningMethod: string | NothingEnum; /** * The keyboard direction of the character. Can return: * CharacterDirectionOptions enumerator or NothingEnum enumerator. */ keyboardDirection: CharacterDirectionOptions | NothingEnum; /** * A property that can be set to any string. */ label: string; /** * The leading applied to the text. Can return: Unit, Leading enumerator or * NothingEnum enumerator. */ leading: Leading | number | NothingEnum; /** * The amount of space before each character. Can return: Real or NothingEnum * enumerator. */ leadingAki: number | NothingEnum; /** * If true, replaces specific character combinations (e.g., fl, fi) with * ligature characters. Can return: Boolean or NothingEnum enumerator. */ ligatures: boolean | NothingEnum; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. Can return: Real (0 - * 1000) or NothingEnum enumerator. */ miterLimit: number | NothingEnum; /** * The name of the style. */ name: string; /** * If true, keeps the text on the same line. . Can return: Boolean or * NothingEnum enumerator. */ noBreak: boolean | NothingEnum; /** * If true, uses contextual alternate forms in OpenType fonts. Can return: * Boolean or NothingEnum enumerator. */ otfContextualAlternate: boolean | NothingEnum; /** * If true, uses discretionary ligatures in OpenType fonts. Can return: Boolean * or NothingEnum enumerator. */ otfDiscretionaryLigature: boolean | NothingEnum; /** * The figure style in OpenType fonts. Can return: OTFFigureStyle enumerator or * NothingEnum enumerator. */ otfFigureStyle: OTFFigureStyle | NothingEnum; /** * If true, uses fractions in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfFraction: boolean | NothingEnum; /** * If true, switches hiragana fonts, which have different glyphs for horizontal * and vertical. . Can return: Boolean or NothingEnum enumerator. */ otfHVKana: boolean | NothingEnum; /** * If true, use historical forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfHistorical: boolean | NothingEnum; /** * If true, use alternate justification forms in OpenType fonts. Can return: * Boolean or NothingEnum enumerator. */ otfJustificationAlternate: boolean | NothingEnum; /** * If true, uses localized forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfLocale: boolean | NothingEnum; /** * If true, uses mark positioning in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfMark: boolean | NothingEnum; /** * If true, uses ordinals in OpenType fonts. Can return: Boolean or NothingEnum * enumerator. */ otfOrdinal: boolean | NothingEnum; /** * If true, use overlapping swash forms in OpenType fonts. Can return: Boolean * or NothingEnum enumerator. */ otfOverlapSwash: boolean | NothingEnum; /** * If true, kerns according to proportional CJK metrics in OpenType fonts. Can * return: Boolean or NothingEnum enumerator. */ otfProportionalMetrics: boolean | NothingEnum; /** * If true, applies italics to half-width alphanumerics. . Can return: Boolean * or NothingEnum enumerator. */ otfRomanItalics: boolean | NothingEnum; /** * If true, use a slashed zeroes in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfSlashedZero: boolean | NothingEnum; /** * If true, use stretched alternate forms in OpenType fonts. Can return: * Boolean or NothingEnum enumerator. */ otfStretchedAlternate: boolean | NothingEnum; /** * If true, use stylistic alternate forms in OpenType fonts. Can return: * Boolean or NothingEnum enumerator. */ otfStylisticAlternate: boolean | NothingEnum; /** * The stylistic sets to use in OpenType fonts. Can return: Long Integer or * NothingEnum enumerator. */ otfStylisticSets: number | NothingEnum; /** * If true, uses swash forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfSwash: boolean | NothingEnum; /** * If true, uses titling forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfTitling: boolean | NothingEnum; /** * If true, the fill color of the characters will overprint. Can return: * Boolean or NothingEnum enumerator. */ overprintFill: boolean | NothingEnum; /** * If true, the stroke of the characters will overprint. Can return: Boolean or * NothingEnum enumerator. */ overprintStroke: boolean | NothingEnum; /** * The parent of the CharacterStyle (a Document, Application or * CharacterStyleGroup). */ readonly parent: Application | CharacterStyleGroup | Document; /** * The text size. Can return: Unit or NothingEnum enumerator. */ pointSize: number | NothingEnum; /** * The text position relative to the baseline. Can return: Position enumerator * or NothingEnum enumerator. */ position: Position | NothingEnum; /** * The OpenType positional form. Can return: PositionalForms enumerator or * NothingEnum enumerator. */ positionalForm: PositionalForms | NothingEnum; /** * The color to use for preview, specified either as an array of three doubles, * each in the range 0 to 255 and representing R, G, and B values, or as a UI * color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator or * NothingEnum enumerator. */ previewColor: (number[][] | NothingEnum | UIColors)[]; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The ruby alignment. Can return: RubyAlignments enumerator or NothingEnum * enumerator. */ rubyAlignment: RubyAlignments | NothingEnum; /** * If true, auto aligns ruby. Can return: Boolean or NothingEnum enumerator. */ rubyAutoAlign: boolean | NothingEnum; /** * If true, automatically scales ruby to the specified percent of parent text * size. For information on specifying a percent, see ruby parent scaling * percent. . Can return: Boolean or NothingEnum enumerator. */ rubyAutoScaling: boolean | NothingEnum; /** * If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to * fit one em. Can return: Boolean or NothingEnum enumerator. */ rubyAutoTcyAutoScale: boolean | NothingEnum; /** * The number of digits included in auto tcy (tate-chuu-yoko) in ruby. Can * return: Short Integer or NothingEnum enumerator. */ rubyAutoTcyDigits: number | NothingEnum; /** * If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. Can * return: Boolean or NothingEnum enumerator. */ rubyAutoTcyIncludeRoman: boolean | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby * characters. Can return: Swatch, String or NothingEnum enumerator. */ rubyFill: string | Swatch | NothingEnum; /** * The font applied to ruby characters. Can return: Font, String or NothingEnum * enumerator. */ rubyFont: Font | string | NothingEnum; /** * The size (in points) of ruby characters. Can return: Real or NothingEnum * enumerator. */ rubyFontSize: number | NothingEnum; /** * The font style of ruby characters. Can return: String or NothingEnum * enumerator. */ rubyFontStyle: string | NothingEnum; /** * If true, uses OpenType Pro fonts for ruby. Can return: Boolean or * NothingEnum enumerator. */ rubyOpenTypePro: boolean | NothingEnum; /** * If true, constrains ruby overhang to the specified amount. For information * on specifying an amount, see ruby parent overhang amount. . Can return: * Boolean or NothingEnum enumerator. */ rubyOverhang: boolean | NothingEnum; /** * The method of overprinting the ruby fill. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ rubyOverprintFill: AdornmentOverprint | NothingEnum; /** * The method of overprinting the ruby stroke. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ rubyOverprintStroke: AdornmentOverprint | NothingEnum; /** * The amount by which ruby characters can overhang the parent text. Can * return: RubyOverhang enumerator or NothingEnum enumerator. */ rubyParentOverhangAmount: RubyOverhang | NothingEnum; /** * The amount (as a percentage) to scale the parent text size to determine the * ruby text size. Can return: Real or NothingEnum enumerator. */ rubyParentScalingPercent: number | NothingEnum; /** * The ruby spacing relative to the parent text. . Can return: * RubyParentSpacing enumerator or NothingEnum enumerator. */ rubyParentSpacing: RubyParentSpacing | NothingEnum; /** * The position of ruby characters relative to the parent text. Can return: * RubyKentenPosition enumerator or NothingEnum enumerator. */ rubyPosition: RubyKentenPosition | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * ruby characters. Can return: Swatch, String or NothingEnum enumerator. */ rubyStroke: string | Swatch | NothingEnum; /** * The stroke tint (as a percentage) of ruby characters. Can return: Real or * NothingEnum enumerator. */ rubyStrokeTint: number | NothingEnum; /** * The tint (as a percentage) of the ruby fill color. (Range: 0 to 100). Can * return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ rubyTint: number | NothingEnum; /** * The ruby type. Can return: RubyTypes enumerator or NothingEnum enumerator. */ rubyType: RubyTypes | NothingEnum; /** * The stroke weight (in points) of ruby characters. Can return: Real or * NothingEnum enumerator. */ rubyWeight: number | NothingEnum; /** * The amount of horizontal space between ruby and parent characters. Can * return: Real or NothingEnum enumerator. */ rubyXOffset: number | NothingEnum; /** * The horizontal size of ruby characters, specified as a percent of the * original size. Can return: Real or NothingEnum enumerator. */ rubyXScale: number | NothingEnum; /** * The amount of vertical space between ruby and parent characters. Can return: * Real or NothingEnum enumerator. */ rubyYOffset: number | NothingEnum; /** * The vertical size of ruby characters, specified as a percent of the original * size. Can return: Real or NothingEnum enumerator. */ rubyYScale: number | NothingEnum; /** * If true, the line changes size when characters are scaled. . Can return: * Boolean or NothingEnum enumerator. */ scaleAffectsLineHeight: boolean | NothingEnum; /** * If true, applies shatai rotation. Can return: Boolean or NothingEnum * enumerator. */ shataiAdjustRotation: boolean | NothingEnum; /** * If true, adjusts shatai tsume. Can return: Boolean or NothingEnum * enumerator. */ shataiAdjustTsume: boolean | NothingEnum; /** * The shatai lens angle (in degrees). Can return: Real or NothingEnum * enumerator. */ shataiDegreeAngle: number | NothingEnum; /** * The amount (as a percentage) of shatai obliquing to apply. Can return: Real * or NothingEnum enumerator. */ shataiMagnification: number | NothingEnum; /** * The skew angle of the CharacterStyle. Can return: Real or NothingEnum * enumerator. */ skew: number | NothingEnum; /** * Split Document (EPUB only). Can return: Boolean or NothingEnum enumerator. */ splitDocument: boolean | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the * strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator. */ strikeThroughColor: string | Swatch | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator. */ strikeThroughGapColor: string | Swatch | NothingEnum; /** * If true, the gap color of the strikethrough stroke will overprint. Note: * Valid when strike through type is not solid. Can return: Boolean or * NothingEnum enumerator. */ strikeThroughGapOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 * to 100) Note: Valid when strike through type is not solid. Can return: Real * or NothingEnum enumerator. * @remarks Range: 0 to 100 */ strikeThroughGapTint: number | NothingEnum; /** * The amount by which to offset the strikethrough stroke from the text * baseline. Can return: Unit or NothingEnum enumerator. */ strikeThroughOffset: number | NothingEnum; /** * If true, the strikethrough stroke will overprint. Can return: Boolean or * NothingEnum enumerator. */ strikeThroughOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100). * Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ strikeThroughTint: number | NothingEnum; /** * The stroke type of the strikethrough stroke. Can return: StrokeStyle, String * or NothingEnum enumerator. */ strikeThroughType: string | StrokeStyle | NothingEnum; /** * The stroke weight of the strikethrough stroke. Can return: Unit or * NothingEnum enumerator. */ strikeThroughWeight: number | NothingEnum; /** * If true, draws a strikethrough line through the text. Can return: Boolean or * NothingEnum enumerator. */ strikeThru: boolean | NothingEnum; /** * The stroke alignment applied to the text. Can return: TextStrokeAlign * enumerator or NothingEnum enumerator. */ strokeAlignment: TextStrokeAlign | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the CharacterStyle. Can return: Swatch or NothingEnum enumerator. Can also * accept: String. */ strokeColor: string | Swatch | NothingEnum; /** * The tint (as a percentage) of the stroke color of the CharacterStyle. (To * specify a tint percentage, use a number in the range of 0 to 100; to use the * inherited or overridden value, use -1.). Can return: Real or NothingEnum * enumerator. * @remarks Range: 0 to 100 */ strokeTint: number | NothingEnum; /** * The stroke weight applied to the characters of the text. Can return: Unit or * NothingEnum enumerator. */ strokeWeight: number | NothingEnum; /** * A collection of style export tag maps. */ readonly styleExportTagMaps: StyleExportTagMaps; /** * A unique id that can be assigned to a style. This can be used to * differentiate between the styles. Internal use only. Can return: String or * NothingEnum enumerator. */ styleUniqueId: string | NothingEnum; /** * If true, makes the character horizontal in vertical text. Can return: * Boolean or NothingEnum enumerator. */ tatechuyoko: boolean | NothingEnum; /** * The horizontal offset for horizontal characters in vertical text. Can * return: Real or NothingEnum enumerator. */ tatechuyokoXOffset: number | NothingEnum; /** * The vertical offset for horizontal characters in vertical text. Can return: * Real or NothingEnum enumerator. */ tatechuyokoYOffset: number | NothingEnum; /** * The amount by which to loosen or tighten a block of text, specified in * thousands of an em. Can return: Real or NothingEnum enumerator. */ tracking: number | NothingEnum; /** * The amount of space after each character. Can return: Real or NothingEnum * enumerator. */ trailingAki: number | NothingEnum; /** * The amount of horizontal character compression. Can return: Real or * NothingEnum enumerator. */ tsume: number | NothingEnum; /** * If true, underlines the text. Can return: Boolean or NothingEnum enumerator. */ underline: boolean | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the underline * stroke. . Can return: Swatch, String or NothingEnum enumerator. */ underlineColor: string | Swatch | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * underline stroke. Note: Valid when underline type is not solid. Can return: * Swatch, String or NothingEnum enumerator. */ underlineGapColor: string | Swatch | NothingEnum; /** * If true, the gap color of the underline stroke will overprint. Can return: * Boolean or NothingEnum enumerator. */ underlineGapOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the gap color of the underline stroke. (Range: * 0 to 100) Note: Valid when underline type is not solid. Can return: Real or * NothingEnum enumerator. * @remarks Range: 0 to 100 */ underlineGapTint: number | NothingEnum; /** * The amount by which to offset the underline from the text baseline. Can * return: Unit or NothingEnum enumerator. */ underlineOffset: number | NothingEnum; /** * If true, the underline stroke color will overprint. Can return: Boolean or * NothingEnum enumerator. */ underlineOverprint: boolean | NothingEnum; /** * The underline stroke tint (as a percentage). (Range: 0 to 100). Can return: * Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ underlineTint: number | NothingEnum; /** * The stroke type of the underline stroke. Can return: StrokeStyle, String or * NothingEnum enumerator. */ underlineType: string | StrokeStyle | NothingEnum; /** * The stroke weight of the underline stroke. Can return: Unit or NothingEnum * enumerator. */ underlineWeight: number | NothingEnum; /** * The vertical scaling applied to the CharacterStyle. Can return: Real or * NothingEnum enumerator. */ verticalScale: number | NothingEnum; /** * If true, turns on warichu. Can return: Boolean or NothingEnum enumerator. */ warichu: boolean | NothingEnum; /** * The warichu alignment. Can return: WarichuAlignment enumerator or * NothingEnum enumerator. */ warichuAlignment: WarichuAlignment | NothingEnum; /** * The minimum number of characters allowed after a line break. . Can return: * Short Integer or NothingEnum enumerator. */ warichuCharsAfterBreak: number | NothingEnum; /** * The minimum number of characters allowed before a line break. Can return: * Short Integer or NothingEnum enumerator. */ warichuCharsBeforeBreak: number | NothingEnum; /** * The gap between lines of warichu characters. Can return: Real or NothingEnum * enumerator. */ warichuLineSpacing: number | NothingEnum; /** * The number of lines of warichu within a single normal line. Can return: * Short Integer or NothingEnum enumerator. */ warichuLines: number | NothingEnum; /** * The amount (as a percentage) to scale parent text size to determine warichu * size. Can return: Real or NothingEnum enumerator. */ warichuSize: number | NothingEnum; /** * The x (horizontal) offset for diacritic adjustment. Can return: Real or * NothingEnum enumerator. */ xOffsetDiacritic: number | NothingEnum; /** * The y (vertical) offset for diacritic adjustment. Can return: Real or * NothingEnum enumerator. */ yOffsetDiacritic: number | NothingEnum; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Create thumbnail for selected text with the given properties. * @param previewText Text to use as sample * @param pointSize Text font size (in points) * @param space Color space RGB, CMYK or LAB * @param colorValue Color values * @param to The path to the export file. */ createThumbnailWithProperties(previewText: string, pointSize: number, space: ColorSpace, colorValue: number[], to: File): boolean; /** * Duplicates the CharacterStyle. */ duplicate(): CharacterStyle; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): CharacterStyle[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * If true, Nth design axis of variable font is hidden. * @param nthAxisIndex Index of design axis. */ isNthDesignAxisHidden(nthAxisIndex: number): boolean; /** * Moves the style to the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: ParagraphStyle, ParagraphStyleGroup, CharacterStyle, CharacterStyleGroup, CellStyle, CellStyleGroup, TableStyle, TableStyleGroup, Document or Application. (Optional) */ move(to: LocationOptions, reference?: CellStyle | CellStyleGroup | CharacterStyle | CharacterStyleGroup | Document | ParagraphStyle | ParagraphStyleGroup | TableStyle | TableStyleGroup | Application): CharacterStyle; /** * Deletes the style. * @param replacingWith The style to apply in place of the deleted style. (Optional) */ remove(replacingWith?: CharacterStyle): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Set Nth design axis of a variable font. * @param nthAxisIndex Index of design axis. * @param nthAxisValue Value of nth design axis. */ setNthDesignAxis(nthAxisIndex: number, nthAxisValue: number): void; /** * Generates a string which, if executed, will return the CharacterStyle. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A character style group. */ declare class CharacterStyleGroup { /** * Lists all character styles (regardless of their group). */ readonly allCharacterStyles: CharacterStyle[]; /** * A collection of character style groups. */ readonly characterStyleGroups: CharacterStyleGroups; /** * A collection of character styles. */ readonly characterStyles: CharacterStyles; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the CharacterStyleGroup. */ readonly id: number; /** * The index of the CharacterStyleGroup within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the CharacterStyleGroup. */ name: string; /** * The parent of the CharacterStyleGroup (a Document, Application or * CharacterStyleGroup). */ readonly parent: Application | CharacterStyleGroup | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the CharacterStyleGroup. */ duplicate(): CharacterStyleGroup; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): CharacterStyleGroup[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Moves the style to the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: ParagraphStyle, ParagraphStyleGroup, CharacterStyle, CharacterStyleGroup, CellStyle, CellStyleGroup, TableStyle, TableStyleGroup, Document or Application. (Optional) */ move(to: LocationOptions, reference?: CellStyle | CellStyleGroup | CharacterStyle | CharacterStyleGroup | Document | ParagraphStyle | ParagraphStyleGroup | TableStyle | TableStyleGroup | Application): CharacterStyleGroup; /** * Deletes the style. * @param replacingWith The style to apply in place of the deleted style. Can accept: ParagraphStyle or CharacterStyle. (Optional) */ remove(replacingWith?: ParagraphStyle | CharacterStyle): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the CharacterStyleGroup. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of character style groups. */ declare class CharacterStyleGroups { /** Returns the CharacterStyleGroup with the specified index or name. */ [index: number]: CharacterStyleGroup; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new CharacterStyleGroup. * @param withProperties Initial values for properties of the new CharacterStyleGroup (Optional) */ add(withProperties?: Object): CharacterStyleGroup; /** * Returns any CharacterStyleGroup in the collection. */ anyItem(): CharacterStyleGroup; /** * Displays the number of elements in the CharacterStyleGroup. */ count(): number; /** * Returns every CharacterStyleGroup in the collection. */ everyItem(): CharacterStyleGroup; /** * Returns the first CharacterStyleGroup in the collection. */ firstItem(): CharacterStyleGroup; /** * Returns the CharacterStyleGroup with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): CharacterStyleGroup; /** * Returns the CharacterStyleGroup with the specified ID. * @param id The ID. */ itemByID(id: number): CharacterStyleGroup; /** * Returns the CharacterStyleGroup with the specified name. * @param name The name. */ itemByName(name: string): CharacterStyleGroup; /** * Returns the CharacterStyleGroups within the specified range. * @param from The CharacterStyleGroup, index, or name at the beginning of the range. Can accept: CharacterStyleGroup, Long Integer or String. * @param to The CharacterStyleGroup, index, or name at the end of the range. Can accept: CharacterStyleGroup, Long Integer or String. */ itemByRange(from: CharacterStyleGroup | number | string, to: CharacterStyleGroup | number | string): CharacterStyleGroup[]; /** * Returns the last CharacterStyleGroup in the collection. */ lastItem(): CharacterStyleGroup; /** * Returns the middle CharacterStyleGroup in the collection. */ middleItem(): CharacterStyleGroup; /** * Returns the CharacterStyleGroup whose index follows the specified * CharacterStyleGroup in the collection. * @param obj The CharacterStyleGroup whose index comes before the desired CharacterStyleGroup. */ nextItem(obj: CharacterStyleGroup): CharacterStyleGroup; /** * Returns the CharacterStyleGroup with the index previous to the specified * index. * @param obj The index of the CharacterStyleGroup that follows the desired CharacterStyleGroup. */ previousItem(obj: CharacterStyleGroup): CharacterStyleGroup; /** * Generates a string which, if executed, will return the CharacterStyleGroup. */ toSource(): string; } /** * A collection of character styles. */ declare class CharacterStyles { /** Returns the CharacterStyle with the specified index or name. */ [index: number]: CharacterStyle; /** * The number of objects in the collection. Can return: Long Integer or * NothingEnum enumerator. */ readonly length: number | NothingEnum; /** * Creates a new CharacterStyle. * @param withProperties Initial values for properties of the new CharacterStyle (Optional) */ add(withProperties?: Object): CharacterStyle; /** * Returns any CharacterStyle in the collection. */ anyItem(): CharacterStyle; /** * Displays the number of elements in the CharacterStyle. */ count(): number; /** * Returns every CharacterStyle in the collection. */ everyItem(): CharacterStyle; /** * Returns the first CharacterStyle in the collection. */ firstItem(): CharacterStyle; /** * Returns the CharacterStyle with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): CharacterStyle; /** * Returns the CharacterStyle with the specified ID. * @param id The ID. */ itemByID(id: number): CharacterStyle; /** * Returns the CharacterStyle with the specified name. * @param name The name. */ itemByName(name: string): CharacterStyle; /** * Returns the CharacterStyles within the specified range. * @param from The CharacterStyle, index, or name at the beginning of the range. Can accept: CharacterStyle, Long Integer or String. * @param to The CharacterStyle, index, or name at the end of the range. Can accept: CharacterStyle, Long Integer or String. */ itemByRange(from: CharacterStyle | number | string, to: CharacterStyle | number | string): CharacterStyle[]; /** * Returns the last CharacterStyle in the collection. */ lastItem(): CharacterStyle; /** * Returns the middle CharacterStyle in the collection. */ middleItem(): CharacterStyle; /** * Returns the CharacterStyle whose index follows the specified CharacterStyle * in the collection. * @param obj The CharacterStyle whose index comes before the desired CharacterStyle. */ nextItem(obj: CharacterStyle): CharacterStyle; /** * Returns the CharacterStyle with the index previous to the specified index. * @param obj The index of the CharacterStyle that follows the desired CharacterStyle. */ previousItem(obj: CharacterStyle): CharacterStyle; /** * Generates a string which, if executed, will return the CharacterStyle. */ toSource(): string; } /** * A collection of characters. */ declare class Characters { /** Returns the Character with the specified index or name. */ [index: number]: Character; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Character in the collection. */ anyItem(): Character; /** * Displays the number of elements in the Character. */ count(): number; /** * Returns every Character in the collection. */ everyItem(): Character; /** * Returns the first Character in the collection. */ firstItem(): Character; /** * Returns the Character with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Character; /** * Returns the Characters within the specified range. * @param from The Character, index, or name at the beginning of the range. Can accept: Character, Long Integer or String. * @param to The Character, index, or name at the end of the range. Can accept: Character, Long Integer or String. */ itemByRange(from: Character | number | string, to: Character | number | string): Character[]; /** * Returns the last Character in the collection. */ lastItem(): Character; /** * Returns the middle Character in the collection. */ middleItem(): Character; /** * Returns the Character whose index follows the specified Character in the * collection. * @param obj The Character whose index comes before the desired Character. */ nextItem(obj: Character): Character; /** * Returns the Character with the index previous to the specified index. * @param obj The index of the Character that follows the desired Character. */ previousItem(obj: Character): Character; /** * Generates a string which, if executed, will return the Character. */ toSource(): string; } /** * A checkbox. */ declare class CheckBox extends FormField { /** * Indicates whether the CheckBox has been flipped independently of its parent * object and, if yes, the direction in which the CheckBox was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the CheckBox relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the CheckBox relative to its containing object. * (Range: -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the CheckBox relative to its containing object. (Range: * -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the CheckBox relative to its containing object. */ absoluteVerticalScale: number; /** * The index of the active state in the object's states collection. */ activeStateIndex: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the CheckBox. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the CheckBox. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * Anchored object settings. */ readonly anchoredObjectSettings: AnchoredObjectSetting; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the CheckBox. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the CheckBox. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the CheckBox. */ readonly associatedXMLElement: XMLItem; /** * A collection of behavior objects. */ readonly behaviors: Behaviors; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * If true, the check box/radio button is selected by default in the exported * PDF. */ checkedByDefault: boolean; /** * A collection of clear form behavior objects. */ readonly clearFormBehaviors: ClearFormBehaviors; /** * Transparency settings for the content of the CheckBox. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The description of the CheckBox. */ description: string; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the CheckBox. */ endJoin: EndJoin; /** * A collection of EPS files. */ readonly epss: EPSs; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Export value for the check box/radio button in the exported PDF. */ exportValue: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * CheckBox. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the CheckBox's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the CheckBox. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the CheckBox excluding the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * A collection of goto anchor behavior objects. */ readonly gotoAnchorBehaviors: GotoAnchorBehaviors; /** * A collection of goto first page behavior objects. */ readonly gotoFirstPageBehaviors: GotoFirstPageBehaviors; /** * A collection of goto last page behavior objects. */ readonly gotoLastPageBehaviors: GotoLastPageBehaviors; /** * A collection of goto next page behavior objects. */ readonly gotoNextPageBehaviors: GotoNextPageBehaviors; /** * A collection of goto next view behavior objects. */ readonly gotoNextViewBehaviors: GotoNextViewBehaviors; /** * A collection of goto previous page behavior objects. */ readonly gotoPreviousPageBehaviors: GotoPreviousPageBehaviors; /** * A collection of goto previous view behavior objects. */ readonly gotoPreviousViewBehaviors: GotoPreviousViewBehaviors; /** * A collection of goto URL behavior objects. */ readonly gotoURLBehaviors: GotoURLBehaviors; /** * The angle of a linear gradient applied to the fill of the CheckBox. (Range: * -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the CheckBox. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the CheckBox, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the CheckBox. * (Range: -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the CheckBox. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the CheckBox, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * A collection of groups. */ readonly groups: Groups; /** * If true, the form field/push button is hidden until triggered in the * exported PDF. */ hiddenUntilTriggered: boolean; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the CheckBox. */ horizontalScale: number; /** * The unique ID of the CheckBox. */ readonly id: number; /** * A collection of bitmap images in any bitmap file format (including TIFF, * JPEG, or GIF). */ readonly images: Images; /** * The index of the CheckBox within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the CheckBox is on. */ itemLayer: Layer; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the CheckBox. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the CheckBox is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * A collection of movie behavior objects. */ readonly movieBehaviors: MovieBehaviors; /** * The name of the CheckBox. */ name: string; /** * If true, the CheckBox does not print. */ nonprinting: boolean; /** * A collection of open file behavior objects. */ readonly openFileBehaviors: OpenFileBehaviors; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the CheckBox's fill color overprints any underlying objects. If * false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the CheckBox's stroke color overprints any underlying objects. If * false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the CheckBox (a Snippet, PlaceGun, FlexObject, Character, * Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval or * Group). */ readonly parent: Character | FlexObject | GraphicLine | MasterSpread | Oval | PlaceGun | Polygon | Rectangle | SplineItem | Spread | Group | Snippet; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of PDF files. */ readonly pdfs: PDFs; /** * A collection of PICT graphics. */ readonly picts: PICTs; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A collection of print form behavior objects. */ readonly printFormBehaviors: PrintFormBehaviors; /** * If true, the form field/push button is printable in the exported PDF. */ printableInPdf: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, the form field is read only in the exported PDF. */ readOnly: boolean; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * If true, the form field is required in the exported PDF. */ required: boolean; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the CheckBox. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the CheckBox. (Range: -360 to 360) */ shearAngle: number; /** * A collection of show/hide fields behavior objects. */ readonly showHideFieldsBehaviors: ShowHideFieldsBehaviors; /** * A collection of sound behavior objects. */ readonly soundBehaviors: SoundBehaviors; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * A collection of states. */ readonly states: States; /** * The stroke alignment applied to the CheckBox. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the CheckBox. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the CheckBox. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the CheckBox's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of submit form behavior objects. */ readonly submitFormBehaviors: SubmitFormBehaviors; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the CheckBox. */ verticalScale: number; /** * A collection of view zoom behavior objects. */ readonly viewZoomBehaviors: ViewZoomBehaviors; /** * If true, the CheckBox is visible. */ visible: boolean; /** * The bounds of the CheckBox including the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * A collection of WMF graphics. */ readonly wmfs: WMFs; /** * Dispatched after a CheckBox is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a CheckBox is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the CheckBox's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the CheckBox that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Brings the CheckBox forward one level in its layer. */ bringForward(): void; /** * Brings the CheckBox to the front of its layer or in front of a particular * item. * @param reference The reference object to bring the object in front of (must have same parent) (Optional) */ bringToFront(reference?: PageItem): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the CheckBox. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the CheckBox to a different shape. * @param given The CheckBox's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Converts the button object to the page item currently in the active state. * Page items from other states will be lost. */ convertToObject(): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new CheckBox. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new CheckBox. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new CheckBox. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new CheckBox. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new CheckBox. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the CheckBox at the specified location or offset. * @param to The location of the new CheckBox, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new CheckBox from the original CheckBox's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the CheckBox. * @param given The axis around which to flip the CheckBox. * @param around The point around which to flip the CheckBox. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): CheckBox[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the CheckBox to a new location. Note: Either the 'to' or 'by' * parameter is required; if both parameters are defined, only the to value is * used. * @param to The new location of the CheckBox,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the CheckBox relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the CheckBox. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the CheckBox in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Sends the CheckBox back one level in its layer. */ sendBackward(): void; /** * Sends the CheckBox to the back of its layer or behind a particular item * (must have same parent). * @param reference The reference object to send the object behind (Optional) */ sendToBack(reference?: PageItem): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new CheckBox (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the CheckBox. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the CheckBox using the last transformation performed on any * object. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgain(): string[]; /** * Transforms the CheckBox using the last transformation performed on any * CheckBox. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgainIndividually(): string[]; /** * Transforms the CheckBox using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the CheckBox using the last sequence of transformations performed * on any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * A collection of checkboxes. */ declare class CheckBoxes { /** Returns the CheckBox with the specified index or name. */ [index: number]: CheckBox; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new CheckBox * @param layer The layer on which to create the CheckBox. (Optional) * @param at The location at which to insert the CheckBox relative to the reference object or within the container object. (Optional) * @param reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) * @param withProperties Initial values for properties of the new CheckBox (Optional) */ add(layer?: Layer, at?: LocationOptions, reference?: Document | Layer | MasterSpread | Page | Spread | PageItem, withProperties?: Object): CheckBox; /** * Returns any CheckBox in the collection. */ anyItem(): CheckBox; /** * Displays the number of elements in the CheckBox. */ count(): number; /** * Returns every CheckBox in the collection. */ everyItem(): CheckBox; /** * Returns the first CheckBox in the collection. */ firstItem(): CheckBox; /** * Returns the CheckBox with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): CheckBox; /** * Returns the CheckBox with the specified ID. * @param id The ID. */ itemByID(id: number): CheckBox; /** * Returns the CheckBox with the specified name. * @param name The name. */ itemByName(name: string): CheckBox; /** * Returns the CheckBoxes within the specified range. * @param from The CheckBox, index, or name at the beginning of the range. Can accept: CheckBox, Long Integer or String. * @param to The CheckBox, index, or name at the end of the range. Can accept: CheckBox, Long Integer or String. */ itemByRange(from: CheckBox | number | string, to: CheckBox | number | string): CheckBox[]; /** * Returns the last CheckBox in the collection. */ lastItem(): CheckBox; /** * Returns the middle CheckBox in the collection. */ middleItem(): CheckBox; /** * Returns the CheckBox whose index follows the specified CheckBox in the * collection. * @param obj The CheckBox whose index comes before the desired CheckBox. */ nextItem(obj: CheckBox): CheckBox; /** * Returns the CheckBox with the index previous to the specified index. * @param obj The index of the CheckBox that follows the desired CheckBox. */ previousItem(obj: CheckBox): CheckBox; /** * Generates a string which, if executed, will return the CheckBox. */ toSource(): string; } /** * A checkbox control. */ declare class CheckboxControl extends Widget { /** * If true, the control is checked by default in the dialog. */ checkedState: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the CheckboxControl. */ readonly id: number; /** * The index of the CheckboxControl within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The width of the control. For an editbox or combobox, specifies the minimum * width of the box. */ minWidth: number; /** * The parent of the CheckboxControl (a DialogColumn, DialogRow, EnablingGroup * or BorderPanel). */ readonly parent: DialogRow | EnablingGroup | BorderPanel | DialogColumn; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Text that appears in the CheckboxControl. */ staticLabel: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): CheckboxControl[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the CheckboxControl. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of checkbox controls. */ declare class CheckboxControls { /** Returns the CheckboxControl with the specified index or name. */ [index: number]: CheckboxControl; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new CheckboxControl. * @param withProperties Initial values for properties of the new CheckboxControl (Optional) */ add(withProperties?: Object): CheckboxControl; /** * Returns any CheckboxControl in the collection. */ anyItem(): CheckboxControl; /** * Displays the number of elements in the CheckboxControl. */ count(): number; /** * Returns every CheckboxControl in the collection. */ everyItem(): CheckboxControl; /** * Returns the first CheckboxControl in the collection. */ firstItem(): CheckboxControl; /** * Returns the CheckboxControl with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): CheckboxControl; /** * Returns the CheckboxControl with the specified ID. * @param id The ID. */ itemByID(id: number): CheckboxControl; /** * Returns the CheckboxControls within the specified range. * @param from The CheckboxControl, index, or name at the beginning of the range. Can accept: CheckboxControl, Long Integer or String. * @param to The CheckboxControl, index, or name at the end of the range. Can accept: CheckboxControl, Long Integer or String. */ itemByRange(from: CheckboxControl | number | string, to: CheckboxControl | number | string): CheckboxControl[]; /** * Returns the last CheckboxControl in the collection. */ lastItem(): CheckboxControl; /** * Returns the middle CheckboxControl in the collection. */ middleItem(): CheckboxControl; /** * Returns the CheckboxControl whose index follows the specified * CheckboxControl in the collection. * @param obj The CheckboxControl whose index comes before the desired CheckboxControl. */ nextItem(obj: CheckboxControl): CheckboxControl; /** * Returns the CheckboxControl with the index previous to the specified index. * @param obj The index of the CheckboxControl that follows the desired CheckboxControl. */ previousItem(obj: CheckboxControl): CheckboxControl; /** * Generates a string which, if executed, will return the CheckboxControl. */ toSource(): string; } /** * Character grid preferences. */ declare class CjkGridPreference extends Preference { /** * Applies the grid color to every nth cell, where n is the value of this * property. */ colorEveryNthCell: number; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, uses ICF mode for grid cells. If false, uses virtual body mode. */ icfMode: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layout grid color, specified either as an array of three doubles, each * in the range 0 to 255 and representing R, G, and B values, or as a UI color. * Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. */ layoutGridColorIndex: (number[][] | UIColors)[]; /** * The view magnification (as a percentage) less than which grids do not * appear. (Range: 5 to 4000) * @remarks Range: 5 to 4000 */ minimumScale: number; /** * The parent of the CjkGridPreference (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, displays the frame (story) grids. */ showAllFrameGrids: boolean; /** * If true, displays the layout grids. */ showAllLayoutGrids: boolean; /** * If true, displays the character count for the frame. */ showCharacterCount: boolean; /** * If true, applies the grid color from the the edge of the line. If false, * applies the grid color from the corner of the frame. */ singleLineColorMode: boolean; /** * If true, objects snap to the layout grid. */ snapToLayoutGrid: boolean; /** * If true, cell shape is circular. If false, cell shape is rectangular. */ useCircularCells: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): CjkGridPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the CjkGridPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A behavior object that clears the form fields in the document. */ declare class ClearFormBehavior extends Behavior { /** * The event which triggers the behavior. */ behaviorEvent: BehaviorEvents; /** * If true, the behavior is enabled. */ enableBehavior: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the ClearFormBehavior. */ readonly id: number; /** * The index of the ClearFormBehavior within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the ClearFormBehavior. */ readonly name: string; /** * The parent of the ClearFormBehavior (a Button, CheckBox, ComboBox, ListBox, * RadioButton, TextBox or SignatureField). */ readonly parent: CheckBox | ComboBox | ListBox | RadioButton | TextBox | Button | SignatureField; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ClearFormBehavior[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the ClearFormBehavior. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ClearFormBehavior. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of clear form behavior objects. */ declare class ClearFormBehaviors { /** Returns the ClearFormBehavior with the specified index or name. */ [index: number]: ClearFormBehavior; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new ClearFormBehavior. * @param withProperties Initial values for properties of the new ClearFormBehavior (Optional) */ add(withProperties?: Object): ClearFormBehavior; /** * Returns any ClearFormBehavior in the collection. */ anyItem(): ClearFormBehavior; /** * Displays the number of elements in the ClearFormBehavior. */ count(): number; /** * Returns every ClearFormBehavior in the collection. */ everyItem(): ClearFormBehavior; /** * Returns the first ClearFormBehavior in the collection. */ firstItem(): ClearFormBehavior; /** * Returns the ClearFormBehavior with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): ClearFormBehavior; /** * Returns the ClearFormBehavior with the specified ID. * @param id The ID. */ itemByID(id: number): ClearFormBehavior; /** * Returns the ClearFormBehavior with the specified name. * @param name The name. */ itemByName(name: string): ClearFormBehavior; /** * Returns the ClearFormBehaviors within the specified range. * @param from The ClearFormBehavior, index, or name at the beginning of the range. Can accept: ClearFormBehavior, Long Integer or String. * @param to The ClearFormBehavior, index, or name at the end of the range. Can accept: ClearFormBehavior, Long Integer or String. */ itemByRange(from: ClearFormBehavior | number | string, to: ClearFormBehavior | number | string): ClearFormBehavior[]; /** * Returns the last ClearFormBehavior in the collection. */ lastItem(): ClearFormBehavior; /** * Returns the middle ClearFormBehavior in the collection. */ middleItem(): ClearFormBehavior; /** * Returns the ClearFormBehavior whose index follows the specified * ClearFormBehavior in the collection. * @param obj The ClearFormBehavior whose index comes before the desired ClearFormBehavior. */ nextItem(obj: ClearFormBehavior): ClearFormBehavior; /** * Returns the ClearFormBehavior with the index previous to the specified * index. * @param obj The index of the ClearFormBehavior that follows the desired ClearFormBehavior. */ previousItem(obj: ClearFormBehavior): ClearFormBehavior; /** * Generates a string which, if executed, will return the ClearFormBehavior. */ toSource(): string; } /** * Clipboard preferences. */ declare class ClipboardPreference extends Preference { /** * If true, copies PDF to the clipboard. */ copyPDFToClipboard: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the ClipboardPreference (a Application). */ readonly parent: Application; /** * If true, objects cut or copied from different layers retain their layer * assignment when pasted. */ pasteRemembersLayers: boolean; /** * If true, pastes PDF if available. */ preferPDFWhenPasting: boolean; /** * If true, includes text attributes when pasting text. */ preferStyledTextWhenPasting: boolean; /** * If true, preserves PDF data on the system clipboard when the application * exits. */ preservePdfClipboardAtQuit: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, show auto style option. */ showAutoStyleOption: boolean; /** * If true, show paste options on paste. */ showPasteOptions: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ClipboardPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ClipboardPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Clipping path settings. */ declare class ClippingPathSettings extends Preference { /** * A list of the alpha channels stored in the graphic. */ readonly alphaChannelPathNames: string[]; /** * The name of the Photoshop path or alpha channel to use as a clipping path. */ appliedPathName: string; /** * The clipping path type. */ clippingType: ClippingPathType; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, creates interior clipping paths within the surrounding clipping * path. Note: Valid only when clipping type is alpha channel or detect edges. */ includeInsideEdges: boolean; /** * Shrinks the area enclosed by the clipping path by the specified amount. * (Range depends on the unit. For points: -10000 to 10000; picas: -833p4 to * 833p4; inches: -138.8889 to 138.8889; mm: -3527.778 to 3527.778; cm: * -352.7778 to 352.7778; ciceros: -781c11.889 to 781c11.889) * @remarks Measurement unit — also accepts a string such as "12mm". */ insetFrame: number | string; /** * If true, inverts the clipping path. */ invertPath: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the ClippingPathSettings (a Image, EPS, WMF, PICT, PDF or * ImportedPage). */ readonly parent: EPS | PDF | PICT | WMF | Image | ImportedPage; /** * A collection of paths. */ readonly paths: Paths; /** * A list of the clipping paths stored in the graphic. */ readonly photoshopPathNames: string[]; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, truncates the clipping path at the edge of the frame containing the * graphic. Note: Valid only when clipping type is alpha channel or detect * edges. */ restrictToFrame: boolean; /** * The lowest value (darkest) pixel to allow in the image. All pixels in the * image whose values are greater than (lighter than) the threshold value are * clipped (obscured). (Range: 0 to 255) Note: Valid only when clipping type is * detect edges or alpha channel. * @remarks Range: 0 to 255 */ threshold: number; /** * Specifies how similar a pixel's intensity value can be to the threshold * value before the pixel is obscured by the clipping path. (Range: 0 to 10) * Note: Valid only when clipping type is detect edges or alpha channel. * @remarks Range: 0 to 10 */ tolerance: number; /** * If true, uses the high-resolution version of the graphic to create the * clipping path. If false, calculates the clipping path based on * screen-display resolution. Note: Valid only when clipping type is detect * edges. */ useHighResolutionImage: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Converts the clipping path to a frame. */ convertToFrame(): PageItem; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ClippingPathSettings[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ClippingPathSettings. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * The type of clipping path to create. */ declare enum ClippingPathType { /** * The clipping path is based on an alpha channel defined for the graphic in a * graphics application. */ ALPHA_CHANNEL = 1634756707, /** * The clipping path is based on pixel value threshold and tolerance. */ DETECT_EDGES = 1685349735, /** * No clipping path applied. */ NONE = 1852796517, /** * The clipping path is defined for the graphic in Photoshop. */ PHOTOSHOP_PATH = 1886613620, /** * (Read-only) The clipping path has been manually edited. */ USER_MODIFIED_PATH = 1970106484, } /** * A color swatch. */ declare class Color extends Swatch { /** * The ink values that create the color, specified as a percentage for each * ink. Note: The number of values required and the range depends on the color * space. For RGB, specify three values, with each value in the range 0 to 255; * for CMYK, specify four values representing C, M, Y, and K, with each value * in the range 0 to 100; for LAB, specify three values representing L (Range: * 0 to 100), A (Range: -128 to 127), and B (Range: -128 to 127); for mixed * ink, specify values for each ink in the ink list, with each value in the * range 0 to 100. * @remarks Range: 0 to 100 */ colorValue: number[]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the Color. */ readonly id: number; /** * The index of the Color within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The color model. */ model: ColorModel; /** * The name of the Color. */ name: string; /** * The parent of the Color (a Application or Document). */ readonly parent: Application | Document; /** * The color group that a swatch belongs to */ readonly parentColorGroup: ColorGroup; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The color space. */ space: ColorSpace; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the Color. */ duplicate(): Color; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Color[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Merges the specified swatches with the swatch. * @param with_ The swatches to merge. Can accept: Array of Swatches, Swatch or String. */ merge(with_: (Swatches | Swatch | string)[]): Swatch; /** * Deletes the swatch. * @param replacingWith The swatch to apply in place of the deleted swatch. (Optional) */ remove(replacingWith?: Swatch): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Color. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A color group */ declare class ColorGroup { /** * A collection of color group swatches. */ readonly colorGroupSwatches: ColorGroupSwatches; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the ColorGroup. */ readonly id: number; /** * The index of the ColorGroup within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the ColorGroup. */ name: string; /** * The parent of the ColorGroup (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the ColorGroup. */ duplicate(): ColorGroup; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ColorGroup[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the ColorGroup. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ColorGroup. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Ungroups a color group */ ungroup(): void; } /** * A color group swatch. */ declare class ColorGroupSwatch { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the ColorGroupSwatch. */ readonly id: number; /** * The index of the ColorGroupSwatch within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the ColorGroupSwatch (a ColorGroup). */ readonly parent: ColorGroup; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The underlying swatch item */ readonly swatchItemRef: Swatch; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ColorGroupSwatch[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ColorGroupSwatch. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of color group swatches. */ declare class ColorGroupSwatches { /** Returns the ColorGroupSwatch with the specified index or name. */ [index: number]: ColorGroupSwatch; /** * The number of objects in the collection. */ readonly length: number; /** * Adds a color group swatch. * @param swatchItemRef swatch to be added to color group * @param withProperties Initial values for properties of the new ColorGroupSwatch (Optional) */ add(swatchItemRef: Swatch, withProperties?: Object): ColorGroupSwatch; /** * Returns any ColorGroupSwatch in the collection. */ anyItem(): ColorGroupSwatch; /** * Displays the number of elements in the ColorGroupSwatch. */ count(): number; /** * Returns every ColorGroupSwatch in the collection. */ everyItem(): ColorGroupSwatch; /** * Returns the first ColorGroupSwatch in the collection. */ firstItem(): ColorGroupSwatch; /** * Returns the ColorGroupSwatch with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): ColorGroupSwatch; /** * Returns the ColorGroupSwatch with the specified ID. * @param id The ID. */ itemByID(id: number): ColorGroupSwatch; /** * Returns the ColorGroupSwatches within the specified range. * @param from The ColorGroupSwatch, index, or name at the beginning of the range. Can accept: ColorGroupSwatch, Long Integer or String. * @param to The ColorGroupSwatch, index, or name at the end of the range. Can accept: ColorGroupSwatch, Long Integer or String. */ itemByRange(from: ColorGroupSwatch | number | string, to: ColorGroupSwatch | number | string): ColorGroupSwatch[]; /** * Returns the last ColorGroupSwatch in the collection. */ lastItem(): ColorGroupSwatch; /** * Returns the middle ColorGroupSwatch in the collection. */ middleItem(): ColorGroupSwatch; /** * Returns the ColorGroupSwatch whose index follows the specified * ColorGroupSwatch in the collection. * @param obj The ColorGroupSwatch whose index comes before the desired ColorGroupSwatch. */ nextItem(obj: ColorGroupSwatch): ColorGroupSwatch; /** * Returns the ColorGroupSwatch with the index previous to the specified index. * @param obj The index of the ColorGroupSwatch that follows the desired ColorGroupSwatch. */ previousItem(obj: ColorGroupSwatch): ColorGroupSwatch; /** * Generates a string which, if executed, will return the ColorGroupSwatch. */ toSource(): string; } /** * A collection of color groups. */ declare class ColorGroups { /** Returns the ColorGroup with the specified index or name. */ [index: number]: ColorGroup; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new ColorGroup * @param name The color group name (Optional) * @param swatchList The swatches to add in color group. (Optional) * @param withProperties Initial values for properties of the new ColorGroup (Optional) */ add(name?: string, swatchList?: Swatch[], withProperties?: Object): ColorGroup; /** * Returns any ColorGroup in the collection. */ anyItem(): ColorGroup; /** * Displays the number of elements in the ColorGroup. */ count(): number; /** * Returns every ColorGroup in the collection. */ everyItem(): ColorGroup; /** * Returns the first ColorGroup in the collection. */ firstItem(): ColorGroup; /** * Returns the ColorGroup with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): ColorGroup; /** * Returns the ColorGroup with the specified ID. * @param id The ID. */ itemByID(id: number): ColorGroup; /** * Returns the ColorGroup with the specified name. * @param name The name. */ itemByName(name: string): ColorGroup; /** * Returns the ColorGroups within the specified range. * @param from The ColorGroup, index, or name at the beginning of the range. Can accept: ColorGroup, Long Integer or String. * @param to The ColorGroup, index, or name at the end of the range. Can accept: ColorGroup, Long Integer or String. */ itemByRange(from: ColorGroup | number | string, to: ColorGroup | number | string): ColorGroup[]; /** * Returns the last ColorGroup in the collection. */ lastItem(): ColorGroup; /** * Returns the middle ColorGroup in the collection. */ middleItem(): ColorGroup; /** * Returns the ColorGroup whose index follows the specified ColorGroup in the * collection. * @param obj The ColorGroup whose index comes before the desired ColorGroup. */ nextItem(obj: ColorGroup): ColorGroup; /** * Returns the ColorGroup with the index previous to the specified index. * @param obj The index of the ColorGroup that follows the desired ColorGroup. */ previousItem(obj: ColorGroup): ColorGroup; /** * Generates a string which, if executed, will return the ColorGroup. */ toSource(): string; } /** * Color model options. */ declare enum ColorModel { /** * Mixed ink color. */ MIXEDINKMODEL = 1768844664, /** * Process color. */ PROCESS = 1886548851, /** * Registration color. */ REGISTRATION = 1919248243, /** * Spot color. */ SPOT = 1936748404, } /** * Color output mode options for composites. */ declare enum ColorOutputModes { /** * Sends full-color versions of the specified pages to the printer. Note: * Available only for PostScript printers. */ COMPOSITE_CMYK = 1668105035, /** * Sends grayscale versions of the specified pages to the printer. */ COMPOSITE_GRAY = 1668116583, /** * Sends a full-color version of the specified pages to the printer, preserving * all color values in the original document. Note: Cannot simulate overprint * when using this option. */ COMPOSITE_LEAVE_UNCHANGED = 1668107349, /** * Sends full-color versions of the specified pages to the printer. */ COMPOSITE_RGB = 1668108866, /** * Allows the printer to create color separations. Note: Valid only with a * PostScript raster image processing (RIP) device. */ INRIP_SEPARATIONS = 1919512691, /** * Sends PostScript information for each of the required separations to the * printer. Note: Available only for PostScript printers. */ SEPARATIONS = 1936027745, } /** * The color-rendering dictionary (CRD) to use. */ declare enum ColorRenderingDictionary { /** * Uses the default CRD. */ DEFAULT_VALUE = 1147563124, /** * Uses the document's CRD. */ USE_DOCUMENT = 1967419235, /** * Uses the working CRD. */ WORKING = 1466921579, } /** * Color management settings. */ declare class ColorSetting extends Preference { /** * If true, uses LAB alternates for spot colors when available. */ accurateLABSpots: boolean; /** * The current color management system settings configuration. Note: For * information on possible values, see CMS settings list. */ cmsSettings: string; /** * A list of valid color management system settings configurations. */ readonly cmsSettingsList: string[]; /** * The file path of the CSF file to use. */ cmsSettingsPath: File; /** * The policy for handling colors in a CMYK color model, including reading and * embedding color profiles, resolving mismatches between embedded color * profiles and the working space, and moving colors between documents. */ cmykPolicy: ColorSettingsPolicy; /** * If true, enables color management. */ enableColorManagement: boolean; /** * The color management module (CMM) for mapping color space gamuts between * documents. */ engine: string; /** * The available color engines. */ readonly engineList: string[]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, uses idealized black for CMYK-to-RGB or CMYK-to-Gray conversions to * print or export. */ idealizedBlackToExport: boolean; /** * If true, uses idealized black for CMYK-to-RGB or CMYK-to-Gray conversions to * the screen. */ idealizedBlackToScreen: boolean; /** * The default rendering intent. */ intent: DefaultRenderingIntent; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * If true, displays a prompt when opening a file whose embedded color profile * does not match the current working space. The prompt provides the option to * override the default mismatch behavior. */ mismatchAskWhenOpening: boolean; /** * If true, displays a prompt when importing an object (via pasting, * drag-and-drop, or other similar methods) whose colors do not match the * current working space. The prompt provides the option to override the * default mismatch behavior. */ mismatchAskWhenPasting: boolean; /** * If true, displays a prompt when opening a file that does not have an * embedded color profile. The prompt provides the option to assign a color * profile. */ missingAskWhenOpening: boolean; /** * The parent of the ColorSetting (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The policy for handling colors in an RGB color model, including reading and * embedding color profiles, handling mismatches between embedded color * profiles and the working space, and moving colors from one document to * another. */ rgbPolicy: ColorSettingsPolicy; /** * If true, uses black point compensation to ensure that shadow detail is * preserved by simulating the full dynamic range of the output device. */ useBPC: boolean; /** * The current CMYK profile. */ workingSpaceCMYK: string; /** * A list of valid CMYK color profiles. */ readonly workingSpaceCMYKList: string[]; /** * The current RGB profile. */ workingSpaceRGB: string; /** * A list of valid RGB color profiles. */ readonly workingSpaceRGBList: string[]; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ColorSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ColorSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * The policy for handling mismatched CMYK configurations. */ declare enum ColorSettingsPolicy { /** * Turns off color management for documents whose profiles do not match the * working space. For imported colors, numeric values override color * appearance. */ COLOR_POLICY_OFF = 1129344870, /** * Preserves raw color numbers and ignores embedded color profiles. */ COMBINATION_OF_PRESERVE_AND_SAFE_CMYK = 1129345124, /** * Converts newly opened documents to the current working space. For imported * colors, color appearance overrides numeric values. */ CONVERT_TO_WORKING_SPACE = 1129346931, /** * Preserves embedded color profiles in newly opened documents. */ PRESERVE_EMBEDDED_PROFILES = 1129345136, } /** * Color space options. */ declare enum ColorSpace { /** * CMYK. */ CMYK = 1129142603, /** * HSB. */ HSB = 1665684290, /** * LAB. */ LAB = 1665941826, /** * Mixed ink. */ MIXEDINK = 1666009432, /** * RGB. */ RGB = 1666336578, } /** * A collection of colors. */ declare class Colors { /** Returns the Color with the specified index or name. */ [index: number]: Color; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new Color. * @param withProperties Initial values for properties of the new Color (Optional) */ add(withProperties?: Object): Color; /** * Returns any Color in the collection. */ anyItem(): Color; /** * Displays the number of elements in the Color. */ count(): number; /** * Returns every Color in the collection. */ everyItem(): Color; /** * Returns the first Color in the collection. */ firstItem(): Color; /** * Returns the Color with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Color; /** * Returns the Color with the specified ID. * @param id The ID. */ itemByID(id: number): Color; /** * Returns the Color with the specified name. * @param name The name. */ itemByName(name: string): Color; /** * Returns the Colors within the specified range. * @param from The Color, index, or name at the beginning of the range. Can accept: Color, Long Integer or String. * @param to The Color, index, or name at the end of the range. Can accept: Color, Long Integer or String. */ itemByRange(from: Color | number | string, to: Color | number | string): Color[]; /** * Returns the last Color in the collection. */ lastItem(): Color; /** * Returns the middle Color in the collection. */ middleItem(): Color; /** * Returns the Color whose index follows the specified Color in the collection. * @param obj The Color whose index comes before the desired Color. */ nextItem(obj: Color): Color; /** * Returns the Color with the index previous to the specified index. * @param obj The index of the Color that follows the desired Color. */ previousItem(obj: Color): Color; /** * Generates a string which, if executed, will return the Color. */ toSource(): string; } /** * A table column. */ declare class Column { /** * If true, the height of the cell or the cells in the Column can increase or * decrease automatically to fit cell content. Note: Allows cells to grow or * shrink to the maximum or minimum height, if specified. */ autoGrow: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the bottom edge * border stroke. */ bottomEdgeStrokeColor: Swatch; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * bottom edge border stroke. Note: Not valid when bottom edge stroke type is * solid. */ bottomEdgeStrokeGapColor: Swatch; /** * If true, the gap color of the bottom edge border stroke will overprint. * Note: Not valid when bottom edge stroke type is solid. */ bottomEdgeStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the bottom edge border stroke gap color. * (Range: 0 to 100) Note: Not valid when bottom edge stroke type is solid. * @remarks Range: 0 to 100 */ bottomEdgeStrokeGapTint: number; /** * If true, the bottom edge border stroke will overprint. */ bottomEdgeStrokeOverprint: boolean; /** * The tint (as a percentage) of the bottom edge border stroke. */ bottomEdgeStrokeTint: number; /** * The stroke type of the bottom edge. Can also accept: String. */ bottomEdgeStrokeType: StrokeStyle | string; /** * The stroke weight of the bottom edge border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomEdgeStrokeWeight: number | string; /** * The bottom inset of the cell.The API has been deprecated. Use * TextBottomInset or GraphicBottomInset * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomInset: number | string; /** * A collection of table cells. */ readonly cells: Cells; /** * If true, clips the cell's content to width and height of the cell. The API * has been deprecated. Use ClipContentsToTextCell or * ClipContentsToPageItemCell */ clipContentToCell: boolean; /** * If true, clips the graphic cell's content to width and height of the cell. */ clipContentToGraphicCell: boolean; /** * If true, clips the text cell's content to width and height of the cell. */ clipContentToTextCell: boolean; /** * The number of columns that the object spans. */ readonly columnSpan: number; /** * The column type. */ columnType: ColumnTypes; /** * A collection of table columns. */ readonly columns: Columns; /** * The text contents. For rows or columns, when specified as a string, the * sting populates each cell in the row or column; when specified as an array, * the first value in the array populates the left-most cell in the row or the * top-most cell in the column; the next value populates the next cell to the * right (for rows) or the next lowest cell (for columns), and so on. Can * return: PageItem, String, SpecialCharacters enumerator or Array of Strings, * SpecialCharacters enumerators or PageItems. Can also accept: PageItem, * NothingEnum enumerator or Array of Strings, SpecialCharacters enumerators, * NothingEnum enumerators or PageItems. */ contents: (NothingEnum | NothingEnum[] | PageItem | SpecialCharacters | string | string[] | PageItems)[]; /** * If true, draws the diagonal line in front of cell contents. */ diagonalLineInFront: boolean; /** * The diagonal line color, specified as a swatch. */ diagonalLineStrokeColor: Swatch; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * diagonal line stroke. Note: Not valid when diagonal line stroke type is * solid. */ diagonalLineStrokeGapColor: Swatch; /** * If true, the stroke gap of the diagonal line will overprint. Note: Not valid * when diagonal line stroke type is solid. */ diagonalLineStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the diagonal line stroke gap color. Note: Not * valid when diagonal line stroke type is solid. */ diagonalLineStrokeGapTint: number; /** * If true, the diagonal line stroke will overprint. */ diagonalLineStrokeOverprint: boolean; /** * The diagonal line tint (as a percentage). (Range: 0 to 100) * @remarks Range: 0 to 100 */ diagonalLineStrokeTint: number; /** * The stroke type of the diagonal line(s). Can also accept: String. */ diagonalLineStrokeType: StrokeStyle | string; /** * The diagonal line stroke weight. * @remarks Measurement unit — also accepts a string such as "12mm". */ diagonalLineStrokeWeight: number | string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * object. Can also accept: String. */ fillColor: Swatch | string; /** * The tint (as a percentage) of the fill of the object. */ fillTint: number; /** * The distance between the baseline of the text and the top inset of the cell. */ firstBaselineOffset: FirstBaseline; /** * The angle of a linear gradient applied to the fill of the object. (Range: * -180 to 180) */ gradientFillAngle: number; /** * The length (of a linear gradient) or radius (of a radial gradient) applied * to the fill of the object. */ gradientFillLength: number; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the Column, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The bottom inset of the graphic cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ graphicBottomInset: number | string; /** * The left inset of the graphic cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ graphicLeftInset: number | string; /** * The right inset of the graphic cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ graphicRightInset: number | string; /** * The top inset of the graphic cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ graphicTopInset: number | string; /** * The height of the Column. For a table or column, specifies the sum of the * row heights. * @remarks Measurement unit — also accepts a string such as "12mm". */ height: number | string; /** * The index of the Column within its containing object. */ readonly index: number; /** * The color, specified as a swatch, of the inner column border stroke. */ innerColumnStrokeColor: Swatch; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * inner column border stroke. Note: Not valid when inner column stroke type is * solid. */ innerColumnStrokeGapColor: Swatch; /** * If true, the gap color of the inner column border stroke will overprint. * Note: Not valid when inner column stroke type is solid. */ innerColumnStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the inner column border stroke gap color. * (Range: 0 to 100) Note: Not valid when inner column stroke type is solid. * @remarks Range: 0 to 100 */ innerColumnStrokeGapTint: number; /** * If true, the inner column border stroke will overprint. */ innerColumnStrokeOverprint: boolean; /** * The tint (as a percentage) of the inner column border stroke. (Range: 0 to * 100) * @remarks Range: 0 to 100 */ innerColumnStrokeTint: number; /** * The stroke type of the inner column. Can also accept: String. */ innerColumnStrokeType: StrokeStyle | string; /** * The stroke weight of the inner column border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ innerColumnStrokeWeight: number | string; /** * The color, specified as a swatch, of the inner row border stroke. */ innerRowStrokeColor: Swatch; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * inner row border stroke. Note: Not valid when inner row stroke type is * solid. */ innerRowStrokeGapColor: Swatch; /** * If true, the gap color of the inner row border stroke will overprint. Note: * Not valid when inner row stroke type is solid. */ innerRowStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the inner row border stroke. (Range: 0 to 100) * Note: Not valid when inner row stroke type is solid. * @remarks Range: 0 to 100 */ innerRowStrokeGapTint: number; /** * If true, the inner row border stroke will overprint. */ innerRowStrokeOverprint: boolean; /** * The tint (as a percentage) of the inner row border stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ innerRowStrokeTint: number; /** * The stroke type of the inner row. Can also accept: String. */ innerRowStrokeType: StrokeStyle | string; /** * The stroke weight of the inner row border strokes. * @remarks Measurement unit — also accepts a string such as "12mm". */ innerRowStrokeWeight: number | string; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * If true, keeps the row with the next row when the table is split across text * frames or pages. */ keepWithNextRow: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the left edge * border stroke. */ leftEdgeStrokeColor: Swatch; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * left edge border stroke. Note: Not valid when left edge stroke type is * solid. */ leftEdgeStrokeGapColor: Swatch; /** * If true, the gap color of the left edge border stroke will overprint. Note: * Not valid when left edge stroke type is solid. */ leftEdgeStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the left edge border stroke gap color. (Range: * 0 to 100) Note: Not valid when left edge stroke type is solid. * @remarks Range: 0 to 100 */ leftEdgeStrokeGapTint: number; /** * If true, the left edge border stroke will overprint. */ leftEdgeStrokeOverprint: boolean; /** * The tint (as a percentage) of the left edge border stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ leftEdgeStrokeTint: number; /** * The stroke type of the left edge. Can also accept: String. */ leftEdgeStrokeType: StrokeStyle | string; /** * The stroke weight of the left edge border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ leftEdgeStrokeWeight: number | string; /** * The left inset of the cell.The API has been deprecated. Use TextLeftInset or * GraphicLeftInset * @remarks Measurement unit — also accepts a string such as "12mm". */ leftInset: number | string; /** * The maximum height to which cells in the Column may grow. Note: The maximum * height cannot be exceeded even when auto grow is set to true. Also, the * maximum height can affect redistribution. * @remarks Measurement unit — also accepts a string such as "12mm". */ maximumHeight: number | string; /** * The space between the baseline of the text and the top inset of the frame or * cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ minimumFirstBaselineOffset: number | string; /** * The minimum height of the cells in the Column. Note: When auto grow is true, * cells can automatically grow larger than this amount when content is added. * Also, the minimum height can affect redistribution. * @remarks Measurement unit — also accepts a string such as "12mm". */ minimumHeight: number | string; /** * The name of the Column. */ readonly name: string; /** * If true, the story has overset text. */ readonly overflows: boolean; /** * If true, the fill of the object will overprint. */ overprintFill: boolean; /** * The maximum space that can be added between paragraphs in a cell. Note: * Valid only when vertical justification is justified. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphSpacingLimit: number | string; /** * The parent of the Column (a Table). */ readonly parent: Table; /** * The parent column of the cell. */ readonly parentColumn: Column; /** * The parent row of the cell. */ readonly parentRow: Row; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The color, specified as a swatch, of the right edge border stroke. */ rightEdgeStrokeColor: Swatch; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * right edge border stroke. Note: Not valid when right edge stroke type is * solid. */ rightEdgeStrokeGapColor: Swatch; /** * If true, the gap color of the right edge border stroke will overprint. Note: * Not valid when right edge stroke type is solid. */ rightEdgeStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the right edge border stroke gap color. * (Range: 0 to 100) Note: Not valid when right edge stroke type is solid. * @remarks Range: 0 to 100 */ rightEdgeStrokeGapTint: number; /** * If true, the right edge border stroke will overprint. */ rightEdgeStrokeOverprint: boolean; /** * The tint (as a percentage) of the right edge border stroke. (Range: 0 to * 100) * @remarks Range: 0 to 100 */ rightEdgeStrokeTint: number; /** * The stroke type of the right edge. Can also accept: String. */ rightEdgeStrokeType: StrokeStyle | string; /** * The stroke weight of the right edge border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ rightEdgeStrokeWeight: number | string; /** * The right inset of the cell.The API has been deprecated. Use TextLeftInset * or GraphicRightInset * @remarks Measurement unit — also accepts a string such as "12mm". */ rightInset: number | string; /** * The rotation angle (in degrees) of the cell, specified as one of the * following values: 0, 90, 180, or 270. */ rotationAngle: number; /** * The number of rows that the object spans. */ readonly rowSpan: number; /** * The row type. */ rowType: RowTypes; /** * A collection of table rows. */ readonly rows: Rows; /** * Indicates where to start the row. */ startRow: StartParagraph; /** * The bottom inset of the text cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ textBottomInset: number | string; /** * The left inset of the text cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ textLeftInset: number | string; /** * The right inset of the text cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ textRightInset: number | string; /** * The top inset of the text cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ textTopInset: number | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the top edge * border stroke. */ topEdgeStrokeColor: Swatch; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * top edge border stroke. Note: Not valid when top edge stroke type is solid. */ topEdgeStrokeGapColor: Swatch; /** * If true, the gap color of the top edge border stroke will overprint. Note: * Not valid when top edge stroke type is solid. */ topEdgeStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the top edge border stroke gap color. (Range: * 0 to 100) Note: Not valid when top edge stroke type is solid. * @remarks Range: 0 to 100 */ topEdgeStrokeGapTint: number; /** * If true, the top edge border stroke will overprint. */ topEdgeStrokeOverprint: boolean; /** * The tint (as a percentage) of the top edge border stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ topEdgeStrokeTint: number; /** * The stroke type of the top edge. Can also accept: String. */ topEdgeStrokeType: StrokeStyle | string; /** * The stroke weight of the top edge border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ topEdgeStrokeWeight: number | string; /** * The top inset of the cell. The API has been deprecated. Use TextTopInset or * GraphicTopInset * @remarks Measurement unit — also accepts a string such as "12mm". */ topInset: number | string; /** * If true, draws a diagonal line starting from the top left. */ topLeftDiagonalLine: boolean; /** * If true, draws a diagonal line starting from the top right. */ topRightDiagonalLine: boolean; /** * The vertical alignment of cell. */ verticalJustification: VerticalJustification; /** * The width of the Column. For a table or row, specifies the sum of the column * widths. * @remarks Measurement unit — also accepts a string such as "12mm". */ width: number | string; /** * The direction of the text in the cell. */ writingDirection: HorizontalOrVertical; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Finds glyphs that match the find what value and replaces the glyphs with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value and replaces the text * with the change character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeTransliterate(reverseOrder?: boolean): Text[]; /** * Converts text to outlines. Each line of text becomes a polygon object. When * the converted text is a single letter that has no internal spaces or * detached parts, the polygon contains only a single path. Note: To determine * whether a font allows the creation of outlines, see allow outlines. * @param deleteOriginal If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) */ createOutlines(deleteOriginal?: boolean): PageItem[]; /** * Finds glyphs that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findTransliterate(reverseOrder?: boolean): Text[]; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Column[]; /** * Merges the cells. * @param with_ The cell(s) to merge with. Can accept: Cell, Row or Column. (Optional) */ merge(with_?: Cell | Row | Column): Cell; /** * Recomposes the text in the Column. */ recompose(): void; /** * Redistributes the specified range of Columns so that the Columns have a * uniform size. Note: The maximum or minimum height or width specified for * some of the cells in the range may prevent them from being exactly even. * @param using The direction in which to redistribute. * @param thru The last Column in the range. Can accept: Cell, Column or Row. (Optional) */ redistribute(using: HorizontalOrVertical, thru?: Cell | Column | Row): void; /** * Deletes the Column. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Selects the object. * @param existingSelection The selection status of the Column in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Splits the cell along the specified axis. * @param using The direction in which to split the cell. */ split(using: HorizontalOrVertical): void; /** * Generates a string which, if executed, will return the Column. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Unmerges all merged cells in the Column. */ unmerge(): Cell[]; } /** * The column type. */ declare enum ColumnTypes { /** * A regular body column. */ BODY_COLUMN = 1161978732, /** * A header column. Note: When setting column type as header column, the column * must be flush with the left or right edge of the table, or adjacent to an * existing header column on the same side. */ HEADER_COLUMN = 1162371948, } /** * A collection of table columns. */ declare class Columns { /** Returns the Column with the specified index or name. */ [index: number]: Column; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new Column. * @param at The Column's location relative to the reference object or within the table. (Optional) * @param reference The reference object. Note: The reference object must be within the table. Required only when the at value contains before or after. Can accept: Row, Column, Cell or Table. (Optional) * @param withProperties Initial values for properties of the new Column (Optional) */ add(at?: LocationOptions, reference?: Cell | Column | Row | Table, withProperties?: Object): any; /** * Returns any Column in the collection. */ anyItem(): Column; /** * Displays the number of elements in the Column. */ count(): number; /** * Returns every Column in the collection. */ everyItem(): Column; /** * Returns the first Column in the collection. */ firstItem(): Column; /** * Returns the Column with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Column; /** * Returns the Column with the specified name. * @param name The name. */ itemByName(name: string): Column; /** * Returns the Columns within the specified range. * @param from The Column, index, or name at the beginning of the range. Can accept: Column, Long Integer or String. * @param to The Column, index, or name at the end of the range. Can accept: Column, Long Integer or String. */ itemByRange(from: Column | number | string, to: Column | number | string): Column[]; /** * Returns the last Column in the collection. */ lastItem(): Column; /** * Returns the middle Column in the collection. */ middleItem(): Column; /** * Returns the Column whose index follows the specified Column in the * collection. * @param obj The Column whose index comes before the desired Column. */ nextItem(obj: Column): Column; /** * Returns the Column with the index previous to the specified index. * @param obj The index of the Column that follows the desired Column. */ previousItem(obj: Column): Column; /** * Generates a string which, if executed, will return the Column. */ toSource(): string; } /** * A combobox. */ declare class ComboBox extends FormField { /** * Indicates whether the ComboBox has been flipped independently of its parent * object and, if yes, the direction in which the ComboBox was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the ComboBox relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the ComboBox relative to its containing object. * (Range: -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the ComboBox relative to its containing object. (Range: * -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the ComboBox relative to its containing object. */ absoluteVerticalScale: number; /** * The index of the active state in the object's states collection. */ activeStateIndex: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the ComboBox. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the ComboBox. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * Anchored object settings. */ readonly anchoredObjectSettings: AnchoredObjectSetting; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The font family for the form field in the exported PDF. */ appliedFont: string; /** * The object style applied to the ComboBox. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the ComboBox. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the ComboBox. */ readonly associatedXMLElement: XMLItem; /** * A collection of behavior objects. */ readonly behaviors: Behaviors; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * The list of choices for combo and list boxes in the exported PDF. */ choiceList: string[]; /** * A collection of clear form behavior objects. */ readonly clearFormBehaviors: ClearFormBehaviors; /** * Transparency settings for the content of the ComboBox. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The description of the ComboBox. */ description: string; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the ComboBox. */ endJoin: EndJoin; /** * A collection of EPS files. */ readonly epss: EPSs; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * ComboBox. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the ComboBox's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the ComboBox. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * The font size for the form field in the exported PDF. */ fontSize: number; /** * The font style for the form field in the exported PDF. */ fontStyle: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the ComboBox excluding the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * A collection of goto anchor behavior objects. */ readonly gotoAnchorBehaviors: GotoAnchorBehaviors; /** * A collection of goto first page behavior objects. */ readonly gotoFirstPageBehaviors: GotoFirstPageBehaviors; /** * A collection of goto last page behavior objects. */ readonly gotoLastPageBehaviors: GotoLastPageBehaviors; /** * A collection of goto next page behavior objects. */ readonly gotoNextPageBehaviors: GotoNextPageBehaviors; /** * A collection of goto next view behavior objects. */ readonly gotoNextViewBehaviors: GotoNextViewBehaviors; /** * A collection of goto previous page behavior objects. */ readonly gotoPreviousPageBehaviors: GotoPreviousPageBehaviors; /** * A collection of goto previous view behavior objects. */ readonly gotoPreviousViewBehaviors: GotoPreviousViewBehaviors; /** * A collection of goto URL behavior objects. */ readonly gotoURLBehaviors: GotoURLBehaviors; /** * The angle of a linear gradient applied to the fill of the ComboBox. (Range: * -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the ComboBox. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the ComboBox, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the ComboBox. * (Range: -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the ComboBox. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the ComboBox, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * A collection of groups. */ readonly groups: Groups; /** * If true, the form field/push button is hidden until triggered in the * exported PDF. */ hiddenUntilTriggered: boolean; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the ComboBox. */ horizontalScale: number; /** * The unique ID of the ComboBox. */ readonly id: number; /** * A collection of bitmap images in any bitmap file format (including TIFF, * JPEG, or GIF). */ readonly images: Images; /** * The index of the ComboBox within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the ComboBox is on. */ itemLayer: Layer; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the ComboBox. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the ComboBox is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * A collection of movie behavior objects. */ readonly movieBehaviors: MovieBehaviors; /** * The name of the ComboBox. */ name: string; /** * If true, the ComboBox does not print. */ nonprinting: boolean; /** * A collection of open file behavior objects. */ readonly openFileBehaviors: OpenFileBehaviors; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the ComboBox's fill color overprints any underlying objects. If * false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the ComboBox's stroke color overprints any underlying objects. If * false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the ComboBox (a Snippet, PlaceGun, FlexObject, Character, * Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval or * Group). */ readonly parent: Character | FlexObject | GraphicLine | MasterSpread | Oval | PlaceGun | Polygon | Rectangle | SplineItem | Spread | Group | Snippet; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of PDF files. */ readonly pdfs: PDFs; /** * A collection of PICT graphics. */ readonly picts: PICTs; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A collection of print form behavior objects. */ readonly printFormBehaviors: PrintFormBehaviors; /** * If true, the form field/push button is printable in the exported PDF. */ printableInPdf: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, the form field is read only in the exported PDF. */ readOnly: boolean; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * If true, the form field is required in the exported PDF. */ required: boolean; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * If true, the form field has right to left text enabled in the exported PDF. */ rightToLeftField: boolean; /** * The rotatation angle of the ComboBox. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the ComboBox. (Range: -360 to 360) */ shearAngle: number; /** * A collection of show/hide fields behavior objects. */ readonly showHideFieldsBehaviors: ShowHideFieldsBehaviors; /** * If true, the choices would be sorted in the exported PDF. */ sortChoices: boolean; /** * A collection of sound behavior objects. */ readonly soundBehaviors: SoundBehaviors; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The stroke alignment applied to the ComboBox. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the ComboBox. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the ComboBox. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the ComboBox's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of submit form behavior objects. */ readonly submitFormBehaviors: SubmitFormBehaviors; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the ComboBox. */ verticalScale: number; /** * A collection of view zoom behavior objects. */ readonly viewZoomBehaviors: ViewZoomBehaviors; /** * If true, the ComboBox is visible. */ visible: boolean; /** * The bounds of the ComboBox including the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * A collection of WMF graphics. */ readonly wmfs: WMFs; /** * Dispatched after a ComboBox is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a ComboBox is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the ComboBox's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the ComboBox that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Brings the ComboBox forward one level in its layer. */ bringForward(): void; /** * Brings the ComboBox to the front of its layer or in front of a particular * item. * @param reference The reference object to bring the object in front of (must have same parent) (Optional) */ bringToFront(reference?: PageItem): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the ComboBox. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the ComboBox to a different shape. * @param given The ComboBox's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Converts the button object to the page item currently in the active state. * Page items from other states will be lost. */ convertToObject(): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new ComboBox. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new ComboBox. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new ComboBox. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new ComboBox. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new ComboBox. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the ComboBox at the specified location or offset. * @param to The location of the new ComboBox, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new ComboBox from the original ComboBox's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the ComboBox. * @param given The axis around which to flip the ComboBox. * @param around The point around which to flip the ComboBox. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ComboBox[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the ComboBox to a new location. Note: Either the 'to' or 'by' * parameter is required; if both parameters are defined, only the to value is * used. * @param to The new location of the ComboBox,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the ComboBox relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the ComboBox. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the ComboBox in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Sends the ComboBox back one level in its layer. */ sendBackward(): void; /** * Sends the ComboBox to the back of its layer or behind a particular item * (must have same parent). * @param reference The reference object to send the object behind (Optional) */ sendToBack(reference?: PageItem): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new ComboBox (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the ComboBox. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the ComboBox using the last transformation performed on any * object. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgain(): string[]; /** * Transforms the ComboBox using the last transformation performed on any * ComboBox. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgainIndividually(): string[]; /** * Transforms the ComboBox using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the ComboBox using the last sequence of transformations performed * on any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * A collection of comboboxes. */ declare class ComboBoxes { /** Returns the ComboBox with the specified index or name. */ [index: number]: ComboBox; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new ComboBox * @param layer The layer on which to create the ComboBox. (Optional) * @param at The location at which to insert the ComboBox relative to the reference object or within the container object. (Optional) * @param reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) * @param withProperties Initial values for properties of the new ComboBox (Optional) */ add(layer?: Layer, at?: LocationOptions, reference?: Document | Layer | MasterSpread | Page | Spread | PageItem, withProperties?: Object): ComboBox; /** * Returns any ComboBox in the collection. */ anyItem(): ComboBox; /** * Displays the number of elements in the ComboBox. */ count(): number; /** * Returns every ComboBox in the collection. */ everyItem(): ComboBox; /** * Returns the first ComboBox in the collection. */ firstItem(): ComboBox; /** * Returns the ComboBox with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): ComboBox; /** * Returns the ComboBox with the specified ID. * @param id The ID. */ itemByID(id: number): ComboBox; /** * Returns the ComboBox with the specified name. * @param name The name. */ itemByName(name: string): ComboBox; /** * Returns the ComboBoxes within the specified range. * @param from The ComboBox, index, or name at the beginning of the range. Can accept: ComboBox, Long Integer or String. * @param to The ComboBox, index, or name at the end of the range. Can accept: ComboBox, Long Integer or String. */ itemByRange(from: ComboBox | number | string, to: ComboBox | number | string): ComboBox[]; /** * Returns the last ComboBox in the collection. */ lastItem(): ComboBox; /** * Returns the middle ComboBox in the collection. */ middleItem(): ComboBox; /** * Returns the ComboBox whose index follows the specified ComboBox in the * collection. * @param obj The ComboBox whose index comes before the desired ComboBox. */ nextItem(obj: ComboBox): ComboBox; /** * Returns the ComboBox with the index previous to the specified index. * @param obj The index of the ComboBox that follows the desired ComboBox. */ previousItem(obj: ComboBox): ComboBox; /** * Generates a string which, if executed, will return the ComboBox. */ toSource(): string; } /** * Enum for status of the comment */ declare enum CommentStatusEnum { /** * Status is open */ OPEN_STATUS = 1634955120, /** * Status is resolved */ RESOLVED_STATUS = 1634955877, } /** * Enum for type of the comment */ declare enum CommentTypeEnum { /** * Type is arrow */ ARROW_TYPE = 1635017074, /** * Type is cloud */ CLOUD_TYPE = 1635017572, /** * Type is connected lines */ CONNECTED_LINES_TYPE = 1635017582, /** * Type is freeform drawing */ FREEFORM_DRAWING_TYPE = 1635018340, /** * Type is highlight text */ HIGHLIGHT_TEXT_TYPE = 1635018860, /** * Type is insert text */ INSERT_TEXT_TYPE = 1635019124, /** * Type is invalid comment type */ INVALID_COMMENT_TYPE = 1635019118, /** * Type is line segment */ LINE_SEGMENT_TYPE = 1635019891, /** * Type is oval */ OVAL_TYPE = 1635020662, /** * Type is polygon */ POLYGON_TYPE = 1635020908, /** * Type is rectangle */ RECTANGLE_TYPE = 1635021420, /** * Type is replace text */ REPLACE_TEXT_TYPE = 1635021428, /** * Type is squiggly text */ SQUIGGLY_TEXT_TYPE = 1635021681, /** * Type is stamp */ STAMP_TYPE = 1635021680, /** * Type is sticky note */ STICKY_NOTE_TYPE = 1635021678, /** * Type is strikethrough text */ STRIKETHROUGH_TEXT_TYPE = 1635021682, /** * Type is text box */ TEXT_BOX_TYPE = 1635021922, /** * Type is text callout */ TEXT_CALLOUT_TYPE = 1635021923, /** * Type is text typewriter */ TEXT_TYPEWRITER_TYPE = 1635021940, /** * Type is underline text */ UNDERLINE_TEXT_TYPE = 1635022188, } /** * Hyphenation exceptions list options for composing text. */ declare enum ComposeUsing { /** * Uses the lists stored in both the document and the user dictionary. */ BOTH = 1651471464, /** * Uses the list stored in the document. */ USE_DOCUMENT = 1967419235, /** * Uses the list stored in the external user dictionary. */ USE_USER_DICTIONARY = 1433629284, } /** * A composite font. */ declare class CompositeFont { /** * A collection of composite font entries. */ readonly compositeFontEntries: CompositeFontEntries; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the CompositeFont. */ readonly id: number; /** * The index of the CompositeFont within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the CompositeFont. */ name: string; /** * The parent of the CompositeFont (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): CompositeFont[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the CompositeFont. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the CompositeFont. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of composite font entries. */ declare class CompositeFontEntries { /** Returns the CompositeFontEntry with the specified index or name. */ [index: number]: CompositeFontEntry; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new CompositeFontEntry. * @param withProperties Initial values for properties of the new CompositeFontEntry (Optional) */ add(withProperties?: Object): CompositeFontEntry; /** * Returns any CompositeFontEntry in the collection. */ anyItem(): CompositeFontEntry; /** * Displays the number of elements in the CompositeFontEntry. */ count(): number; /** * Returns every CompositeFontEntry in the collection. */ everyItem(): CompositeFontEntry; /** * Returns the first CompositeFontEntry in the collection. */ firstItem(): CompositeFontEntry; /** * Returns the CompositeFontEntry with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): CompositeFontEntry; /** * Returns the CompositeFontEntry with the specified ID. * @param id The ID. */ itemByID(id: number): CompositeFontEntry; /** * Returns the CompositeFontEntry with the specified name. * @param name The name. */ itemByName(name: string): CompositeFontEntry; /** * Returns the CompositeFontEntries within the specified range. * @param from The CompositeFontEntry, index, or name at the beginning of the range. Can accept: CompositeFontEntry, Long Integer or String. * @param to The CompositeFontEntry, index, or name at the end of the range. Can accept: CompositeFontEntry, Long Integer or String. */ itemByRange(from: CompositeFontEntry | number | string, to: CompositeFontEntry | number | string): CompositeFontEntry[]; /** * Returns the last CompositeFontEntry in the collection. */ lastItem(): CompositeFontEntry; /** * Returns the middle CompositeFontEntry in the collection. */ middleItem(): CompositeFontEntry; /** * Returns the CompositeFontEntry whose index follows the specified * CompositeFontEntry in the collection. * @param obj The CompositeFontEntry whose index comes before the desired CompositeFontEntry. */ nextItem(obj: CompositeFontEntry): CompositeFontEntry; /** * Returns the CompositeFontEntry with the index previous to the specified * index. * @param obj The index of the CompositeFontEntry that follows the desired CompositeFontEntry. */ previousItem(obj: CompositeFontEntry): CompositeFontEntry; /** * Generates a string which, if executed, will return the CompositeFontEntry. */ toSource(): string; } /** * A composite font entry. */ declare class CompositeFontEntry { /** * The font applied to the CompositeFontEntry, specified as either a font * object or the name of font family. Can return: Font or String. */ appliedFont: Font | string; /** * The amount of baseline shift. */ baselineShift: number; /** * The characters that the set affects. */ customCharacters: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The name of the font style. */ fontStyle: string; /** * The horizontal scaling applied to the CompositeFontEntry. */ horizontalScale: number; /** * The unique ID of the CompositeFontEntry. */ readonly id: number; /** * The index of the CompositeFontEntry within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * If true, the CompositeFontEntry is locked. */ readonly locked: boolean; /** * The name of the CompositeFontEntry. */ name: string; /** * The parent of the CompositeFontEntry (a CompositeFont). */ readonly parent: CompositeFont; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The size of the entry relative to the base entry. Note: The base entry * cannot be modified. */ relativeSize: number; /** * If true, scales characters from the center. */ scaleOption: boolean; /** * The vertical scaling applied to the CompositeFontEntry. */ verticalScale: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): CompositeFontEntry[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the CompositeFontEntry. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the CompositeFontEntry. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of composite fonts. */ declare class CompositeFonts { /** Returns the CompositeFont with the specified index or name. */ [index: number]: CompositeFont; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new CompositeFont. * @param withProperties Initial values for properties of the new CompositeFont (Optional) */ add(withProperties?: Object): CompositeFont; /** * Returns any CompositeFont in the collection. */ anyItem(): CompositeFont; /** * Displays the number of elements in the CompositeFont. */ count(): number; /** * Returns every CompositeFont in the collection. */ everyItem(): CompositeFont; /** * Returns the first CompositeFont in the collection. */ firstItem(): CompositeFont; /** * Returns the CompositeFont with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): CompositeFont; /** * Returns the CompositeFont with the specified ID. * @param id The ID. */ itemByID(id: number): CompositeFont; /** * Returns the CompositeFont with the specified name. * @param name The name. */ itemByName(name: string): CompositeFont; /** * Returns the CompositeFonts within the specified range. * @param from The CompositeFont, index, or name at the beginning of the range. Can accept: CompositeFont, Long Integer or String. * @param to The CompositeFont, index, or name at the end of the range. Can accept: CompositeFont, Long Integer or String. */ itemByRange(from: CompositeFont | number | string, to: CompositeFont | number | string): CompositeFont[]; /** * Returns the last CompositeFont in the collection. */ lastItem(): CompositeFont; /** * Returns the middle CompositeFont in the collection. */ middleItem(): CompositeFont; /** * Returns the CompositeFont whose index follows the specified CompositeFont in * the collection. * @param obj The CompositeFont whose index comes before the desired CompositeFont. */ nextItem(obj: CompositeFont): CompositeFont; /** * Returns the CompositeFont with the index previous to the specified index. * @param obj The index of the CompositeFont that follows the desired CompositeFont. */ previousItem(obj: CompositeFont): CompositeFont; /** * Generates a string which, if executed, will return the CompositeFont. */ toSource(): string; } /** * The amount and type of compression to use for bitmap images. */ declare enum CompressionQuality { /** * Uses 8-bit compression. Valid only when bitmap compression is ZIP. */ EIGHT_BIT = 1701722210, /** * Uses 4-bit compression. Valid only when bitmap compression is ZIP. */ FOUR_BIT = 1701721186, /** * Uses high compression. Not valid when bitmap compression is ZIP. */ HIGH = 1701726313, /** * Uses low compression. Not valid when bitmap compression is ZIP. */ LOW = 1701727351, /** * Uses maximum compression. Not valid when bitmap compression is ZIP. */ MAXIMUM = 1701727608, /** * Uses medium compression. Not valid when bitmap compression is ZIP. */ MEDIUM = 1701727588, /** * Uses minimum compression. Not valid when bitmap compression is ZIP. */ MINIMUM = 1701727598, } /** * A condition for conditional text. */ declare class Condition { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the Condition. */ readonly id: number; /** * The index of the Condition within its containing object. */ readonly index: number; /** * The color for the condition indicator; specified either as an array of three * doubles representing RGB values in the range 0 to 255, or as a UI color. Can * return: Array of 3 Reals (0 - 255) or UIColors enumerator. */ indicatorColor: (number[][] | UIColors)[]; /** * The condition indicator method. */ indicatorMethod: ConditionIndicatorMethod; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the Condition. */ name: string; /** * The parent of the Condition (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The condition underline indicator appearance. */ underlineIndicatorAppearance: ConditionUnderlineIndicatorAppearance; /** * If true, the Condition is visible. */ visible: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Condition[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Delete the condition. * @param replacingWith The condition to apply to text in place of the deleted condition. By default, no condition is applied in place of the deleted condition. Can accept: Condition or String. (Optional) */ remove(replacingWith?: Condition | string): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Condition. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for the condition indicator method. */ declare enum ConditionIndicatorMethod { /** * Highlights conditional text. */ USE_HIGHLIGHT = 1699244391, /** * Underlines conditional text. */ USE_UNDERLINE = 1700097644, } /** * Condition indicator mode options. */ declare enum ConditionIndicatorMode { /** * Conditions indicators hide. */ HIDE_INDICATORS = 1698908520, /** * Conditions indicators show and print. */ SHOW_AND_PRINT_INDICATORS = 1698908528, /** * Condition indicators show only. */ SHOW_INDICATORS = 1698908531, } /** * A condition set for conditional text. */ declare class ConditionSet { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the ConditionSet. */ readonly id: number; /** * The index of the ConditionSet within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the ConditionSet. */ name: string; /** * The parent of the ConditionSet (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * List of conditions and visibilities in the set. Can return: Ordered array * containing condition:Condition, visibility:Boolean. */ setConditions: (any[] | boolean)[]; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ConditionSet[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Redefine a condition set with the currently existing conditions and * visibilities. */ redefine(): void; /** * Delete a condition set for conditional text. * @param replacingWith The condition set to apply to the text in place of the deleted condition set. By default, no condition set is applied in place of the deleted condition set. Can accept: ConditionSet or String. (Optional) */ remove(replacingWith?: ConditionSet | string): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ConditionSet. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of condition sets for conditional text. */ declare class ConditionSets { /** Returns the ConditionSet with the specified index or name. */ [index: number]: ConditionSet; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new ConditionSet. * @param withProperties Initial values for properties of the new ConditionSet (Optional) */ add(withProperties?: Object): ConditionSet; /** * Returns any ConditionSet in the collection. */ anyItem(): ConditionSet; /** * Displays the number of elements in the ConditionSet. */ count(): number; /** * Returns every ConditionSet in the collection. */ everyItem(): ConditionSet; /** * Returns the first ConditionSet in the collection. */ firstItem(): ConditionSet; /** * Returns the ConditionSet with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): ConditionSet; /** * Returns the ConditionSet with the specified ID. * @param id The ID. */ itemByID(id: number): ConditionSet; /** * Returns the ConditionSet with the specified name. * @param name The name. */ itemByName(name: string): ConditionSet; /** * Returns the ConditionSets within the specified range. * @param from The ConditionSet, index, or name at the beginning of the range. Can accept: ConditionSet, Long Integer or String. * @param to The ConditionSet, index, or name at the end of the range. Can accept: ConditionSet, Long Integer or String. */ itemByRange(from: ConditionSet | number | string, to: ConditionSet | number | string): ConditionSet[]; /** * Returns the last ConditionSet in the collection. */ lastItem(): ConditionSet; /** * Returns the middle ConditionSet in the collection. */ middleItem(): ConditionSet; /** * Returns the ConditionSet whose index follows the specified ConditionSet in * the collection. * @param obj The ConditionSet whose index comes before the desired ConditionSet. */ nextItem(obj: ConditionSet): ConditionSet; /** * Returns the ConditionSet with the index previous to the specified index. * @param obj The index of the ConditionSet that follows the desired ConditionSet. */ previousItem(obj: ConditionSet): ConditionSet; /** * Generates a string which, if executed, will return the ConditionSet. */ toSource(): string; } /** * Options for the condition underline indicator appearance. */ declare enum ConditionUnderlineIndicatorAppearance { /** * Dashed underline. */ DASHED = 1684108136, /** * Solid underline. */ SOLID = 1936682084, /** * Wavy underline. */ WAVY = 1937208953, } /** * Conditional text preferences. */ declare class ConditionalTextPreference extends Preference { /** * The currently active condition set. */ activeConditionSet: ConditionSet; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the ConditionalTextPreference (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Shows or hides condition indicators. */ showConditionIndicators: ConditionIndicatorMode; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ConditionalTextPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * ConditionalTextPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of conditions for conditional text. */ declare class Conditions { /** Returns the Condition with the specified index or name. */ [index: number]: Condition; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new Condition. * @param withProperties Initial values for properties of the new Condition (Optional) */ add(withProperties?: Object): Condition; /** * Returns any Condition in the collection. */ anyItem(): Condition; /** * Displays the number of elements in the Condition. */ count(): number; /** * Returns every Condition in the collection. */ everyItem(): Condition; /** * Returns the first Condition in the collection. */ firstItem(): Condition; /** * Returns the Condition with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Condition; /** * Returns the Condition with the specified ID. * @param id The ID. */ itemByID(id: number): Condition; /** * Returns the Condition with the specified name. * @param name The name. */ itemByName(name: string): Condition; /** * Returns the Conditions within the specified range. * @param from The Condition, index, or name at the beginning of the range. Can accept: Condition, Long Integer or String. * @param to The Condition, index, or name at the end of the range. Can accept: Condition, Long Integer or String. */ itemByRange(from: Condition | number | string, to: Condition | number | string): Condition[]; /** * Returns the last Condition in the collection. */ lastItem(): Condition; /** * Returns the middle Condition in the collection. */ middleItem(): Condition; /** * Returns the Condition whose index follows the specified Condition in the * collection. * @param obj The Condition whose index comes before the desired Condition. */ nextItem(obj: Condition): Condition; /** * Returns the Condition with the index previous to the specified index. * @param obj The index of the Condition that follows the desired Condition. */ previousItem(obj: Condition): Condition; /** * Generates a string which, if executed, will return the Condition. */ toSource(): string; } /** * The container type. */ declare enum ContainerType { /** * The container contains alternative values of which only one can be used. */ ALT = 1298424180, /** * The container contains unordered items. */ BAG = 1298424423, /** * The container contains ordered or sequential items. */ SEQ = 1298428785, } /** * Represents the content placer object. */ declare class ContentPlacerObject extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * Whether the Content Placer is currently loaded with content for placing. */ readonly loaded: boolean; /** * The parent of the ContentPlacerObject (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ContentPlacerObject[]; /** * Load the Content Placer with one or more objects. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ load(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ContentPlacerObject. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Transparency settings for the content of the parent object. */ declare class ContentTransparencySetting extends Preference { /** * Settings related to the bevel and emboss effect. */ readonly bevelAndEmbossSettings: BevelAndEmbossSetting; /** * Blending mode settings. */ readonly blendingSettings: BlendingSetting; /** * Settings related to the directional feather effect. */ readonly directionalFeatherSettings: DirectionalFeatherSetting; /** * Settings related to the drop shadow effect. */ readonly dropShadowSettings: DropShadowSetting; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Settings related to the feather effect. */ readonly featherSettings: FeatherSetting; /** * Settings related to the gradient feather effect. */ readonly gradientFeatherSettings: GradientFeatherSetting; /** * Settings related to the inner glow effect. */ readonly innerGlowSettings: InnerGlowSetting; /** * Settings related to the inner shadow effect. */ readonly innerShadowSettings: InnerShadowSetting; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * Settings related to the outer glow effect. */ readonly outerGlowSettings: OuterGlowSetting; /** * The parent of the ContentTransparencySetting (a PageItem, HtmlItem, * FlexObject, FormField, SignatureField, TextBox, RadioButton, ListBox, * ComboBox, CheckBox, MultiStateObject, Button, MediaItem, Sound, Movie, * EPSText, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Graphic, SVG, * ImportedPage, PICT, WMF, PDF, EPS, Image, Group, TextFrame, * EndnoteTextFrame, PageItemDefault or ObjectStyle). */ readonly parent: Button | CheckBox | ComboBox | EPS | EPSText | EndnoteTextFrame | FlexObject | FormField | Graphic | GraphicLine | Group | HtmlItem | Image | ImportedPage | ListBox | MediaItem | Movie | MultiStateObject | Oval | PDF | PICT | PageItemDefault | Polygon | RadioButton | Rectangle | SVG | SignatureField | Sound | SplineItem | TextBox | TextFrame | WMF | ObjectStyle | PageItem; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Settings related to the satin effect */ readonly satinSettings: SatinSetting; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ContentTransparencySetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * ContentTransparencySetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * The content type of an object. */ declare enum ContentType { /** * The frame is a graphics frame. */ GRAPHIC_TYPE = 1735553140, /** * The frame is a text frame. */ TEXT_TYPE = 1952412773, /** * No content type assigned. */ UNASSIGNED = 1970168179, } /** * A contour option. */ declare class ContourOption extends Preference { /** * A list of the alpha channels stored in the graphic. */ readonly alphaChannelPathNames: string[]; /** * The alpha index used by contour options. */ contourAlphaIndex: number; /** * The embedded path index used by contour options. */ contourPathIndex: number; /** * The alpha channel or Photoshop path to use for the contour option. Valid * only when the contour options is photoshop path or alpha channel. */ contourPathName: string; /** * The contour threshold. */ contourThreshold: number; /** * The contour tolerance. */ contourTolerance: number; /** * The contour type. */ contourType: ContourOptionsTypes; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, creates interior clipping paths within the surrounding clipping * path. Note: Valid only when clipping type is alpha channel or detect edges. */ includeInsideEdges: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the ContourOption (a TextWrapPreference). */ readonly parent: TextWrapPreference; /** * A list of the clipping paths stored in the graphic. */ readonly photoshopPathNames: string[]; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ContourOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ContourOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * The path on which to base the contour text wrap. */ declare enum ContourOptionsTypes { /** * Sets the text wrap shape to the edges of the specified alpha channel. To * specify the alpha channel, see contour path name. */ ALPHA_CHANNEL = 1634756707, /** * Sets the text wrap shape to the object's bounding box. */ BOUNDING_BOX = 1701732962, /** * Sets the text wrap shape to the edges of the image. */ DETECT_EDGES = 1685349735, /** * Sets the text wrap shape to the wrapped object's graphics frame. */ GRAPHIC_FRAME = 1701734246, /** * Sets the text wrap shape to the specified Photoshop path. To specify the * Photoshop path, see contour path name. */ PHOTOSHOP_PATH = 1886613620, /** * Sets the text wrap shape to the clipping path (if any) defined in Photoshop. * Note: A path cannot be specified using this enumeration. To set the text * wrap shape to a specific path, use the photoshop path contour options type * enumeration value. */ SAME_AS_CLIPPING = 1935762288, /** * The Smart Text Wrap selects the key Subject in the content based on Adobe * Sensei. */ SELECT_SUBJECT = 1685087092, } /** * Options for converting manual page breaks. */ declare enum ConvertPageBreaks { /** * Converts manual page breaks to column breaks. */ COLUMN_BREAK = 1396927554, /** * Does not preserve page breaks; allows text to flow. */ NONE = 1852796517, /** * Preserves page breaks. */ PAGE_BREAK = 1397778242, } /** * Options for indicating the type of shape to which to covert an object. */ declare enum ConvertShapeOptions { /** * Converts the object to a rectangle with beveled corners. */ CONVERT_TO_BEVELED_RECTANGLE = 1129529938, /** * Converts the object to a closed path. */ CONVERT_TO_CLOSED_PATH = 1129530224, /** * Converts the object to a rectangle with inverse rounded corners. */ CONVERT_TO_INVERSE_ROUNDED_RECTANGLE = 1129531730, /** * Converts the object to a line that connects the upper left and lower right * corners of the object's bounding box. */ CONVERT_TO_LINE = 1129532489, /** * Converts the object to an open path. */ CONVERT_TO_OPEN_PATH = 1129533296, /** * Converts the object to an ellipse. */ CONVERT_TO_OVAL = 1129533270, /** * Converts the object to a polygon. */ CONVERT_TO_POLYGON = 1129533519, /** * Converts the object to a rectangle. */ CONVERT_TO_RECTANGLE = 1129534021, /** * Converts the object to a rectangle with rounded corners. */ CONVERT_TO_ROUNDED_RECTANGLE = 1129534034, /** * Converts the object to straight line. If the object is a square, circle, or * its bounding box is wider than it is tall, the line is horizontal and * connects the center points on the vertical sides of the bounding box. If the * object's bounding box is taller than it is wide, the line connects the * center points of the horizontal sides of the bounding box. */ CONVERT_TO_STRAIGHT_LINE = 1129534284, /** * Converts the object to a triangle. */ CONVERT_TO_TRIANGLE = 1129534546, } /** * Options for converting tables. */ declare enum ConvertTablesOptions { /** * Convert tables to unformatted, tab-delimited text. */ UNFORMATTED_TABBED_TEXT = 1398101076, /** * Converts tables to basic, unformatted tables. */ UNFORMATTED_TABLE = 1396921684, } /** * Coordinate space options. */ declare enum CoordinateSpaces { /** * Inner coordinates */ INNER_COORDINATES = 2021222766, /** * Page coordinates. */ PAGE_COORDINATES = 2021224551, /** * Parent coordinates */ PARENT_COORDINATES = 2021224545, /** * Pasteboard coordinates */ PASTEBOARD_COORDINATES = 2021224546, /** * Spread coordinates. */ SPREAD_COORDINATES = 2021225328, } /** * The copyright status of the document. */ declare enum CopyrightStatus { /** * The document is in the public domain. */ NO = 1852776480, /** * The copyright status is unknown. */ UNKNOWN = 1433299822, /** * The document is copyrighted. */ YES = 2036691744, } /** * Corner options. */ declare enum CornerOptions { /** * Beveled corner option. */ BEVEL_CORNER = 1667588726, /** * Fancy corner option. */ FANCY_CORNER = 1667589742, /** * Inset corner option. */ INSET_CORNER = 1667591795, /** * Inverted rounded corner option. */ INVERSE_ROUNDED_CORNER = 1667591798, /** * No corner option. */ NONE = 1852796517, /** * Rounded corner option. */ ROUNDED_CORNER = 1667592804, } /** * Options for creating preview images. */ declare enum CreateProxy { /** * Always creates preview images. */ ALWAYS = 1699307895, /** * Creates preview images as needed. */ AS_NEEDED = 1699311204, } /** * A cross reference to a different index topic. (For cross references in text, * use the 'cross reference source' and 'hyperlink' objects.) */ declare class CrossReference { /** * The text that precedes or follows the referenced topic. */ crossReferenceType: CrossReferenceType; /** * The text used for a custom cross reference type. Note: Valid only for custom * cross reference types. */ customTypeString: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the CrossReference. */ readonly id: number; /** * The index of the CrossReference within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the CrossReference; this is an alias to the CrossReference's * label property. */ name: string; /** * The parent of the CrossReference (a Topic). */ readonly parent: Topic; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The topic to which this CrossReference points. */ referencedTopic: Topic; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): CrossReference[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the CrossReference. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the CrossReference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A cross reference format object. */ declare class CrossReferenceFormat { /** * Character style of the cross reference format. */ appliedCharacterStyle: CharacterStyle; /** * A collection of cross reference building blocks. */ readonly buildingBlocks: BuildingBlocks; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the CrossReferenceFormat. */ readonly id: number; /** * The index of the CrossReferenceFormat within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the CrossReferenceFormat. */ name: string; /** * The parent of the CrossReferenceFormat (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): CrossReferenceFormat[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the CrossReferenceFormat. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the CrossReferenceFormat. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of cross reference formats. */ declare class CrossReferenceFormats { /** Returns the CrossReferenceFormat with the specified index or name. */ [index: number]: CrossReferenceFormat; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new cross reference format. * @param name The format name. (Optional) * @param withProperties Initial values for properties of the new CrossReferenceFormat (Optional) */ add(name?: string, withProperties?: Object): CrossReferenceFormat; /** * Returns any CrossReferenceFormat in the collection. */ anyItem(): CrossReferenceFormat; /** * Displays the number of elements in the CrossReferenceFormat. */ count(): number; /** * Returns every CrossReferenceFormat in the collection. */ everyItem(): CrossReferenceFormat; /** * Returns the first CrossReferenceFormat in the collection. */ firstItem(): CrossReferenceFormat; /** * Returns the CrossReferenceFormat with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): CrossReferenceFormat; /** * Returns the CrossReferenceFormat with the specified ID. * @param id The ID. */ itemByID(id: number): CrossReferenceFormat; /** * Returns the CrossReferenceFormat with the specified name. * @param name The name. */ itemByName(name: string): CrossReferenceFormat; /** * Returns the CrossReferenceFormats within the specified range. * @param from The CrossReferenceFormat, index, or name at the beginning of the range. Can accept: CrossReferenceFormat, Long Integer or String. * @param to The CrossReferenceFormat, index, or name at the end of the range. Can accept: CrossReferenceFormat, Long Integer or String. */ itemByRange(from: CrossReferenceFormat | number | string, to: CrossReferenceFormat | number | string): CrossReferenceFormat[]; /** * Returns the last CrossReferenceFormat in the collection. */ lastItem(): CrossReferenceFormat; /** * Returns the middle CrossReferenceFormat in the collection. */ middleItem(): CrossReferenceFormat; /** * Returns the CrossReferenceFormat whose index follows the specified * CrossReferenceFormat in the collection. * @param obj The CrossReferenceFormat whose index comes before the desired CrossReferenceFormat. */ nextItem(obj: CrossReferenceFormat): CrossReferenceFormat; /** * Returns the CrossReferenceFormat with the index previous to the specified * index. * @param obj The index of the CrossReferenceFormat that follows the desired CrossReferenceFormat. */ previousItem(obj: CrossReferenceFormat): CrossReferenceFormat; /** * Generates a string which, if executed, will return the CrossReferenceFormat. */ toSource(): string; } /** * A cross reference text source object. */ declare class CrossReferenceSource extends HyperlinkTextSource { /** * Character style of the hyperlink text source. */ appliedCharacterStyle: CharacterStyle; /** * Format used for cross reference source. */ appliedFormat: CrossReferenceFormat; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, the hyperlink is hidden. */ readonly hidden: boolean; /** * The unique ID of the CrossReferenceSource. */ readonly id: number; /** * The index of the CrossReferenceSource within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the CrossReferenceSource. */ name: string; /** * The parent of the CrossReferenceSource (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The hyperlinked text or insertion point. */ sourceText: Text; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): CrossReferenceSource[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the CrossReferenceSource. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Jumps to the hyperlink source. */ showSource(): void; /** * Generates a string which, if executed, will return the CrossReferenceSource. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Updates cross reference text source content. */ update(): void; } /** * A collection of cross reference text sources. */ declare class CrossReferenceSources { /** Returns the CrossReferenceSource with the specified index or name. */ [index: number]: CrossReferenceSource; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new cross reference text source. * @param source The text or insertion point to create the source. * @param appliedFormat Format used for cross reference source. * @param withProperties Initial values for properties of the new CrossReferenceSource (Optional) */ add(source: Text, appliedFormat: CrossReferenceFormat, withProperties?: Object): CrossReferenceSource; /** * Returns any CrossReferenceSource in the collection. */ anyItem(): CrossReferenceSource; /** * Displays the number of elements in the CrossReferenceSource. */ count(): number; /** * Returns every CrossReferenceSource in the collection. */ everyItem(): CrossReferenceSource; /** * Returns the first CrossReferenceSource in the collection. */ firstItem(): CrossReferenceSource; /** * Returns the CrossReferenceSource with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): CrossReferenceSource; /** * Returns the CrossReferenceSource with the specified ID. * @param id The ID. */ itemByID(id: number): CrossReferenceSource; /** * Returns the CrossReferenceSource with the specified name. * @param name The name. */ itemByName(name: string): CrossReferenceSource; /** * Returns the CrossReferenceSources within the specified range. * @param from The CrossReferenceSource, index, or name at the beginning of the range. Can accept: CrossReferenceSource, Long Integer or String. * @param to The CrossReferenceSource, index, or name at the end of the range. Can accept: CrossReferenceSource, Long Integer or String. */ itemByRange(from: CrossReferenceSource | number | string, to: CrossReferenceSource | number | string): CrossReferenceSource[]; /** * Returns the last CrossReferenceSource in the collection. */ lastItem(): CrossReferenceSource; /** * Returns the middle CrossReferenceSource in the collection. */ middleItem(): CrossReferenceSource; /** * Returns the CrossReferenceSource whose index follows the specified * CrossReferenceSource in the collection. * @param obj The CrossReferenceSource whose index comes before the desired CrossReferenceSource. */ nextItem(obj: CrossReferenceSource): CrossReferenceSource; /** * Returns the CrossReferenceSource with the index previous to the specified * index. * @param obj The index of the CrossReferenceSource that follows the desired CrossReferenceSource. */ previousItem(obj: CrossReferenceSource): CrossReferenceSource; /** * Generates a string which, if executed, will return the CrossReferenceSource. */ toSource(): string; } /** * Instructional text options for cross reference. */ declare enum CrossReferenceType { /** * Inserts the specified string in front of the referenced topic. */ CUSTOM_CROSS_REFERENCE = 1131639875, /** * Inserts the specified following topic separator and the specified string * after the referenced topic. If no following topic separator is specified, * inserts a space. */ CUSTOM_CROSS_REFERENCE_AFTER = 1131639905, /** * Inserts the specified string and the specified before cross reference * separator in front of the referenced topic. If no before cross reference * separator is specified, inserts a space. */ CUSTOM_CROSS_REFERENCE_BEFORE = 1131639906, /** * Inserts 'See' in front of the referenced topic. */ SEE = 1701729125, /** * Inserts 'See also' in front of the referenced topic. */ SEE_ALSO = 1399144812, /** * Inserts 'See also herein' in front of the referenced topic. */ SEE_ALSO_HEREIN = 1398884466, /** * Inserts 'See herein' in front of the referenced topic. */ SEE_HEREIN = 1397256814, /** * Inserts 'See also' in front of the referenced topic if the topic has an * associated page reference; inserts 'See' if the topic does not have a page * reference. */ SEE_OR_ALSO_BRACKET = 1399800172, } /** * A collection of index cross references. (For cross references in text, use * the 'cross reference source' and 'hyperlink' objects.) */ declare class CrossReferences { /** Returns the CrossReference with the specified index or name. */ [index: number]: CrossReference; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new cross reference. * @param referencedTopic The topic that the cross reference points to. * @param crossReferenceType The cross reference type. * @param customTypeString The custom string to use in the cross reference. Valid only for custom cross reference types. (Optional) * @param withProperties Initial values for properties of the new CrossReference (Optional) */ add(referencedTopic: Topic, crossReferenceType: CrossReferenceType, customTypeString?: string, withProperties?: Object): CrossReference; /** * Returns any CrossReference in the collection. */ anyItem(): CrossReference; /** * Displays the number of elements in the CrossReference. */ count(): number; /** * Returns every CrossReference in the collection. */ everyItem(): CrossReference; /** * Returns the first CrossReference in the collection. */ firstItem(): CrossReference; /** * Returns the CrossReference with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): CrossReference; /** * Returns the CrossReference with the specified ID. * @param id The ID. */ itemByID(id: number): CrossReference; /** * Returns the CrossReference with the specified name. * @param name The name. */ itemByName(name: string): CrossReference; /** * Returns the CrossReferences within the specified range. * @param from The CrossReference, index, or name at the beginning of the range. Can accept: CrossReference, Long Integer or String. * @param to The CrossReference, index, or name at the end of the range. Can accept: CrossReference, Long Integer or String. */ itemByRange(from: CrossReference | number | string, to: CrossReference | number | string): CrossReference[]; /** * Returns the last CrossReference in the collection. */ lastItem(): CrossReference; /** * Returns the middle CrossReference in the collection. */ middleItem(): CrossReference; /** * Returns the CrossReference whose index follows the specified CrossReference * in the collection. * @param obj The CrossReference whose index comes before the desired CrossReference. */ nextItem(obj: CrossReference): CrossReference; /** * Returns the CrossReference with the index previous to the specified index. * @param obj The index of the CrossReference that follows the desired CrossReference. */ previousItem(obj: CrossReference): CrossReference; /** * Generates a string which, if executed, will return the CrossReference. */ toSource(): string; } /** * Cursor types. */ declare enum CursorTypes { /** * Uses a barbell cursor. */ BARBELL_CURSOR = 1698841196, /** * Uses a block cursor. */ BLOCK_CURSOR = 1698851951, /** * Uses a standard cursor. */ STANDARD_CURSOR = 1699968100, /** * Uses a thick cursor. */ THICK_CURSOR = 1700029291, } /** * Custom Layout Type Options. */ declare enum CustomLayoutTypeEnum { /** * Alignment And Spacing. */ ALIGNMENT_AND_SPACING = 1097618288, /** * Float Left. */ FLOAT_LEFT = 1181502565, /** * Float Right. */ FLOAT_RIGHT = 1181504105, } /** * The preferences for a custom text variable. */ declare class CustomTextVariablePreference extends Preference { /** * The contents of the text. Can return: String or SpecialCharacters * enumerator. */ contents: string | SpecialCharacters; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the CustomTextVariablePreference (a TextVariable). */ readonly parent: TextVariable; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): CustomTextVariablePreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * CustomTextVariablePreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * The document DTD. */ declare class DTD extends XMLItem { /** * The contents of the text. Can return: String or SpecialCharacters * enumerator. */ readonly contents: string | SpecialCharacters; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the DTD. */ readonly id: number; /** * The index of the DTD within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the DTD (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The public ID of the DOCTYPE declaration. Note: Valid only when the DTD is * an external subset. */ readonly publicId: string; /** * The tag of the root object. */ rootTag: XMLTag; /** * The system ID of the DOCTYPE declaration. Note: Valid only when the DTD is * an external subset. */ readonly systemId: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): DTD[]; /** * Deletes the DTD. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Selects the object. * @param existingSelection The selection status of the DTD in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Generates a string which, if executed, will return the DTD. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of DTDs. */ declare class DTDs { /** Returns the DTD with the specified index or name. */ [index: number]: DTD; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any DTD in the collection. */ anyItem(): DTD; /** * Displays the number of elements in the DTD. */ count(): number; /** * Returns every DTD in the collection. */ everyItem(): DTD; /** * Returns the first DTD in the collection. */ firstItem(): DTD; /** * Returns the DTD with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): DTD; /** * Returns the DTD with the specified ID. * @param id The ID. */ itemByID(id: number): DTD; /** * Returns the DTDs within the specified range. * @param from The DTD, index, or name at the beginning of the range. Can accept: DTD, Long Integer or String. * @param to The DTD, index, or name at the end of the range. Can accept: DTD, Long Integer or String. */ itemByRange(from: DTD | number | string, to: DTD | number | string): DTD[]; /** * Returns the last DTD in the collection. */ lastItem(): DTD; /** * Returns the middle DTD in the collection. */ middleItem(): DTD; /** * Returns the DTD whose index follows the specified DTD in the collection. * @param obj The DTD whose index comes before the desired DTD. */ nextItem(obj: DTD): DTD; /** * Returns the DTD with the index previous to the specified index. * @param obj The index of the DTD that follows the desired DTD. */ previousItem(obj: DTD): DTD; /** * Generates a string which, if executed, will return the DTD. */ toSource(): string; } /** * A dashed stroke style. */ declare class DashedStrokeStyle extends StrokeStyle { /** * The pattern of dashes and gaps, in the format [dash length1, gap length1, * dash length2, gap length2]. Define up to ten values. * @remarks Measurement unit — also accepts a string such as "12mm". */ dashArray: (number | string)[]; /** * The end shape of an open path. */ endCap: EndCap; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the DashedStrokeStyle. */ readonly id: number; /** * The index of the DashedStrokeStyle within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the DashedStrokeStyle. */ name: string; /** * The parent of the DashedStrokeStyle (a Document or Application). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The corner adjustment applied to the DashedStrokeStyle. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The stroke style type. */ readonly strokeStyleType: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the DashedStrokeStyle. */ duplicate(): DashedStrokeStyle; /** * Resolves the object specifier, creating an array of object references. */ getElements(): DashedStrokeStyle[]; /** * Deletes the stroke style. * @param replacingWith The stroke style to apply in place of the deleted style. . Can accept: StrokeStyle or String. (Optional) */ remove(replacingWith?: StrokeStyle | string): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the DashedStrokeStyle. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of dashed stroke styles. */ declare class DashedStrokeStyles { /** Returns the DashedStrokeStyle with the specified index or name. */ [index: number]: DashedStrokeStyle; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new DashedStrokeStyle. * @param withProperties Initial values for properties of the new DashedStrokeStyle (Optional) */ add(withProperties?: Object): DashedStrokeStyle; /** * Returns any DashedStrokeStyle in the collection. */ anyItem(): DashedStrokeStyle; /** * Displays the number of elements in the DashedStrokeStyle. */ count(): number; /** * Returns every DashedStrokeStyle in the collection. */ everyItem(): DashedStrokeStyle; /** * Returns the first DashedStrokeStyle in the collection. */ firstItem(): DashedStrokeStyle; /** * Returns the DashedStrokeStyle with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): DashedStrokeStyle; /** * Returns the DashedStrokeStyle with the specified ID. * @param id The ID. */ itemByID(id: number): DashedStrokeStyle; /** * Returns the DashedStrokeStyle with the specified name. * @param name The name. */ itemByName(name: string): DashedStrokeStyle; /** * Returns the DashedStrokeStyles within the specified range. * @param from The DashedStrokeStyle, index, or name at the beginning of the range. Can accept: DashedStrokeStyle, Long Integer or String. * @param to The DashedStrokeStyle, index, or name at the end of the range. Can accept: DashedStrokeStyle, Long Integer or String. */ itemByRange(from: DashedStrokeStyle | number | string, to: DashedStrokeStyle | number | string): DashedStrokeStyle[]; /** * Returns the last DashedStrokeStyle in the collection. */ lastItem(): DashedStrokeStyle; /** * Returns the middle DashedStrokeStyle in the collection. */ middleItem(): DashedStrokeStyle; /** * Returns the DashedStrokeStyle whose index follows the specified * DashedStrokeStyle in the collection. * @param obj The DashedStrokeStyle whose index comes before the desired DashedStrokeStyle. */ nextItem(obj: DashedStrokeStyle): DashedStrokeStyle; /** * Returns the DashedStrokeStyle with the index previous to the specified * index. * @param obj The index of the DashedStrokeStyle that follows the desired DashedStrokeStyle. */ previousItem(obj: DashedStrokeStyle): DashedStrokeStyle; /** * Generates a string which, if executed, will return the DashedStrokeStyle. */ toSource(): string; } /** * Format options for image data. */ declare enum DataFormat { /** * Uses ASCII format. */ ASCII = 1095975753, /** * Uses binary format. */ BINARY = 1114534521, } /** * A data merge object. */ declare class DataMerge extends Preference { /** * A collection of data merge fields. */ readonly dataMergeFields: DataMergeFields; /** * The data merge preference properties that define the layout and content of * the target page. */ readonly dataMergePreferences: DataMergePreference; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the DataMerge (a Document). */ readonly parent: Document; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Merges records and exports to PDF. * @param to The path of exported PDF file. * @param using The PDF export style to use. (Optional) * @param outputOversetReportFile The path to the file in which to store the overset report. (Optional) */ exportFile(to: File, using?: PDFExportPreset, outputOversetReportFile?: File): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): DataMerge[]; /** * Merges records and produces an optional overset report. * @param outputOversetReportFile The path to the file in which to store the overset report. (Optional) */ mergeRecords(outputOversetReportFile?: File): void; /** * Removes the data source. */ removeDataSource(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Specifies the file to use as the data source. * @param dataSourceFile The path to the data source file. */ selectDataSource(dataSourceFile: File): void; /** * Generates a string which, if executed, will return the DataMerge. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Updates the data source file with the most current data. */ updateDataSource(): void; } /** * A data merge field. */ declare class DataMergeField { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The name of the field. */ readonly fieldName: string; /** * The source field type. */ readonly fieldType: SourceFieldType; /** * The index of the DataMergeField within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the DataMergeField (a DataMerge). */ readonly parent: DataMerge; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): DataMergeField[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the DataMergeField. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of data merge fields. */ declare class DataMergeFields { /** Returns the DataMergeField with the specified index or name. */ [index: number]: DataMergeField; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any DataMergeField in the collection. */ anyItem(): DataMergeField; /** * Displays the number of elements in the DataMergeField. */ count(): number; /** * Returns every DataMergeField in the collection. */ everyItem(): DataMergeField; /** * Returns the first DataMergeField in the collection. */ firstItem(): DataMergeField; /** * Returns the DataMergeField with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): DataMergeField; /** * Returns the DataMergeFields within the specified range. * @param from The DataMergeField, index, or name at the beginning of the range. Can accept: DataMergeField, Long Integer or String. * @param to The DataMergeField, index, or name at the end of the range. Can accept: DataMergeField, Long Integer or String. */ itemByRange(from: DataMergeField | number | string, to: DataMergeField | number | string): DataMergeField[]; /** * Returns the last DataMergeField in the collection. */ lastItem(): DataMergeField; /** * Returns the middle DataMergeField in the collection. */ middleItem(): DataMergeField; /** * Returns the DataMergeField whose index follows the specified DataMergeField * in the collection. * @param obj The DataMergeField whose index comes before the desired DataMergeField. */ nextItem(obj: DataMergeField): DataMergeField; /** * Returns the DataMergeField with the index previous to the specified index. * @param obj The index of the DataMergeField that follows the desired DataMergeField. */ previousItem(obj: DataMergeField): DataMergeField; /** * Generates a string which, if executed, will return the DataMergeField. */ toSource(): string; } /** * An object that can contain a date merge image field. */ declare class DataMergeImagePlaceholder { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The data merge field to insert in the placeholder. For information, see data * merge text placeholder and data merge image placeholder. */ readonly field: DataMergeField; /** * The index of the DataMergeImagePlaceholder within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the DataMergeImagePlaceholder (a Document). */ readonly parent: Document; /** * The page item on which to place the placeholder. */ readonly placeholderPageItem: PageItem; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): DataMergeImagePlaceholder[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * DataMergeImagePlaceholder. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of data merge image placeholders. */ declare class DataMergeImagePlaceholders { /** Returns the DataMergeImagePlaceholder with the specified index or name. */ [index: number]: DataMergeImagePlaceholder; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a data merge image placeholder. * @param placeholder The page item on which to place the placeholder. * @param field The data merge field to insert. * @param withProperties Initial values for properties of the new DataMergeImagePlaceholder (Optional) */ add(placeholder: PageItem, field: DataMergeField, withProperties?: Object): DataMergeImagePlaceholder; /** * Returns any DataMergeImagePlaceholder in the collection. */ anyItem(): DataMergeImagePlaceholder; /** * Displays the number of elements in the DataMergeImagePlaceholder. */ count(): number; /** * Returns every DataMergeImagePlaceholder in the collection. */ everyItem(): DataMergeImagePlaceholder; /** * Returns the first DataMergeImagePlaceholder in the collection. */ firstItem(): DataMergeImagePlaceholder; /** * Returns the DataMergeImagePlaceholder with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): DataMergeImagePlaceholder; /** * Returns the DataMergeImagePlaceholders within the specified range. * @param from The DataMergeImagePlaceholder, index, or name at the beginning of the range. Can accept: DataMergeImagePlaceholder, Long Integer or String. * @param to The DataMergeImagePlaceholder, index, or name at the end of the range. Can accept: DataMergeImagePlaceholder, Long Integer or String. */ itemByRange(from: DataMergeImagePlaceholder | number | string, to: DataMergeImagePlaceholder | number | string): DataMergeImagePlaceholder[]; /** * Returns the last DataMergeImagePlaceholder in the collection. */ lastItem(): DataMergeImagePlaceholder; /** * Returns the middle DataMergeImagePlaceholder in the collection. */ middleItem(): DataMergeImagePlaceholder; /** * Returns the DataMergeImagePlaceholder whose index follows the specified * DataMergeImagePlaceholder in the collection. * @param obj The DataMergeImagePlaceholder whose index comes before the desired DataMergeImagePlaceholder. */ nextItem(obj: DataMergeImagePlaceholder): DataMergeImagePlaceholder; /** * Returns the DataMergeImagePlaceholder with the index previous to the * specified index. * @param obj The index of the DataMergeImagePlaceholder that follows the desired DataMergeImagePlaceholder. */ previousItem(obj: DataMergeImagePlaceholder): DataMergeImagePlaceholder; /** * Generates a string which, if executed, will return the * DataMergeImagePlaceholder. */ toSource(): string; } /** * Data merge options. */ declare class DataMergeOption extends Preference { /** * If true, centers the image in the frame; preserves the frame size as well as * content size and proportions. Note: If the content is larger than the frame, * content around the edges is obscured by the bounding box of the frame. This * doesn't work with fittingOption CONTENT_AWARE_FIT */ centerImage: boolean; /** * If true, creates a new document when records are merged. */ createNewDocument: boolean; /** * The maximum number of pages per document. */ documentSize: number; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Instructions for fitting content in a frame. */ fittingOption: Fitting; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * If true, links images to the target document. If false, embeds images in the * target document. */ linkImages: boolean; /** * The parent of the DataMergeOption (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, removes blank lines caused by empty fields. */ removeBlankLines: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): DataMergeOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the DataMergeOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Data merge preferences. */ declare class DataMergePreference extends Preference { /** * The order in which to arrange multiple records on the page in the target * document. */ arrangeBy: ArrangeBy; /** * The offset value of the bottom margin in the target document. * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomMargin: number | string; /** * The amount of space between columns of records in the target document. * @remarks Measurement unit — also accepts a string such as "12mm". */ columnSpacing: number | string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The offset value of the left margin in the target document. * @remarks Measurement unit — also accepts a string such as "12mm". */ leftMargin: number | string; /** * The parent of the DataMergePreference (a DataMerge). */ readonly parent: DataMerge; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The number of the record to merge. Note: Valid only when record selection is * one record. */ recordNumber: number; /** * The range of records to merge. Note: Valid only when record selection is * range. */ recordRange: string; /** * The records to merge. */ recordSelection: RecordSelection; /** * The number of records to place on each page in the document. */ recordsPerPage: RecordsPerPage; /** * The offset value of the right margin in the target document. * @remarks Measurement unit — also accepts a string such as "12mm". */ rightMargin: number | string; /** * The amount of space between rows of records in the target document. * @remarks Measurement unit — also accepts a string such as "12mm". */ rowSpacing: number | string; /** * The offset value of the top margin in the target document. * @remarks Measurement unit — also accepts a string such as "12mm". */ topMargin: number | string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * If true, lists missing images in the specified output file. * @param outputMissingImagesReportFile The path to the output file. */ alertMissingImages(outputMissingImagesReportFile: File): boolean; /** * Resolves the object specifier, creating an array of object references. */ getElements(): DataMergePreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the DataMergePreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * An object that can contain a date merge QR code field. */ declare class DataMergeQrcodePlaceholder { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The data merge field to insert in the placeholder. For information, see data * merge text placeholder and data merge image placeholder. */ readonly field: DataMergeField; /** * The index of the DataMergeQrcodePlaceholder within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the DataMergeQrcodePlaceholder (a Document). */ readonly parent: Document; /** * The page item on which to place the placeholder. */ readonly placeholderPageItem: PageItem; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): DataMergeQrcodePlaceholder[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * DataMergeQrcodePlaceholder. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of data merge QR code placeholders. */ declare class DataMergeQrcodePlaceholders { /** Returns the DataMergeQrcodePlaceholder with the specified index or name. */ [index: number]: DataMergeQrcodePlaceholder; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a data merge QR code placeholder. * @param placeholder The page item on which to place the placeholder. * @param field The data merge field to insert. * @param withProperties Initial values for properties of the new DataMergeQrcodePlaceholder (Optional) */ add(placeholder: PageItem, field: DataMergeField, withProperties?: Object): DataMergeQrcodePlaceholder; /** * Returns any DataMergeQrcodePlaceholder in the collection. */ anyItem(): DataMergeQrcodePlaceholder; /** * Displays the number of elements in the DataMergeQrcodePlaceholder. */ count(): number; /** * Returns every DataMergeQrcodePlaceholder in the collection. */ everyItem(): DataMergeQrcodePlaceholder; /** * Returns the first DataMergeQrcodePlaceholder in the collection. */ firstItem(): DataMergeQrcodePlaceholder; /** * Returns the DataMergeQrcodePlaceholder with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): DataMergeQrcodePlaceholder; /** * Returns the DataMergeQrcodePlaceholders within the specified range. * @param from The DataMergeQrcodePlaceholder, index, or name at the beginning of the range. Can accept: DataMergeQrcodePlaceholder, Long Integer or String. * @param to The DataMergeQrcodePlaceholder, index, or name at the end of the range. Can accept: DataMergeQrcodePlaceholder, Long Integer or String. */ itemByRange(from: DataMergeQrcodePlaceholder | number | string, to: DataMergeQrcodePlaceholder | number | string): DataMergeQrcodePlaceholder[]; /** * Returns the last DataMergeQrcodePlaceholder in the collection. */ lastItem(): DataMergeQrcodePlaceholder; /** * Returns the middle DataMergeQrcodePlaceholder in the collection. */ middleItem(): DataMergeQrcodePlaceholder; /** * Returns the DataMergeQrcodePlaceholder whose index follows the specified * DataMergeQrcodePlaceholder in the collection. * @param obj The DataMergeQrcodePlaceholder whose index comes before the desired DataMergeQrcodePlaceholder. */ nextItem(obj: DataMergeQrcodePlaceholder): DataMergeQrcodePlaceholder; /** * Returns the DataMergeQrcodePlaceholder with the index previous to the * specified index. * @param obj The index of the DataMergeQrcodePlaceholder that follows the desired DataMergeQrcodePlaceholder. */ previousItem(obj: DataMergeQrcodePlaceholder): DataMergeQrcodePlaceholder; /** * Generates a string which, if executed, will return the * DataMergeQrcodePlaceholder. */ toSource(): string; } /** * An object that can contain a data merge text field. */ declare class DataMergeTextPlaceholder { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The data merge field to insert in the placeholder. For information, see data * merge text placeholder and data merge image placeholder. */ readonly field: DataMergeField; /** * The index of the DataMergeTextPlaceholder within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The number of objects in the collection. */ readonly length: number; /** * The parent of the DataMergeTextPlaceholder (a Document). */ readonly parent: Document; /** * The story that contains the text. */ readonly parentStory: Story; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The insertion point before the table in the story containing the table. */ readonly storyOffset: InsertionPoint; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): DataMergeTextPlaceholder[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * DataMergeTextPlaceholder. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of data merge text placeholders. */ declare class DataMergeTextPlaceholders { /** Returns the DataMergeTextPlaceholder with the specified index or name. */ [index: number]: DataMergeTextPlaceholder; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a data merge text placeholder. * @param parentStory The story in which to insert the placeholder. * @param storyOffset The position within the story at which to insert the placeholder, specified as an offset number or an insertion point. Can accept: InsertionPoint or Long Integer. * @param field The field to insert. * @param withProperties Initial values for properties of the new DataMergeTextPlaceholder (Optional) */ add(parentStory: Story, storyOffset: InsertionPoint | number, field: DataMergeField, withProperties?: Object): DataMergeTextPlaceholder; /** * Returns any DataMergeTextPlaceholder in the collection. */ anyItem(): DataMergeTextPlaceholder; /** * Displays the number of elements in the DataMergeTextPlaceholder. */ count(): number; /** * Returns every DataMergeTextPlaceholder in the collection. */ everyItem(): DataMergeTextPlaceholder; /** * Returns the first DataMergeTextPlaceholder in the collection. */ firstItem(): DataMergeTextPlaceholder; /** * Returns the DataMergeTextPlaceholder with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): DataMergeTextPlaceholder; /** * Returns the DataMergeTextPlaceholders within the specified range. * @param from The DataMergeTextPlaceholder, index, or name at the beginning of the range. Can accept: DataMergeTextPlaceholder, Long Integer or String. * @param to The DataMergeTextPlaceholder, index, or name at the end of the range. Can accept: DataMergeTextPlaceholder, Long Integer or String. */ itemByRange(from: DataMergeTextPlaceholder | number | string, to: DataMergeTextPlaceholder | number | string): DataMergeTextPlaceholder[]; /** * Returns the last DataMergeTextPlaceholder in the collection. */ lastItem(): DataMergeTextPlaceholder; /** * Returns the middle DataMergeTextPlaceholder in the collection. */ middleItem(): DataMergeTextPlaceholder; /** * Returns the DataMergeTextPlaceholder whose index follows the specified * DataMergeTextPlaceholder in the collection. * @param obj The DataMergeTextPlaceholder whose index comes before the desired DataMergeTextPlaceholder. */ nextItem(obj: DataMergeTextPlaceholder): DataMergeTextPlaceholder; /** * Returns the DataMergeTextPlaceholder with the index previous to the * specified index. * @param obj The index of the DataMergeTextPlaceholder that follows the desired DataMergeTextPlaceholder. */ previousItem(obj: DataMergeTextPlaceholder): DataMergeTextPlaceholder; /** * Generates a string which, if executed, will return the * DataMergeTextPlaceholder. */ toSource(): string; } /** * The preferences for a date variable. */ declare class DateVariablePreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The date format. */ format: string; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the DateVariablePreference (a TextVariable). */ readonly parent: TextVariable; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The text that follows the value of the variable. (Limit: 128 characters) */ textAfter: string; /** * The text that precedes the value of the variable. (Limit: 128 characters) */ textBefore: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): DateVariablePreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * DateVariablePreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * The default rendering intent. */ declare enum DefaultRenderingIntent { /** * Aims to maintain color accuracy at the expense of color relationshps and is * suitable for proofing to simulate the output of a particular device. Note: * Leaves colors that fall inside the destination gamut unchanged and clips * out-of-gamut colors. */ ABSOLUTE_COLORIMETRIC = 1380540771, /** * Aims to preserve the visual relationship between colors so they are * perceived as natural to the human eye, even though the color values * themselves may change. */ PERCEPTUAL = 1380544611, /** * Compares the extreme highlight of the source color space to that of the * destination color space and shifts all colors accordingly. Out-of-gamut * colors are shifted to the closest reproducible color in the destination * color space. Note: Preserves more of the original colors in an image than * perceptual rendering intent does. */ RELATIVE_COLORIMETRIC = 1380545123, /** * Tries to produce vivid colors in an image at the expense of color accuracy. */ SATURATION = 1380545377, } /** * The animation design options. */ declare enum DesignOptions { /** * Uses the current object's properties as the starting appearance of the * animation at runtime. */ FROM_CURRENT_APPEARANCE = 1634551405, /** * Uses the current object's properties as the end appearance of the animation * at runtime. */ TO_CURRENT_APPEARANCE = 1634554991, /** * Uses the current object's properties as the starting appearance, and current * position as the end location of the animation at runtime. */ TO_CURRENT_LOCATION = 1634553702, } /** * Diacritic position. */ declare enum DiacriticPositionOptions { /** * Default position */ DEFAULT_POSITION = 1685090150, /** * Loose position */ LOOSE_POSITION = 1685089391, /** * Medium position */ MEDIUM_POSITION = 1685089637, /** * OpenType position */ OPENTYPE_POSITION = 1685090164, /** * OpenType position from baseline */ OPENTYPE_POSITION_FROM_BASELINE = 1685090146, /** * Tight position */ TIGHT_POSITION = 1685091433, } /** * A dialog. */ declare class Dialog { /** * If true, creates a Cancel button in the dialog that allows users to close * the dialog without saving any selections. If false, the dialog contains an * OK button but no Cancel button. */ canCancel: boolean; /** * A collection of dialog columns. */ readonly dialogColumns: DialogColumns; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the Dialog. */ readonly id: number; /** * The index of the Dialog within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the Dialog. */ name: string; /** * The parent of the Dialog (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Destroys the dialog object. Note: Dialog objects remain in memory until you * destroy them or quit the program. */ destroy(): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Dialog[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Displays the dialog. */ show(): boolean; /** * Generates a string which, if executed, will return the Dialog. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A borderless column for containing controls in a dialog. */ declare class DialogColumn { /** * A collection of angle comboboxes. */ readonly angleComboboxes: AngleComboboxes; /** * A collection of angle editboxes. */ readonly angleEditboxes: AngleEditboxes; /** * A collection of border panels. */ readonly borderPanels: BorderPanels; /** * A collection of checkbox controls. */ readonly checkboxControls: CheckboxControls; /** * A collection of dialog rows. */ readonly dialogRows: DialogRows; /** * A collection of dropdowns. */ readonly dropdowns: Dropdowns; /** * A collection of enabling groups. */ readonly enablingGroups: EnablingGroups; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the DialogColumn. */ readonly id: number; /** * The index of the DialogColumn within its containing object. */ readonly index: number; /** * A collection of integer comboboxes. */ readonly integerComboboxes: IntegerComboboxes; /** * A collection of integer editboxes. */ readonly integerEditboxes: IntegerEditboxes; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A collection of measurement comboboxes. */ readonly measurementComboboxes: MeasurementComboboxes; /** * A collection of measurement editboxes. */ readonly measurementEditboxes: MeasurementEditboxes; /** * The parent of the DialogColumn (a Dialog, DialogRow, EnablingGroup or * BorderPanel). */ readonly parent: DialogRow | EnablingGroup | BorderPanel | Dialog; /** * A collection of percent comboboxes. */ readonly percentComboboxes: PercentComboboxes; /** * A collection of percent editboxes. */ readonly percentEditboxes: PercentEditboxes; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of radiobutton groups. */ readonly radiobuttonGroups: RadiobuttonGroups; /** * A collection of real number comboboxes. */ readonly realComboboxes: RealComboboxes; /** * A collection of real number editboxes. */ readonly realEditboxes: RealEditboxes; /** * A collection of static text objects. */ readonly staticTexts: StaticTexts; /** * A collection of text editboxes. */ readonly textEditboxes: TextEditboxes; /** * A collection of widgets. */ readonly widgets: Widgets; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): DialogColumn[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the DialogColumn. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of dialog columns. */ declare class DialogColumns { /** Returns the DialogColumn with the specified index or name. */ [index: number]: DialogColumn; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new DialogColumn. * @param withProperties Initial values for properties of the new DialogColumn (Optional) */ add(withProperties?: Object): DialogColumn; /** * Returns any DialogColumn in the collection. */ anyItem(): DialogColumn; /** * Displays the number of elements in the DialogColumn. */ count(): number; /** * Returns every DialogColumn in the collection. */ everyItem(): DialogColumn; /** * Returns the first DialogColumn in the collection. */ firstItem(): DialogColumn; /** * Returns the DialogColumn with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): DialogColumn; /** * Returns the DialogColumn with the specified ID. * @param id The ID. */ itemByID(id: number): DialogColumn; /** * Returns the DialogColumns within the specified range. * @param from The DialogColumn, index, or name at the beginning of the range. Can accept: DialogColumn, Long Integer or String. * @param to The DialogColumn, index, or name at the end of the range. Can accept: DialogColumn, Long Integer or String. */ itemByRange(from: DialogColumn | number | string, to: DialogColumn | number | string): DialogColumn[]; /** * Returns the last DialogColumn in the collection. */ lastItem(): DialogColumn; /** * Returns the middle DialogColumn in the collection. */ middleItem(): DialogColumn; /** * Returns the DialogColumn whose index follows the specified DialogColumn in * the collection. * @param obj The DialogColumn whose index comes before the desired DialogColumn. */ nextItem(obj: DialogColumn): DialogColumn; /** * Returns the DialogColumn with the index previous to the specified index. * @param obj The index of the DialogColumn that follows the desired DialogColumn. */ previousItem(obj: DialogColumn): DialogColumn; /** * Generates a string which, if executed, will return the DialogColumn. */ toSource(): string; } /** * A borderless row for containing controls in a dialog. */ declare class DialogRow { /** * A collection of angle comboboxes. */ readonly angleComboboxes: AngleComboboxes; /** * A collection of angle editboxes. */ readonly angleEditboxes: AngleEditboxes; /** * A collection of border panels. */ readonly borderPanels: BorderPanels; /** * A collection of checkbox controls. */ readonly checkboxControls: CheckboxControls; /** * A collection of dialog columns. */ readonly dialogColumns: DialogColumns; /** * A collection of dropdowns. */ readonly dropdowns: Dropdowns; /** * A collection of enabling groups. */ readonly enablingGroups: EnablingGroups; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the DialogRow. */ readonly id: number; /** * The index of the DialogRow within its containing object. */ readonly index: number; /** * A collection of integer comboboxes. */ readonly integerComboboxes: IntegerComboboxes; /** * A collection of integer editboxes. */ readonly integerEditboxes: IntegerEditboxes; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A collection of measurement comboboxes. */ readonly measurementComboboxes: MeasurementComboboxes; /** * A collection of measurement editboxes. */ readonly measurementEditboxes: MeasurementEditboxes; /** * The parent of the DialogRow (a DialogColumn). */ readonly parent: DialogColumn; /** * A collection of percent comboboxes. */ readonly percentComboboxes: PercentComboboxes; /** * A collection of percent editboxes. */ readonly percentEditboxes: PercentEditboxes; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of radiobutton groups. */ readonly radiobuttonGroups: RadiobuttonGroups; /** * A collection of real number comboboxes. */ readonly realComboboxes: RealComboboxes; /** * A collection of real number editboxes. */ readonly realEditboxes: RealEditboxes; /** * A collection of static text objects. */ readonly staticTexts: StaticTexts; /** * A collection of text editboxes. */ readonly textEditboxes: TextEditboxes; /** * A collection of widgets. */ readonly widgets: Widgets; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): DialogRow[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the DialogRow. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of dialog rows. */ declare class DialogRows { /** Returns the DialogRow with the specified index or name. */ [index: number]: DialogRow; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new DialogRow. * @param withProperties Initial values for properties of the new DialogRow (Optional) */ add(withProperties?: Object): DialogRow; /** * Returns any DialogRow in the collection. */ anyItem(): DialogRow; /** * Displays the number of elements in the DialogRow. */ count(): number; /** * Returns every DialogRow in the collection. */ everyItem(): DialogRow; /** * Returns the first DialogRow in the collection. */ firstItem(): DialogRow; /** * Returns the DialogRow with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): DialogRow; /** * Returns the DialogRow with the specified ID. * @param id The ID. */ itemByID(id: number): DialogRow; /** * Returns the DialogRows within the specified range. * @param from The DialogRow, index, or name at the beginning of the range. Can accept: DialogRow, Long Integer or String. * @param to The DialogRow, index, or name at the end of the range. Can accept: DialogRow, Long Integer or String. */ itemByRange(from: DialogRow | number | string, to: DialogRow | number | string): DialogRow[]; /** * Returns the last DialogRow in the collection. */ lastItem(): DialogRow; /** * Returns the middle DialogRow in the collection. */ middleItem(): DialogRow; /** * Returns the DialogRow whose index follows the specified DialogRow in the * collection. * @param obj The DialogRow whose index comes before the desired DialogRow. */ nextItem(obj: DialogRow): DialogRow; /** * Returns the DialogRow with the index previous to the specified index. * @param obj The index of the DialogRow that follows the desired DialogRow. */ previousItem(obj: DialogRow): DialogRow; /** * Generates a string which, if executed, will return the DialogRow. */ toSource(): string; } /** * A collection of dialogs. */ declare class Dialogs { /** Returns the Dialog with the specified index or name. */ [index: number]: Dialog; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new Dialog. * @param withProperties Initial values for properties of the new Dialog (Optional) */ add(withProperties?: Object): Dialog; /** * Returns any Dialog in the collection. */ anyItem(): Dialog; /** * Displays the number of elements in the Dialog. */ count(): number; /** * Returns every Dialog in the collection. */ everyItem(): Dialog; /** * Returns the first Dialog in the collection. */ firstItem(): Dialog; /** * Returns the Dialog with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Dialog; /** * Returns the Dialog with the specified ID. * @param id The ID. */ itemByID(id: number): Dialog; /** * Returns the Dialog with the specified name. * @param name The name. */ itemByName(name: string): Dialog; /** * Returns the Dialogs within the specified range. * @param from The Dialog, index, or name at the beginning of the range. Can accept: Dialog, Long Integer or String. * @param to The Dialog, index, or name at the end of the range. Can accept: Dialog, Long Integer or String. */ itemByRange(from: Dialog | number | string, to: Dialog | number | string): Dialog[]; /** * Returns the last Dialog in the collection. */ lastItem(): Dialog; /** * Returns the middle Dialog in the collection. */ middleItem(): Dialog; /** * Returns the Dialog whose index follows the specified Dialog in the * collection. * @param obj The Dialog whose index comes before the desired Dialog. */ nextItem(obj: Dialog): Dialog; /** * Returns the Dialog with the index previous to the specified index. * @param obj The index of the Dialog that follows the desired Dialog. */ previousItem(obj: Dialog): Dialog; /** * Generates a string which, if executed, will return the Dialog. */ toSource(): string; } /** * User dictionary preferences. */ declare class DictionaryPreference extends Preference { /** * The hyphenation exception list to use when composing text. */ composition: ComposeUsing; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * If true, merges the spelling and hyphenation exceptions lists in the * external user dictionary with the lists stored within the document. */ mergeUserDictionary: boolean; /** * The parent of the DictionaryPreference (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, recomposes all stories when the compose using settings are changed, * or when words are added to or removed from the user dictionary. */ recomposeWhenChanged: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): DictionaryPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the DictionaryPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Digits type options. */ declare enum DigitsTypeOptions { /** * Arabic digits */ ARABIC_DIGITS = 1684627826, /** * Bengali digits */ BENGALI_DIGITS = 1684628069, /** * Burmese digits */ BURMESE_DIGITS = 1684628085, /** * Default digits */ DEFAULT_DIGITS = 1684628581, /** * Devanagari digits */ DEVANAGARI_DIGITS = 1684628598, /** * Farsi digits */ FARSI_DIGITS = 1684629089, /** * Full Farsi digits */ FULL_FARSI_DIGITS = 1684629094, /** * Gujarati digits */ GUJARATI_DIGITS = 1684629354, /** * Gurmukhi digits */ GURMUKHI_DIGITS = 1684629357, /** * Hindi digits */ HINDI_DIGITS = 1684629609, /** * Kannada digits */ KANNADA_DIGITS = 1684630369, /** * Khmer digits */ KHMER_DIGITS = 1684630376, /** * Lao digits */ LAO_DIGITS = 1684630625, /** * Malayalam digits */ MALAYALAM_DIGITS = 1684630881, /** * native digits */ NATIVE_DIGITS = 1684631137, /** * Oriya digits */ ORIYA_DIGITS = 1684631410, /** * Tamil digits */ TAMIL_DIGITS = 1684632673, /** * Telugu digits */ TELUGU_DIGITS = 1684632677, /** * Thai digits */ THAI_DIGITS = 1684632680, /** * Tibetan digits */ TIBETAN_DIGITS = 1684632681, } /** * The version of the plugin and article that are available. */ declare enum DigpubArticleVersion { /** * plugin and article versions in that order. */ ALL = 1634495520, /** * article version. */ ARTICLE = 1685078390, /** * plugin version. */ PLUGIN = 1685090412, } /** * The versions that are available. */ declare enum DigpubVersion { /** * plugin, folio and plist versions in that order. */ ALL = 1634495520, /** * folio version. */ FOLIO = 1685087862, /** * plist version. */ PLIST = 1685090422, /** * plugin version. */ PLUGIN = 1685090412, } /** * Dimension attribute which you want to control. */ declare enum DimensionAttributes { /** * Both height and width of dimension. */ BOTH_HEIGHT_WIDTH_ATTRIBUTE = 1700227170, /** * Height attribute of dimension. */ HEIGHT_ATTRIBUTE = 1699247183, /** * Width attribute of dimension. */ WIDTH_ATTRIBUTE = 1700226127, } /** * Dimension constraints for the object-based layout rule */ declare enum DimensionsConstraints { /** * The dimension remains fixed relative to the parent. */ FIXED_DIMENSION = 1145267817, /** * The dimension can vary relative to the parent. */ FLEXIBLE_DIMENSION = 1145267820, } /** * Directional feather effect settings. */ declare class DirectionalFeatherSetting extends Preference { /** * The angle of the feather. (Range: 180 to -180) * @remarks Range: -180 to 180 */ angle: number; /** * If true, the directional feather effect is applied. */ applied: boolean; /** * The feather width (in pixels) on the bottom side of the object * DirectionalFeatherSetting. (Range: .2 to 250) * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomWidth: number | string; /** * The amount to choke the directional feather (as a percentage of the feather * width). (Range: 0 to 100) * @remarks Range: 0 to 100 */ chokeAmount: number; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The shape-following algorithm applied to the feather. */ followShapeMode: FollowShapeModeOptions; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The feather width (in pixels) on the left side of the * DirectionalFeatherSetting. * @remarks Measurement unit — also accepts a string such as "12mm". */ leftWidth: number | string; /** * The amount of noise (as a percentage) applied to the feather region. (Range: * 0 to 100) * @remarks Range: 0 to 100 */ noise: number; /** * The parent of the DirectionalFeatherSetting (a TransparencySetting, * StrokeTransparencySetting, FillTransparencySetting or * ContentTransparencySetting). */ readonly parent: FillTransparencySetting | StrokeTransparencySetting | ContentTransparencySetting | TransparencySetting; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The feather width (in pixels) on the right side of the * DirectionalFeatherSetting. (Range: .2 to 250) * @remarks Measurement unit — also accepts a string such as "12mm". */ rightWidth: number | string; /** * The feather width (in pixels) on the top side of the object * DirectionalFeatherSetting. (Range: .2 to 250) * @remarks Measurement unit — also accepts a string such as "12mm". */ topWidth: number | string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): DirectionalFeatherSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * DirectionalFeatherSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Values to specify the order table cells will display in story and galley * views. */ declare enum DisplayOrderOptions { /** * Order by columns. */ ORDER_BY_COLUMNS = 1652114254, /** * Order by rows. */ ORDER_BY_ROWS = 1652118103, } /** * Default display performance settings for the application. */ declare class DisplayPerformancePreference extends Preference { /** * Object-level default display performance settings. Note: The settings do not * apply to graphics that are already placed in the document. */ defaultDisplaySettings: ViewDisplaySettings; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, ignores object-level default display performance settings and uses * the application-level default display settings; also prevents setting * object-level settings. */ ignoreLocalSettings: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the DisplayPerformancePreference (a Application). */ readonly parent: Application; /** * If true, sets application-level preferences to preserve object-level display * settings. */ persistLocalSettings: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): DisplayPerformancePreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * DisplayPerformancePreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Object-level display settings. */ declare class DisplaySetting extends Preference { /** * If true, uses anti-aliasing for text and bitmap images. */ antialiasing: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The point size below which text is greeked. */ greekBelow: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the DisplaySetting (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The display method for raster images. */ raster: TagRaster; /** * The display setting for transparencies. */ transparency: TagTransparency; /** * The display method for vector images. */ vector: TagVector; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): DisplaySetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the DisplaySetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Display performance options. */ declare enum DisplaySettingOptions { /** * Uses the container object's default display performance preferences setting. * For information, see default display settings. */ DEFAULT_VALUE = 1147563124, /** * Slower performance; displays high-resolution graphics and high-quality * transparencies and turns on anti-aliasing. */ HIGH_QUALITY = 1346922866, /** * Best performance; grays out graphics and turns off transparency and * anti-aliasing. */ OPTIMIZED = 1349480564, /** * Moderate performance speed; displays proxy graphics and low-quality * transparencies and turns on anti-aliasing. */ TYPICAL = 1349810544, } /** * Display setting properties. */ declare class DisplaySettings { /** Returns the DisplaySetting with the specified index or name. */ [index: number]: DisplaySetting; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any DisplaySetting in the collection. */ anyItem(): DisplaySetting; /** * Displays the number of elements in the DisplaySetting. */ count(): number; /** * Returns every DisplaySetting in the collection. */ everyItem(): DisplaySetting; /** * Returns the first DisplaySetting in the collection. */ firstItem(): DisplaySetting; /** * Returns the DisplaySetting with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): DisplaySetting; /** * Returns the DisplaySettings within the specified range. * @param from The DisplaySetting, index, or name at the beginning of the range. Can accept: DisplaySetting, Long Integer or String. * @param to The DisplaySetting, index, or name at the end of the range. Can accept: DisplaySetting, Long Integer or String. */ itemByRange(from: DisplaySetting | number | string, to: DisplaySetting | number | string): DisplaySetting[]; /** * Returns the last DisplaySetting in the collection. */ lastItem(): DisplaySetting; /** * Returns the middle DisplaySetting in the collection. */ middleItem(): DisplaySetting; /** * Returns the DisplaySetting whose index follows the specified DisplaySetting * in the collection. * @param obj The DisplaySetting whose index comes before the desired DisplaySetting. */ nextItem(obj: DisplaySetting): DisplaySetting; /** * Returns the DisplaySetting with the index previous to the specified index. * @param obj The index of the DisplaySetting that follows the desired DisplaySetting. */ previousItem(obj: DisplaySetting): DisplaySetting; /** * Generates a string which, if executed, will return the DisplaySetting. */ toSource(): string; } /** * Options for distributing objects. */ declare enum DistributeOptions { /** * Distribute based on the bottom edges of the objects. */ BOTTOM_EDGES = 1114916196, /** * Distribute based on the horizontal centers of the objects. */ HORIZONTAL_CENTERS = 1215257187, /** * Distribute based on the horizontal spacing of the objects. */ HORIZONTAL_SPACE = 1215257203, /** * Distribute based on the left edges of the objects. */ LEFT_EDGES = 1281770852, /** * Distribute based on the right edges of the objects. */ RIGHT_EDGES = 1383351652, /** * Distribute based on the top edges of the objects. */ TOP_EDGES = 1416643940, /** * Distribute based on the vertical centers of the objects. */ VERTICAL_CENTERS = 1449481315, /** * Distribute based on the vertical spacing of the objects. */ VERTICAL_SPACE = 1449489523, } /** * A document. */ declare class Document { /** * If true, uses LAB alternates for spot colors when available. */ accurateLABSpots: boolean; /** * The active layer. Can also accept: String. */ activeLayer: Layer | string; /** * The active preflight process for this document. */ readonly activeProcess: PreflightProcess; /** * Adjust layout preference settings. */ readonly adjustLayoutPreferences: AdjustLayoutPreference; /** * The rendering intent for colors that result from transparency interactions * on the page after blending. */ afterBlendingIntent: RenderingIntent; /** * All Cell styles */ readonly allCellStyles: CellStyle[]; /** * Lists all character styles (regardless of their group). */ readonly allCharacterStyles: CharacterStyle[]; /** * Lists all graphics contained by the Document. */ readonly allGraphics: Graphic[]; /** * All object styles contained by the Document. */ readonly allObjectStyles: ObjectStyle[]; /** * Lists all page items contained by the Document. */ readonly allPageItems: PageItem[]; /** * Lists all paragraph styles (regardless of their group). */ readonly allParagraphStyles: ParagraphStyle[]; /** * All Table styles */ readonly allTableStyles: TableStyle[]; /** * Anchored object default settings. */ readonly anchoredObjectDefaults: AnchoredObjectDefault; /** * Anchored object settings. */ readonly anchoredObjectSettings: AnchoredObjectSetting; /** * The font size (in points) for Math objects */ appliedMathMLFontSize: number; /** * RGB Color applied on the math object specified in 0-255 range. */ appliedMathMLRgbColor: number[]; /** * The swatch used for math object color. Also accepts swatch name.(RGB, CMYK, * LAB and HSB swatches supported.). Can return: Swatch or NothingEnum * enumerator. Can also accept: String. */ appliedMathMLSwatch: string | Swatch | NothingEnum; /** * A collection of articles. */ readonly articles: Articles; /** * A collection of assignments. */ readonly assignments: Assignments; /** * The XML element associated with the Document. */ readonly associatedXMLElement: XMLItem; /** * Baseline frame grid option settings. */ readonly baselineFrameGridOptions: BaselineFrameGridOption; /** * A collection of bookmarks. */ readonly bookmarks: Bookmarks; /** * Button preference settings. */ readonly buttonPreferences: ButtonPreference; /** * A collection of buttons. */ readonly buttons: Buttons; /** * A collection of cell style groups. */ readonly cellStyleGroups: CellStyleGroups; /** * A collection of cell style mappings. */ readonly cellStyleMappings: CellStyleMappings; /** * A collection of cell styles. */ readonly cellStyles: CellStyles; /** * Chapter numbering preferences. */ readonly chapterNumberPreferences: ChapterNumberPreference; /** * A collection of char style mappings. */ readonly charStyleMappings: CharStyleMappings; /** * A collection of character style groups. */ readonly characterStyleGroups: CharacterStyleGroups; /** * A collection of character styles. */ readonly characterStyles: CharacterStyles; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * CJK grid preference settings. */ readonly cjkGridPreferences: CjkGridPreference; /** * The cloud path in case of a cloud document. Otherwise it throws error. */ readonly cloudPath: string; /** * The policy for handling colors in a CMYK color model, including reading and * embedding color profiles, mismatches between embedded color profiles and the * working space, and moving colors from one document to another. */ cmykPolicy: ColorSettingsPolicy; /** * The current CMYK profile. */ cmykProfile: string; /** * A list of valid CMYK profiles. */ readonly cmykProfileList: string[]; /** * A collection of color groups. */ readonly colorGroups: ColorGroups; /** * A collection of colors. */ readonly colors: Colors; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * A collection of composite fonts. */ readonly compositeFonts: CompositeFonts; /** * A collection of condition sets for conditional text. */ readonly conditionSets: ConditionSets; /** * Conditional text preferences. */ readonly conditionalTextPreferences: ConditionalTextPreference; /** * A collection of conditions for conditional text. */ readonly conditions: Conditions; /** * If true, the Document was converted. */ readonly converted: boolean; /** * A collection of cross reference formats. */ readonly crossReferenceFormats: CrossReferenceFormats; /** * A collection of cross reference text sources. */ readonly crossReferenceSources: CrossReferenceSources; /** * A collection of dashed stroke styles. */ readonly dashedStrokeStyles: DashedStrokeStyles; /** * A collection of data merge image placeholders. */ readonly dataMergeImagePlaceholders: DataMergeImagePlaceholders; /** * The data merge option properties that define the data merge. */ readonly dataMergeOptions: DataMergeOption; /** * Data merge properties that define data merge fields and preferences. */ readonly dataMergeProperties: DataMerge; /** * A collection of data merge QR code placeholders. */ readonly dataMergeQrcodePlaceholders: DataMergeQrcodePlaceholders; /** * A collection of data merge text placeholders. */ readonly dataMergeTextPlaceholders: DataMergeTextPlaceholders; /** * The rendering intent for bitmap images. */ defaultImageIntent: RenderingIntent; /** * User dictionary preference settings. */ readonly dictionaryPreferences: DictionaryPreference; /** * Document preference settings. */ readonly documentPreferences: DocumentPreference; /** * A collection of dotted stroke styles. */ readonly dottedStrokeStyles: DottedStrokeStyles; /** * A collection of DTDs. */ readonly dtds: DTDs; /** * The Version Cue editing state of the file. */ readonly editingState: EditingState; /** * Endnote option settings. */ readonly endnoteOptions: EndnoteOption; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * EPub export preference settings. */ readonly epubExportPreferences: EPubExportPreference; /** * EPub fixed layout export preference settings. */ readonly epubFixedLayoutExportPreferences: EPubFixedLayoutExportPreference; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The default export for web preferences. */ readonly exportForWebPreferences: ExportForWebPreference; /** * The path to the folder containing the document. */ readonly filePath: Folder; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * A collection of fonts. */ readonly fonts: Fonts; /** * Footnote option settings. */ readonly footnoteOptions: FootnoteOption; /** * A collection of form fields. */ readonly formFields: FormFields; /** * The frame fitting option to apply to placed or pasted content. Can be * applied to a frame, object style, or document or to the application. */ readonly frameFittingOptions: FrameFittingOption; /** * The full path to the Document, including the name of the Document. */ readonly fullName: File; /** * Galley preference settings. */ readonly galleyPreferences: GalleyPreference; /** * A collection of gradients. */ readonly gradients: Gradients; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * Grid preference settings. */ readonly gridPreferences: GridPreference; /** * A collection of groups. */ readonly groups: Groups; /** * Guide preference settings. */ readonly guidePreferences: GuidePreference; /** * A collection of guides. */ readonly guides: Guides; /** * HTML5 Export preference settings */ readonly html5ExportPreferences: Html5ExportPreference; /** * HTML export preference settings. */ readonly htmlExportPreferences: HTMLExportPreference; /** * HTML FXL export preference settings. */ readonly htmlFXLExportPreferences: HTMLFXLExportPreference; /** * A collection of hyperlink external page destinations. */ readonly hyperlinkExternalPageDestinations: HyperlinkExternalPageDestinations; /** * A collection of hyperlink page destinations. */ readonly hyperlinkPageDestinations: HyperlinkPageDestinations; /** * A collection of hyperlink page item sources. */ readonly hyperlinkPageItemSources: HyperlinkPageItemSources; /** * A collection of hyperlink text destinations. */ readonly hyperlinkTextDestinations: HyperlinkTextDestinations; /** * A collection of hyperlink text sources. */ readonly hyperlinkTextSources: HyperlinkTextSources; /** * A collection of hyperlink URL destinations. */ readonly hyperlinkURLDestinations: HyperlinkURLDestinations; /** * A collection of hyperlinks. */ readonly hyperlinks: Hyperlinks; /** * A collection of hyphenation exceptions lists. */ readonly hyphenationExceptions: HyphenationExceptions; /** * The unique ID of the Document. */ readonly id: number; /** * The index of the Document within its containing object. */ readonly index: number; /** * The index options properties that define how an index is formatted. */ readonly indexGenerationOptions: IndexOptions; /** * A collection of indexes. */ readonly indexes: Indexes; /** * A collection of indexing sort options. */ readonly indexingSortOptions: IndexingSortOptions; /** * A collection of inks. */ readonly inks: Inks; /** * If true, the document is a cloud document. */ readonly isCloudDocument: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A collection of kinsoku tables. */ readonly kinsokuTables: KinsokuTables; /** * A property that can be set to any string. */ label: string; /** * A collection of languages. */ readonly languages: Languages; /** * A collection of layers. */ readonly layers: Layers; /** * Default properties specific to layout grids. */ readonly layoutGridData: LayoutGridDataInformation; /** * A collection of layout windows. */ readonly layoutWindows: LayoutWindows; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Linked story options */ readonly linkedStoryOptions: LinkedStoryOption; /** * A collection of links. */ readonly links: Links; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * Margin preference settings. */ readonly marginPreferences: MarginPreference; /** * A collection of master spreads. */ readonly masterSpreads: MasterSpreads; /** * A collection of math objects. */ readonly mathObjects: MathObjects; /** * Metadata preference settings. */ readonly metadataPreferences: MetadataPreference; /** * A collection of mixed ink groups. */ readonly mixedInkGroups: MixedInkGroups; /** * A collection of mixed inks. */ readonly mixedInks: MixedInks; /** * If true, the Document has been modified since it was last saved. */ readonly modified: boolean; /** * A collection of mojikumi tables. */ readonly mojikumiTables: MojikumiTables; /** * Mojikumi user interface preference settings. */ readonly mojikumiUIPreferences: MojikumiUiPreference; /** * A collection of Motion presets. */ readonly motionPresets: MotionPresets; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * The name of the Document. */ name: string; /** * A collection of named grids. */ readonly namedGrids: NamedGrids; /** * A collection of numbered lists. */ readonly numberingLists: NumberingLists; /** * A collection of object style groups. */ readonly objectStyleGroups: ObjectStyleGroups; /** * A collection of object styles. */ readonly objectStyles: ObjectStyles; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * The default page item formatting for the Document. */ readonly pageItemDefaults: PageItemDefault; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * A collection of pages. */ readonly pages: Pages; /** * A collection of para style mappings. */ readonly paraStyleMappings: ParaStyleMappings; /** * A collection of paragraph destinations. */ readonly paragraphDestinations: ParagraphDestinations; /** * A collection of paragraph style groups. */ readonly paragraphStyleGroups: ParagraphStyleGroups; /** * A collection of paragraph styles. */ readonly paragraphStyles: ParagraphStyles; /** * The parent of the Document (a Application). */ readonly parent: Application; /** * Pasteboard preference settings. */ readonly pasteboardPreferences: PasteboardPreference; /** * A collection of PDF comment objects */ readonly pdfComments: PDFComments; /** * The place gun. */ readonly placeGuns: PlaceGun; /** * A collection of polygons. */ readonly polygons: Polygons; /** * Preference to export math objects as MathML or SVG in EPUB export. */ preferMathMLInEpubExport: boolean; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * Preflight option settings. */ readonly preflightOptions: PreflightOption; /** * A collection of preflight profiles. */ readonly preflightProfiles: PreflightProfiles; /** * Booklet printing options. */ readonly printBookletOptions: PrintBookletOption; /** * Print booklet preferences. */ readonly printBookletPrintPreferences: PrintBookletPrintPreference; /** * Print preference settings. */ readonly printPreferences: PrintPreference; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Publish export preference settings. */ readonly publishExportPreferences: PublishExportPreference; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * If true, the Document is read-only. */ readonly readOnly: boolean; /** * If true, the Document was recovered. */ readonly recovered: boolean; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * The names of the items in the redo stack. */ readonly redoHistory: string[]; /** * The name of the action on the top of the redo stack. */ readonly redoName: string; /** * The policy for handling colors in an RGB color model, including reading and * embedding color profiles, handling mismatches between embedded color * profiles and the working space, and moving colors from one document to * another. */ rgbPolicy: ColorSettingsPolicy; /** * The current RGB profile. */ rgbProfile: string; /** * A list of valid RGB profiles. */ readonly rgbProfileList: string[]; /** * If true, the Document has been saved since it was created. */ readonly saved: boolean; /** * A collection of sections. */ readonly sections: Sections; /** * The selected page item(s). Can also accept: Object or NothingEnum * enumerator. */ readonly selectedPageItems: (Object | NothingEnum)[]; /** * The selected object(s). Can also accept: Object or NothingEnum enumerator. */ selection: (Object | NothingEnum)[]; /** * The key object of the selection. Can also accept: NothingEnum enumerator. */ selectionKeyObject: PageItem | NothingEnum; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * The rendering intent for all vector art (areas of solid color) in native * objects. */ solidColorIntent: RenderingIntent; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * A collection of spreads. */ readonly spreads: Spreads; /** * A collection of stories. */ readonly stories: Stories; /** * Default properties specific to frame grids. */ readonly storyGridData: StoryGridDataInformation; /** * Story preference settings. */ readonly storyPreferences: StoryPreference; /** * A collection of story windows. */ readonly storyWindows: StoryWindows; /** * A collection of striped stroke styles. */ readonly stripedStrokeStyles: StripedStrokeStyles; /** * A collection of stroke styles. */ readonly strokeStyles: StrokeStyles; /** * A collection of swatches. */ readonly swatches: Swatches; /** * A collection of table style groups. */ readonly tableStyleGroups: TableStyleGroups; /** * A collection of table style mappings. */ readonly tableStyleMappings: TableStyleMappings; /** * A collection of table styles. */ readonly tableStyles: TableStyles; /** * Tagged PDF preferences. */ readonly taggedPDFPreferences: TaggedPDFPreference; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * Text default settings. */ readonly textDefaults: TextDefault; /** * Text frame preference settings. */ readonly textFramePreferences: TextFramePreference; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * Text preference settings. */ readonly textPreferences: TextPreference; /** * A collection of text variables. */ readonly textVariables: TextVariables; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The percent of the base color. (Range: 0 to 100) * @remarks Range: 0 to 100 */ tintValue: number; /** * A collection of tints. */ readonly tints: Tints; /** * A collection of TOC styles. */ readonly tocStyles: TOCStyles; /** * Transparency preference settings. */ readonly transparencyPreferences: TransparencyPreference; /** * A collection of trap presets. */ readonly trapPresets: TrapPresets; /** * The names of the items in the undo stack. */ readonly undoHistory: string[]; /** * The name of the action on the top of the undo stack. */ readonly undoName: string; /** * The swatches that are not being used. */ readonly unusedSwatches: Swatch[]; /** * A collection of XML validation errors. */ readonly validationErrors: ValidationErrors; /** * The Version Cue version state of the file. */ readonly versionState: VersionState; /** * View preference settings. */ readonly viewPreferences: ViewPreference; /** * If true, the Document is visible. */ readonly visible: boolean; /** * Watermark preferences */ readonly watermarkPreferences: WatermarkPreference; /** * A collection of windows. */ readonly windows: Windows; /** * A collection of XML comments. */ readonly xmlComments: XMLComments; /** * A collection of XML elements. */ readonly xmlElements: XMLElements; /** * A collection of XML export maps. */ readonly xmlExportMaps: XMLExportMaps; /** * XML export preference settings. */ readonly xmlExportPreferences: XMLExportPreference; /** * A collection of XML import maps. */ readonly xmlImportMaps: XMLImportMaps; /** * XML import preference settings. */ readonly xmlImportPreferences: XMLImportPreference; /** * A collection of XML instructions. */ readonly xmlInstructions: XMLInstructions; /** * A collection of XML items. */ readonly xmlItems: XMLItems; /** * The XML preference settings. */ readonly xmlPreferences: XMLPreference; /** * A collection of xml stories. */ readonly xmlStories: XmlStories; /** * A collection of XML tags. */ readonly xmlTags: XMLTags; /** * XML view preference settings. */ readonly xmlViewPreferences: XMLViewPreference; /** * The ruler origin, specified as page coordinates in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ zeroPoint: (number | string)[]; /** * Dispatched after the Document becomes active. This event bubbles. This event * is not cancelable. */ static readonly AFTER_ACTIVATE: string; /** * Dispatched after a Document is exported. This event bubbles. This event is * not cancelable. */ static readonly AFTER_EXPORT: string; /** * Dispatched after importing a file into a Document. This event bubbles. This * event is not cancelable. */ static readonly AFTER_IMPORT: string; /** * Dispatched after one or more links in the Document have been added, deleted, * or modified. This event bubbles. This event is not cancelable. */ static readonly AFTER_LINKS_CHANGED: string; /** * Dispatched after a Document is created. This event bubbles. This event is * not cancelable. */ static readonly AFTER_NEW: string; /** * Dispatched after a Document is opened. This event bubbles. This event is not * cancelable. */ static readonly AFTER_OPEN: string; /** * Dispatched after a Document is printed. This event bubbles. This event is * not cancelable. */ static readonly AFTER_PRINT: string; /** * Dispatched after a Document is reverted. This event bubbles. This event is * not cancelable. */ static readonly AFTER_REVERT: string; /** * Dispatched after a Document is saved. This event bubbles. This event is not * cancelable. */ static readonly AFTER_SAVE: string; /** * Dispatched after a Document is saved under a new name. This event bubbles. * This event is not cancelable. */ static readonly AFTER_SAVE_AS: string; /** * Dispatched after a copy of a Document is saved. This event bubbles. This * event is not cancelable. */ static readonly AFTER_SAVE_A_COPY: string; /** * Dispatched before a Document is closed. This event bubbles. This event is * not cancelable. */ static readonly BEFORE_CLOSE: string; /** * Dispatched before the Document becomes inactive. This event bubbles. This * event is not cancelable. */ static readonly BEFORE_DEACTIVATE: string; /** * Dispatched before a Document is exported. This event bubbles. This event is * cancelable. */ static readonly BEFORE_EXPORT: string; /** * Dispatched before importing a file into a Document. This event bubbles. This * event is cancelable. */ static readonly BEFORE_IMPORT: string; /** * Dispatched before a Document is printed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PRINT: string; /** * Dispatched before a Document is reverted. This event bubbles. This event is * cancelable. */ static readonly BEFORE_REVERT: string; /** * Dispatched before a Document is saved. This event bubbles. This event is * cancelable. */ static readonly BEFORE_SAVE: string; /** * Dispatched before a Document is saved under a new name. This event bubbles. * This event is cancelable. */ static readonly BEFORE_SAVE_AS: string; /** * Dispatched before a copy of a Document is saved. This event bubbles. This * event is cancelable. */ static readonly BEFORE_SAVE_A_COPY: string; /** * Dispatched after a Document export is canceled or fails. This event bubbles. * This event is not cancelable. */ static readonly FAILED_EXPORT: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Adjust the existing layout according to new page size, bleed and margin * values. The first parameter is a plain object with key value pairs for * properties affected. Permissible keys are width, height, bleedInside, * bleedTop, bleedOutside, bleedBottom, leftMargin, topMargin, rightMargin, * bottomMargin. The values can be specified as decimal numbers in units of Pt * or as a string having a measurement value such as '1 in'. Not all properties * need to be specified, only the values that need updation. Notice that when * dealing with individual pages rather than the whole document, bleed changes * has no effect. E.g. - app.activeDocument.adjustLayout({width:'600px', * leftMargin: '1in'}), app.activeDocument.adjustLayout({rightMargin:'1in'}, * app.activeDocument.spreads[0].pages), * app.activeDocument.spreads[0].pages[0].adjustLayout({width:'400px', * leftMargin: '10px'}) * @param adoptTo Change values - see functin definition for details * @param affectedPages The collection of Page objects to affect (optional). Has no effect if function is called from Page (Optional) */ adjustLayout(adoptTo: Object, affectedPages?: Page[]): void; /** * Align page items. * @param alignDistributeItems The page items to align or distribute. * @param alignOption The type of alignment to apply. * @param alignDistributeBounds The bounds within which to align or distribute the page items. (Optional) * @param reference The reference or key object to align to distribute relative to. Required when 'align distribute bounds' specifies 'key object'. (Optional) */ align(alignDistributeItems: PageItem[], alignOption: AlignOptions, alignDistributeBounds?: AlignDistributeBounds, reference?: PageItem): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Finds color that matches the find what value and replaces the color with the * change to value. */ changeColor(): number; /** * Change comoser to optyca */ changeComposer(): void; /** * Finds glyphs that match the find what value and replaces the glyphs with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGrep(reverseOrder?: boolean): Text[]; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value and replaces the text * with the change character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeTransliterate(reverseOrder?: boolean): Text[]; /** * Check in to Version Cue. * @param versionComments The comment for this version (Optional) * @param forceSave Forcibly save a version (Optional) */ checkIn(versionComments?: string, forceSave?: boolean): void; /** * Removes the frame fittings options and resets it to the initial state. */ clearFrameFittingOptions(): void; /** * Close the Document * @param saving Whether to save changes before closing the Document (Optional) * @param savingIn The file in which to save the Document (Optional) * @param versionComments The comment for this version (Optional) * @param forceSave Forcibly save a version (Optional) */ close(saving?: SaveOptions, savingIn?: File, versionComments?: string, forceSave?: boolean): void; /** * Transforms color values * @param colorValue source color value * @param sourceColorSpace source color space * @param destinationColorSpace destination color space */ colorTransform(colorValue: number[], sourceColorSpace: ColorSpace, destinationColorSpace: ColorSpace): number[]; /** * Creates an alternate layout for a given list of spreads. * @param spreadItems The spreads to create an alternate layout for. * @param name The name of the alternate layout. Note: This is used for the named layout for the new section for the duplicated spreads. * @param width The width of the pages created. * @param height The height of the pages created. * @param createTextStyles Whether to create new text styles. * @param linkTextStories Whether to create linked text for duplicated text stories. * @param layoutRule What layout rule to set on the pages. */ createAlternateLayout(spreadItems: Spread[], name: string, width: number | string, height: number | string, createTextStyles: boolean, linkTextStories: boolean, layoutRule: LayoutRuleOptions): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Document. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Creates a new object from MathML description. * @param mathmlDescription The MathML description to create the SVG from. * @param mathmlDestinationPage The page on which to create the object. * @param destinationLayer The layer on which to create the Object. * @param placePoint The point where to place the object (only applicable if you are telling a page or spread to place) */ createFromMathML(mathmlDescription: string, mathmlDestinationPage: Page, destinationLayer: Layer, placePoint: (number | string)[]): SVG; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Document. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create a missing font object. * @param fontFamily The name of the font family * @param fontStyleName The name of the font style. * @param postscriptName The PostScript name of the font. */ createMissingFontObject(fontFamily: string, fontStyleName: string, postscriptName: string): Font; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Document. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Creates a table of contents. * @param using The TOC style to use to define the content, title, and format of the table of contents. * @param replacing If true, replaces the existing TOC. (Optional) * @param fromBook The book whose documents to include in the TOC. (Optional) * @param placePoint The point at which to place the TOC story, specified as page coordinates in the format [x, y]. (Optional) * @param includeOverset If true, includes overset text TOC entries in the TOC. (Optional) * @param destinationLayer The layer on which to place the TOC. (Optional) */ createTOC(using: TOCStyle, replacing?: boolean, fromBook?: Book, placePoint?: (number | string)[], includeOverset?: boolean, destinationLayer?: Layer): Story[]; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Document. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Document. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Deletes an alternate layout. * @param name The name of the alternate layout to delete. */ deleteAlternateLayout(name: string): void; /** * Deletes unused XML markup tags. */ deleteUnusedTags(): void; /** * Distribute page items. * @param alignDistributeItems The page items to align or distribute * @param distributeOption The type of distribution to apply. * @param alignDistributeBounds The bounds within which to align or distribute the page items. (Optional) * @param useDistributeMeasurement If true, distribute space between page items. When this property is true, the bounds setting is ignored. (Optional) * @param absoluteDistributeMeasurement The distance to use when distributing page items. Required when 'align distribute bounds' specifies 'key object'. (Optional) * @param reference The reference or key object to align to distribute relative to. Required when 'align distribute bounds' specifies 'key object'. (Optional) */ distribute(alignDistributeItems: PageItem[], distributeOption: DistributeOptions, alignDistributeBounds?: AlignDistributeBounds, useDistributeMeasurement?: boolean, absoluteDistributeMeasurement?: number | string, reference?: PageItem): void; /** * Embed this profile to the document. * @param using The preflight profile to embed. Can accept: String or PreflightProfile. */ embed(using: string | PreflightProfile): PreflightProfile; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Exports as assets required for cloud library. * @param jsondata JSON encoded information about the export. */ exportForCloudLibrary(jsondata: string): boolean; /** * Exports selected page items to snippet on the destination file path. * @param to The path to the export file. */ exportPageItemsSelectionToSnippet(to: File): void; /** * Exports input page item ids to snippet on the destination file path. * @param to The path to the export file. * @param pageItemIds The array of the page item ids. */ exportPageItemsToSnippet(to: File, pageItemIds: number[]): void; /** * Exports stroke styles or presets. * @param to The file to save to * @param strokeStyleList The list of stroke styles to save * @param versionComments The comment for this version (Optional) * @param forceSave Forcibly save a version (Optional) */ exportStrokeStyles(to: File, strokeStyleList: StrokeStyle[], versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds color that matches the find what value. */ findColor(): number; /** * Finds glyphs that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGrep(reverseOrder?: boolean): Text[]; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findTransliterate(reverseOrder?: boolean): Text[]; /** * This will return an array of structs containing information about the * alternate layouts. * @param resolveMaster Resolves layout policy if setting is "use master" - default is true. (Optional) */ getAlternateLayoutsForFolio(resolveMaster?: boolean): any[]; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Document[]; /** * Selected text direction */ getSelectedTextDirection(): TextDirection; /** * Get the resolution strategy for style conflict, false if the user cancels * @param charOrParaStyle Style type to look at. (Optional) */ getStyleConflictResolutionStrategy(charOrParaStyle?: StyleType): any; /** * Internal Use Only * @param resyncData Internal Use Only */ handleMathMLMessage(resyncData: string): void; /** * Imports a process color swatch from a preloaded Adobe color book. * @param name The process color to load. */ importAdobeSwatchbookProcessColor(name: string): Color; /** * Imports a spot color swatch from an Adobe color book. * @param name The spot color to load. */ importAdobeSwatchbookSpotColor(name: string): Color; /** * Imports a DTD to use for validation. * @param from The path to the DTD file. */ importDtd(from: File): void; /** * Imports the cross reference formats from specified file. * @param from The file whose formats to import. */ importFormats(from: File): void; /** * Import Commemnts from PDF * @param from The PDF File from which you want to import comments. * @param withProperties Initial values for properties of the new Document (Optional) */ importPdfComments(from: File, withProperties?: Object): void; /** * Imports the specified styles. * @param format The types of styles to import. * @param from The file containing the styles you want to import. * @param globalStrategy The resolution strategy to employ for imported styles that have the same names as existing styles. (Optional) */ importStyles(format: ImportFormat, from: File, globalStrategy?: GlobalClashResolutionStrategy): void; /** * Imports the specified XML file into an InDesign document. * @param from The XML file. */ importXML(from: File): void; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Internal use only: a black box method for use by InDesign Engineering team * only. * @param internalParameter1 The first internal parameter * @param internalParameter2 The second internal parameter */ internalMethod(internalParameter1: string, internalParameter2: string): string; /** * Load conditions from the specified file. * @param from The path to the file that contains the conditions. * @param loadConditionSets If true, load the condition sets as well. (Optional) */ loadConditions(from: File, loadConditionSets?: boolean): void; /** * Load masterpages from an InDesign file. * @param from The InDesign file to load the masters from. * @param globalStrategyForMasterPage the global clash resolution strategy for load master page (Optional) */ loadMasters(from: File, globalStrategyForMasterPage?: GlobalClashResolutionStrategyForMasterPage): void; /** * Load swatches from the specified file. * @param from The swatch file or InDesign document. */ loadSwatches(from: File): void; /** * Loads a set of XML markup tags from the specified file. * @param from The path to the file that contains the tags. */ loadXMLTags(from: File): void; /** * Auto tag the document based on the style to tag mappings */ mapStylesToXMLTags(): void; /** * Auto style the document based on the tag to style mappings */ mapXMLTagsToStyles(): void; /** * Packages the document. * @param to The folder, alias, or path in which to place the packaged files. * @param copyingFonts If true, copies fonts used in the document to the package folder. * @param copyingLinkedGraphics If true, copies linked graphics files to the package folder. * @param copyingProfiles If true, copies color profiles to the package folder. * @param updatingGraphics If true, updates graphics links to the package folder. * @param includingHiddenLayers If true, copies fonts and links from hidden layers to the package. * @param ignorePreflightErrors If true, ignores preflight errors and proceeds with the packaging. If false, cancels the packaging when errors exist. * @param creatingReport If true, creates a package report that includes printing instructions, print settings, lists of fonts, links and required inks, and other information. * @param includeIdml If true, generates and includes IDML in the package folder. (Optional) * @param includePdf If true, generates and includes PDF in the package folder. (Optional) * @param pdfStyle If specified and PDF is to be included, use this style for PDF export if it is valid, otherwise use the last used PDF preset. (Optional) * @param useDocumentHyphenationExceptionsOnly If this option is selected, InDesign flags this document so that it does not reflow when someone else opens or edits it on a computer that has different hyphenation and dictionary settings. (Optional) * @param versionComments The comments for the version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ packageForPrint(to: File, copyingFonts: boolean, copyingLinkedGraphics: boolean, copyingProfiles: boolean, updatingGraphics: boolean, includingHiddenLayers: boolean, ignorePreflightErrors: boolean, creatingReport: boolean, includeIdml?: boolean, includePdf?: boolean, pdfStyle?: string, useDocumentHyphenationExceptionsOnly?: boolean, versionComments?: string, forceSave?: boolean): boolean; /** * Place one or more files following the behavior of the place menu item. This * may load the place gun or replace the selected object, depending on current * preferences. * @param fileName One or more files to place. Can accept: File or Array of Files. * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: (File | File[])[], showingOptions?: boolean, withProperties?: Object): void; /** * Deprecated: Use ContentPlacerObject load method. Original Description: Place * following the behavior of the place and link story menu item. This will load * the place gun. * @param parentStory The story to place and link from. * @param showingOptions Whether to display the link options dialog (Optional) */ placeAndLink(parentStory: Story, showingOptions?: boolean): void; /** * place a cloud asset on the document * @param jsondata JSON data containing metadata about the cloud asset */ placeCloudAsset(jsondata: string): void; /** * Prints the Document(s). * @param printDialog Whether to invoke the print dialog (Optional) * @param using Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional) */ print(printDialog?: boolean, using?: PrinterPresetTypes | PrinterPreset): void; /** * Print the Booklet using current document and Booklet and Print settings in * the document * @param printBookletDialog Whether to invoke the print booklet dialog (Optional) * @param using Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional) */ printBooklet(printBookletDialog?: boolean, using?: PrinterPresetTypes | PrinterPreset): void; /** * Recomposes the text in the Document. */ recompose(): void; /** * Redoes the last action. */ redo(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Resets all the buttons to their Normal state. */ resetAllButtons(): void; /** * Resets all the multi-state objects to their first state. */ resetAllMultiStateObjects(): void; /** * Reverts the document to its state at the last save operation. */ revert(): boolean; /** * Reverts to the version of the document in Version Cue. * @param forceRevert Forcibly reverts to the project version. (Optional) */ revertToProject(forceRevert?: boolean): void; /** * Save the document * @param to Where to save the document. If the document is already saved, a copy is saved at this path, the original file is closed the new copy is opened (Optional) * @param stationery Whether to save the file as stationery (Optional) * @param versionComments The comment for this version (Optional) * @param forceSave Forcibly save a version (Optional) */ save(to?: File, stationery?: boolean, versionComments?: string, forceSave?: boolean): Document; /** * Saves a copy of the document. * @param to The file path for the copy. Note: Leaves the original document open and does not open the copy. (Optional) * @param stationery If true, saves the file as stationery (Mac OS) or as a template (Windows). Note: The file extension for stationery and templates is different than the extension for regular files. (Optional) */ saveACopy(to?: File, stationery?: boolean): void; /** * Save a copy as cloud document * @param cloudPath The cloud path in case of a cloud document */ saveACopyCloud(cloudPath: string): Document; /** * Save as a cloud document * @param cloudPath The cloud path in case of a cloud document */ saveAsCloud(cloudPath: string): Document; /** * Saves the specified swatch(es) to a swatchbook file. * @param to The swatchbook file to save to. * @param swatchList The swatch(es) to save. * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ saveSwatches(to: File, swatchList: Swatch[], versionComments?: string, forceSave?: boolean): void; /** * Saves a set of tags to an external file. * @param to The full path to the file in which to save the tags. * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ saveXMLTags(to: File, versionComments?: string, forceSave?: boolean): void; /** * Selects the specified object(s). * @param selectableItems The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator. * @param existingSelection The selection status of the Document in relation to previously selected objects. (Optional) */ select(selectableItems: (any[] | NothingEnum | Object | SelectAll)[], existingSelection?: SelectionOptions): void; /** * Synchronizes the file with the Version Cue project. * @param syncConflictResolution The conflict resolution method to use during synchronization. (Optional) * @param versionComments The comments that describe the version. (Optional) */ synchronizeWithVersionCue(syncConflictResolution?: SyncConflictResolution, versionComments?: string): VersionCueSyncStatus; /** * Generates a string which, if executed, will return the Document. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Undoes the last action. */ undo(): void; /** * Updates cross references' text source content in the document. */ updateCrossReferences(): void; /** * Updates the table of contents in this document using the currently applied * TOC style. * @param using The TOC style to use for updating (Optional) */ updateTOC(using?: TOCStyle): void; } /** * A document event. */ declare class DocumentEvent extends Event { /** * If true, the event supports the bubbling phase of propagation. */ readonly bubbles: boolean; /** * If true, the default behavior of the event on its target can be canceled. */ readonly cancelable: boolean; /** * The current propagation target of the event. */ readonly currentTarget: any; /** * If true, the default behavior of the event on its target has been canceled. */ readonly defaultPrevented: boolean; /** * The current propagation phase of the event. */ readonly eventPhase: EventPhases; /** * The name of the event. */ readonly eventType: string; /** * The full path to the DocumentEvent, including the name of the DocumentEvent. */ readonly fullName: File; /** * The unique ID of the DocumentEvent. */ readonly id: number; /** * The index of the DocumentEvent within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the DocumentEvent (a Application or Document). */ readonly parent: Application | Document; /** * If true, propagation of the event beyond the current target has been * stopped. */ readonly propagationStopped: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The target of the event. */ readonly target: any; /** * The time the event was initialized. */ readonly timeStamp: Date; /** * Controls the display of dialogs and alerts during script processing. */ userInteractionLevel: UserInteractionLevels; /** * Dispatched after a Document is closed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_CLOSE: string; /** * Dispatched after a Document is created. This event bubbles. This event is * not cancelable. */ static readonly AFTER_NEW: string; /** * Dispatched after a Document is opened. This event bubbles. This event is not * cancelable. */ static readonly AFTER_OPEN: string; /** * Dispatched after a Document is reverted. This event bubbles. This event is * not cancelable. */ static readonly AFTER_REVERT: string; /** * Dispatched after a Document is saved. This event bubbles. This event is not * cancelable. */ static readonly AFTER_SAVE: string; /** * Dispatched after a Document is saved under a new name. This event bubbles. * This event is not cancelable. */ static readonly AFTER_SAVE_AS: string; /** * Dispatched after a copy of a Document is saved. This event bubbles. This * event is not cancelable. */ static readonly AFTER_SAVE_A_COPY: string; /** * Dispatched before a Document is closed. This event bubbles. This event is * not cancelable. */ static readonly BEFORE_CLOSE: string; /** * Dispatched before a Document is created. This event bubbles. This event is * cancelable. */ static readonly BEFORE_NEW: string; /** * Dispatched before a Document is opened. This event bubbles. This event is * cancelable. */ static readonly BEFORE_OPEN: string; /** * Dispatched before a Document is reverted. This event bubbles. This event is * cancelable. */ static readonly BEFORE_REVERT: string; /** * Dispatched before a Document is saved. This event bubbles. This event is * cancelable. */ static readonly BEFORE_SAVE: string; /** * Dispatched before a Document is saved under a new name. This event bubbles. * This event is cancelable. */ static readonly BEFORE_SAVE_AS: string; /** * Dispatched before a copy of a Document is saved. This event bubbles. This * event is cancelable. */ static readonly BEFORE_SAVE_A_COPY: string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): DocumentEvent[]; /** * Cancels the default behavior of the event on its target. */ preventDefault(): void; /** * Stops propagation of the event beyond the current target. */ stopPropagation(): void; /** * Generates a string which, if executed, will return the DocumentEvent. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for document intent. */ declare enum DocumentIntentOptions { /** * Intended purpose of document is for publishing to mobiles. */ MOBILE_INTENT = 1768846445, /** * Intended purpose of document is for print output. */ PRINT_INTENT = 1768846448, /** * Intended purpose of document is for web output. */ WEB_INTENT = 1768846455, } /** * Document preferences. */ declare class DocumentPreference extends Preference { /** * If true, guarantees that when pages are added to a spread it will contain a * maximum of two pages. If false, allows pages to be added or moved into * existing spreads. For override information, see preserve layout when * shuffling. */ allowPageShuffle: boolean; /** * The direction of text in the column. */ columnDirection: HorizontalOrVertical; /** * The color of the column guides, specified either as an array of three * doubles, each in the range 0 to 255 and representing R, G, and B values,, or * as a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors * enumerator. */ columnGuideColor: (number[][] | UIColors)[]; /** * If true, locks column guides. */ columnGuideLocked: boolean; /** * If true, the document A-master has primary text frames when a new document * is created. */ createPrimaryTextFrame: boolean; /** * The amount to offset the bottom document bleed. Note: To set the bleed * bottom offset, document bleed uniform size must be false. * @remarks Measurement unit — also accepts a string such as "12mm". */ documentBleedBottomOffset: number | string; /** * The amount to offset the inside or left document bleed. Note: To set the * bleed inside or left offset, document bleed uniform size must be false. * @remarks Measurement unit — also accepts a string such as "12mm". */ documentBleedInsideOrLeftOffset: number | string; /** * The amount to offset the outside or right document bleed. Note: To set the * bleed outside or right offset, document bleed uniform size must be false. * @remarks Measurement unit — also accepts a string such as "12mm". */ documentBleedOutsideOrRightOffset: number | string; /** * The amount to offset the top document bleed. * @remarks Measurement unit — also accepts a string such as "12mm". */ documentBleedTopOffset: number | string; /** * If true, uses the document bleed top offset value for bleed offset * measurements on all sides of the document. The default setting is true. */ documentBleedUniformSize: boolean; /** * If true, uses the slug top offset value for slug measurements on all sides * of the document. The default value is false. */ documentSlugUniformSize: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, the document has facing pages. */ facingPages: boolean; /** * The intent for a document. */ intent: DocumentIntentOptions; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The color of the margin guides, specified either as an array of three * doubles, each in the range 0 to 255, representing R, G, and B values, or as * a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. */ marginGuideColor: (number[][] | UIColors)[]; /** * If true, overprints black when saving the document. */ overprintBlack: boolean; /** * The placement of the page binding. */ pageBinding: PageBindingOptions; /** * The height of the page. * @remarks Measurement unit — also accepts a string such as "12mm". */ pageHeight: number | string; /** * The page orientation. */ pageOrientation: PageOrientation; /** * The size of the page. */ pageSize: string; /** * The width of the page. * @remarks Measurement unit — also accepts a string such as "12mm". */ pageWidth: number | string; /** * The number of pages in the document. (Range: 1 to 9999) * @remarks Range: 1 to 9999 */ pagesPerDocument: number; /** * The parent of the DocumentPreference (a Application or Document). */ readonly parent: Application | Document; /** * If true, preserves the layout of spreads that contained more than two pages * when allow page shuffle was turned on. If false, changes multi-page spreads * to two-page spreads if the spreads were created or changed since allow page * shuffle was turned on. */ preserveLayoutWhenShuffling: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The amount to offset the bottom slug. Note: To set the slug bottom offset, * document slug uniform size must be false. * @remarks Measurement unit — also accepts a string such as "12mm". */ slugBottomOffset: number | string; /** * The amount to offset the inside or left slug. Note: To set the slug inside * or left offset, document slug uniform size must be false. * @remarks Measurement unit — also accepts a string such as "12mm". */ slugInsideOrLeftOffset: number | string; /** * The amount to offset the outside or right slug. Note: To set the slug right * or outside offset, document slug uniform size must be false. * @remarks Measurement unit — also accepts a string such as "12mm". */ slugRightOrOutsideOffset: number | string; /** * The amount to offset the top slug. * @remarks Measurement unit — also accepts a string such as "12mm". */ slugTopOffset: number | string; /** * If true, causes UI-based snippet import to use original location for page * items. */ snippetImportUsesOriginalLocation: boolean; /** * If true, denotes that the hidden spread is visible on document. If false, * denotes that the hidden spread is not not visible on document. */ spreadHiddenVisibility: boolean; /** * The starting page number for a document. This is the same as the starting * page number for the first section of a document. Default value is 1. * @remarks Range: 1 to 999999 */ startPageNumber: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): DocumentPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the DocumentPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A preset that contains all of the new document settings. */ declare class DocumentPreset { /** * The bottom edge of the DocumentPreset. * @remarks Measurement unit — also accepts a string such as "12mm". */ bottom: number | string; /** * The number of columns to place on the page. * @remarks Range: 1 to 216 */ columnCount: number; /** * The distance between columns. * @remarks Measurement unit — also accepts a string such as "12mm". */ columnGutter: number | string; /** * If true, the document A-master has primary text frames when a new document * is created. */ createPrimaryTextFrame: boolean; /** * The amount to offset the bottom document bleed. Note: To set the bleed * bottom offset, document bleed uniform size must be false. * @remarks Measurement unit — also accepts a string such as "12mm". */ documentBleedBottomOffset: number | string; /** * The amount to offset the inside or left document bleed. Note: To set the * bleed inside or left offset, document bleed uniform size must be false. * @remarks Measurement unit — also accepts a string such as "12mm". */ documentBleedInsideOrLeftOffset: number | string; /** * The amount to offset the outside or right document bleed. Note: To set the * bleed outside or right offset, document bleed uniform size must be false. * @remarks Measurement unit — also accepts a string such as "12mm". */ documentBleedOutsideOrRightOffset: number | string; /** * The amount to offset the top document bleed. * @remarks Measurement unit — also accepts a string such as "12mm". */ documentBleedTopOffset: number | string; /** * If true, uses the document bleed top offset value for bleed offset * measurements on all sides of the document. The default setting is true. */ documentBleedUniformSize: boolean; /** * If true, uses the slug top offset value for slug measurements on all sides * of the document. The default value is false. */ documentSlugUniformSize: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, the document has facing pages. */ facingPages: boolean; /** * The unique ID of the DocumentPreset. */ readonly id: number; /** * The index of the DocumentPreset within its containing object. */ readonly index: number; /** * The intent for a document. */ intent: DocumentIntentOptions; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The left edge of the DocumentPreset. * @remarks Measurement unit — also accepts a string such as "12mm". */ left: number | string; /** * The name of the DocumentPreset. */ name: string; /** * The height of the page. * @remarks Measurement unit — also accepts a string such as "12mm". */ pageHeight: number | string; /** * The page orientation. */ pageOrientation: PageOrientation; /** * The size of the page. */ pageSize: string; /** * The width of the page. * @remarks Measurement unit — also accepts a string such as "12mm". */ pageWidth: number | string; /** * The number of pages in the document. (Range: 1 to 9999) * @remarks Range: 1 to 9999 */ pagesPerDocument: number; /** * The parent of the DocumentPreset (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The right edge of the DocumentPreset. * @remarks Measurement unit — also accepts a string such as "12mm". */ right: number | string; /** * The amount to offset the bottom slug. Note: To set the slug bottom offset, * document slug uniform size must be false. * @remarks Measurement unit — also accepts a string such as "12mm". */ slugBottomOffset: number | string; /** * The amount to offset the inside or left slug. Note: To set the slug inside * or left offset, document slug uniform size must be false. * @remarks Measurement unit — also accepts a string such as "12mm". */ slugInsideOrLeftOffset: number | string; /** * The amount to offset the outside or right slug. Note: To set the slug right * or outside offset, document slug uniform size must be false. * @remarks Measurement unit — also accepts a string such as "12mm". */ slugRightOrOutsideOffset: number | string; /** * The amount to offset the top slug. * @remarks Measurement unit — also accepts a string such as "12mm". */ slugTopOffset: number | string; /** * The starting page number for a document. This is the same as the starting * page number for the first section of a document. Default value is 1. * @remarks Range: 1 to 999999 */ startPageNumber: number; /** * The top edge of the DocumentPreset. * @remarks Measurement unit — also accepts a string such as "12mm". */ top: number | string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the DocumentPreset. */ duplicate(): DocumentPreset; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): DocumentPreset[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the DocumentPreset. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the DocumentPreset. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of document presets. */ declare class DocumentPresets { /** Returns the DocumentPreset with the specified index or name. */ [index: number]: DocumentPreset; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new DocumentPreset. * @param withProperties Initial values for properties of the new DocumentPreset (Optional) */ add(withProperties?: Object): DocumentPreset; /** * Returns any DocumentPreset in the collection. */ anyItem(): DocumentPreset; /** * Displays the number of elements in the DocumentPreset. */ count(): number; /** * Returns every DocumentPreset in the collection. */ everyItem(): DocumentPreset; /** * Returns the first DocumentPreset in the collection. */ firstItem(): DocumentPreset; /** * Returns the DocumentPreset with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): DocumentPreset; /** * Returns the DocumentPreset with the specified ID. * @param id The ID. */ itemByID(id: number): DocumentPreset; /** * Returns the DocumentPreset with the specified name. * @param name The name. */ itemByName(name: string): DocumentPreset; /** * Returns the DocumentPresets within the specified range. * @param from The DocumentPreset, index, or name at the beginning of the range. Can accept: DocumentPreset, Long Integer or String. * @param to The DocumentPreset, index, or name at the end of the range. Can accept: DocumentPreset, Long Integer or String. */ itemByRange(from: DocumentPreset | number | string, to: DocumentPreset | number | string): DocumentPreset[]; /** * Returns the last DocumentPreset in the collection. */ lastItem(): DocumentPreset; /** * Returns the middle DocumentPreset in the collection. */ middleItem(): DocumentPreset; /** * Returns the DocumentPreset whose index follows the specified DocumentPreset * in the collection. * @param obj The DocumentPreset whose index comes before the desired DocumentPreset. */ nextItem(obj: DocumentPreset): DocumentPreset; /** * Returns the DocumentPreset with the index previous to the specified index. * @param obj The index of the DocumentPreset that follows the desired DocumentPreset. */ previousItem(obj: DocumentPreset): DocumentPreset; /** * Generates a string which, if executed, will return the DocumentPreset. */ toSource(): string; } /** * Document print ui options */ declare enum DocumentPrintUiOptions { /** * Do not show file save dialog during printing. */ SUPPRESS_FILE_SAVE_DIALOG = 1936089444, /** * Do not show print dialog. */ SUPPRESS_PRINT_DIALOG = 1936745575, /** * Do not show progress bar during printing. */ SUPPRESS_PRINT_PROGRESS = 1936748659, /** * Do not show warning dialog during printing. */ SUPPRESS_PRINT_WARNINGS = 1936750450, } /** * A collection of documents. */ declare class Documents { /** Returns the Document with the specified index or name. */ [index: number]: Document; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new document. * @param showingWindow If true, displays the document. (Optional) * @param documentPreset The document preset to use. (Optional) * @param withProperties Initial values for properties of the new Document (Optional) */ add(showingWindow?: boolean, documentPreset?: DocumentPreset, withProperties?: Object): Document; /** * Returns any Document in the collection. */ anyItem(): Document; /** * Displays the number of elements in the Document. */ count(): number; /** * Returns every Document in the collection. */ everyItem(): Document; /** * Returns the first Document in the collection. */ firstItem(): Document; /** * Returns the Document with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Document; /** * Returns the Document with the specified ID. * @param id The ID. */ itemByID(id: number): Document; /** * Returns the Document with the specified name. * @param name The name. */ itemByName(name: string): Document; /** * Returns the Documents within the specified range. * @param from The Document, index, or name at the beginning of the range. Can accept: Document, Long Integer or String. * @param to The Document, index, or name at the end of the range. Can accept: Document, Long Integer or String. */ itemByRange(from: Document | number | string, to: Document | number | string): Document[]; /** * Returns the last Document in the collection. */ lastItem(): Document; /** * Returns the middle Document in the collection. */ middleItem(): Document; /** * Returns the Document whose index follows the specified Document in the * collection. * @param obj The Document whose index comes before the desired Document. */ nextItem(obj: Document): Document; /** * Returns the Document with the index previous to the specified index. * @param obj The index of the Document that follows the desired Document. */ previousItem(obj: Document): Document; /** * Generates a string which, if executed, will return the Document. */ toSource(): string; } /** * A dotted stroke style. */ declare class DottedStrokeStyle extends StrokeStyle { /** * The length of gaps between dots. Define up to five values. * @remarks Measurement unit — also accepts a string such as "12mm". */ dotArray: (number | string)[]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the DottedStrokeStyle. */ readonly id: number; /** * The index of the DottedStrokeStyle within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the DottedStrokeStyle. */ name: string; /** * The parent of the DottedStrokeStyle (a Document or Application). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The corner adjustment applied to the DottedStrokeStyle. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The stroke style type. */ readonly strokeStyleType: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the DottedStrokeStyle. */ duplicate(): DottedStrokeStyle; /** * Resolves the object specifier, creating an array of object references. */ getElements(): DottedStrokeStyle[]; /** * Deletes the stroke style. * @param replacingWith The stroke style to apply in place of the deleted style. . Can accept: StrokeStyle or String. (Optional) */ remove(replacingWith?: StrokeStyle | string): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the DottedStrokeStyle. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of dotted stroke styles. */ declare class DottedStrokeStyles { /** Returns the DottedStrokeStyle with the specified index or name. */ [index: number]: DottedStrokeStyle; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new DottedStrokeStyle. * @param withProperties Initial values for properties of the new DottedStrokeStyle (Optional) */ add(withProperties?: Object): DottedStrokeStyle; /** * Returns any DottedStrokeStyle in the collection. */ anyItem(): DottedStrokeStyle; /** * Displays the number of elements in the DottedStrokeStyle. */ count(): number; /** * Returns every DottedStrokeStyle in the collection. */ everyItem(): DottedStrokeStyle; /** * Returns the first DottedStrokeStyle in the collection. */ firstItem(): DottedStrokeStyle; /** * Returns the DottedStrokeStyle with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): DottedStrokeStyle; /** * Returns the DottedStrokeStyle with the specified ID. * @param id The ID. */ itemByID(id: number): DottedStrokeStyle; /** * Returns the DottedStrokeStyle with the specified name. * @param name The name. */ itemByName(name: string): DottedStrokeStyle; /** * Returns the DottedStrokeStyles within the specified range. * @param from The DottedStrokeStyle, index, or name at the beginning of the range. Can accept: DottedStrokeStyle, Long Integer or String. * @param to The DottedStrokeStyle, index, or name at the end of the range. Can accept: DottedStrokeStyle, Long Integer or String. */ itemByRange(from: DottedStrokeStyle | number | string, to: DottedStrokeStyle | number | string): DottedStrokeStyle[]; /** * Returns the last DottedStrokeStyle in the collection. */ lastItem(): DottedStrokeStyle; /** * Returns the middle DottedStrokeStyle in the collection. */ middleItem(): DottedStrokeStyle; /** * Returns the DottedStrokeStyle whose index follows the specified * DottedStrokeStyle in the collection. * @param obj The DottedStrokeStyle whose index comes before the desired DottedStrokeStyle. */ nextItem(obj: DottedStrokeStyle): DottedStrokeStyle; /** * Returns the DottedStrokeStyle with the index previous to the specified * index. * @param obj The index of the DottedStrokeStyle that follows the desired DottedStrokeStyle. */ previousItem(obj: DottedStrokeStyle): DottedStrokeStyle; /** * Generates a string which, if executed, will return the DottedStrokeStyle. */ toSource(): string; } /** * Drop shadow settings. */ declare class DropShadowSetting extends Preference { /** * The angle at which the shadow is thrown * @remarks Range: -180 to 180 */ angle: number; /** * The blending mode for the drop shadow effect. */ blendMode: BlendMode; /** * The distance between the item and its shadow * @remarks Measurement unit — also accepts a string such as "12mm". */ distance: number | string; /** * The color applied to the drop shadow, specified as a swatch (color, * gradient, tint, or mixed ink), or as an array of color values. The color * mode dictates the array values: for RGB, specify three values, each in the * range 0 to 255, in the format [R,G,B]; for CMYK, specify four values, each * as a percentage and each in the range 0 to 100, in the format [C,M,Y,K]; for * LAB, specify three values in the format [L,A,B], with L in the range 0 to * 100 and A and B in the range -128 to 127. */ effectColor: Swatch; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, the drop shadow will take into account other non-shadow effects. */ honorOtherEffects: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * If true, the layer will knock out the drop shadow. */ knockedOut: boolean; /** * The shadow mode. */ mode: ShadowMode; /** * The amount (as a percentage) of noise applied to the shadow. (Range: 0 to * 100) * @remarks Range: 0 to 100 */ noise: number; /** * The opacity of the drop shadow (as a percentage). (Range: 0 to 100) * @remarks Range: 0 to 100 */ opacity: number; /** * The parent of the DropShadowSetting (a TransparencySetting, * StrokeTransparencySetting, FillTransparencySetting or * ContentTransparencySetting). */ readonly parent: FillTransparencySetting | StrokeTransparencySetting | ContentTransparencySetting | TransparencySetting; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The radius (in pixels) of the blur applied to the drop shadow. (Range * depends on the unit type. For points: 0 to 144; for picas: 0p0 to 12p0; for * inches: 0 to 2; for mm: 0 to 50.08; for cm: 0 to 5.08; for ciceros: 0c0 to * 11c3.128.) * @remarks Measurement unit — also accepts a string such as "12mm". */ size: number | string; /** * The amount (as a percentage of the blur width) to spread the footprint of * the drop shadow and reduce the radius of the blur. (Range: 0 to 100) * @remarks Range: 0 to 100 */ spread: number; /** * If true, uses the global light angle. */ useGlobalLight: boolean; /** * The horizontal offset of the drop shadow. Range depends on the unit type. * For points: -1000 to 1000; for picas: -83p4 to 83p4; for inches: -13.8889 to * 13.8889; for mm: -352.778 to 352.778; for cm: -35.277 to 35.277; for * ciceros: -78c2.389 to 78c2.389. * @remarks Measurement unit — also accepts a string such as "12mm". */ xOffset: number | string; /** * The vertical offset of the drop shadow. (Range depends on the unit type. For * points: -1000 to 1000; for picas: -83p4 to 83p4; for inches: -13.8889 to * 13.8889; for mm: -352.778 to 352.778; for cm: -35.277 to 35.277; for * ciceros: -78c2.389 to 78c2.389) * @remarks Measurement unit — also accepts a string such as "12mm". */ yOffset: number | string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): DropShadowSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the DropShadowSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A dropdown control. */ declare class Dropdown extends Widget { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the Dropdown. */ readonly id: number; /** * The index of the Dropdown within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The width of the control. For an editbox or combobox, specifies the minimum * width of the box. */ minWidth: number; /** * The parent of the Dropdown (a DialogColumn, DialogRow, EnablingGroup or * BorderPanel). */ readonly parent: DialogRow | EnablingGroup | BorderPanel | DialogColumn; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The index of the selection in a dropdown or combobox control. */ selectedIndex: number; /** * The menu items on a dropdown or combobox control, as an array of strings. */ stringList: string[]; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Dropdown[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Dropdown. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of dropdowns. */ declare class Dropdowns { /** Returns the Dropdown with the specified index or name. */ [index: number]: Dropdown; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new Dropdown. * @param withProperties Initial values for properties of the new Dropdown (Optional) */ add(withProperties?: Object): Dropdown; /** * Returns any Dropdown in the collection. */ anyItem(): Dropdown; /** * Displays the number of elements in the Dropdown. */ count(): number; /** * Returns every Dropdown in the collection. */ everyItem(): Dropdown; /** * Returns the first Dropdown in the collection. */ firstItem(): Dropdown; /** * Returns the Dropdown with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Dropdown; /** * Returns the Dropdown with the specified ID. * @param id The ID. */ itemByID(id: number): Dropdown; /** * Returns the Dropdowns within the specified range. * @param from The Dropdown, index, or name at the beginning of the range. Can accept: Dropdown, Long Integer or String. * @param to The Dropdown, index, or name at the end of the range. Can accept: Dropdown, Long Integer or String. */ itemByRange(from: Dropdown | number | string, to: Dropdown | number | string): Dropdown[]; /** * Returns the last Dropdown in the collection. */ lastItem(): Dropdown; /** * Returns the middle Dropdown in the collection. */ middleItem(): Dropdown; /** * Returns the Dropdown whose index follows the specified Dropdown in the * collection. * @param obj The Dropdown whose index comes before the desired Dropdown. */ nextItem(obj: Dropdown): Dropdown; /** * Returns the Dropdown with the index previous to the specified index. * @param obj The index of the Dropdown that follows the desired Dropdown. */ previousItem(obj: Dropdown): Dropdown; /** * Generates a string which, if executed, will return the Dropdown. */ toSource(): string; } /** * Dynamic documents JPEG Quality options. */ declare enum DynamicDocumentsJPEGQualityOptions { /** * Uses high JPEG compression. */ HIGH = 1701726313, /** * Uses low JPEG compression. */ LOW = 1701727351, /** * Uses maximum JPEG compression. */ MAXIMUM = 1701727608, /** * Uses medium JPEG compression. */ MEDIUM = 1701727588, /** * Uses minimum JPEG compression. */ MINIMUM = 1701727598, } /** * Dynamic documents text export policy. */ declare enum DynamicDocumentsTextExportPolicy { /** * Text is exported as live text. */ LIVE = 1952804972, /** * Text is to be rasterized. */ RASTERIZE = 1952804978, /** * Text is exported as Text Layout Framework text. */ TLF = 1952804980, /** * Text is to be vectorized. */ VECTORIZE = 1952804982, } /** * Dynamic media handling options. */ declare enum DynamicMediaHandlingOptions { /** * Draw interactive elements appearance only. */ APPEARANCE_ONLY = 1097887823, /** * Include all interactive elements. */ INCLUDE_ALL_MEDIA = 1231241580, } /** * The event that triggers a list of dynamic target objects to play. */ declare enum DynamicTriggerEvents { /** * target is triggered on a button or self click. */ ON_CLICK = 1953317740, /** * target is triggered on clicking on the page. */ ON_PAGE_CLICK = 1953321027, /** * target is triggered on loading of the page. */ ON_PAGE_LOAD = 1953321036, /** * target is triggered on a button release. */ ON_RELEASE = 1953321580, /** * target is triggered on a button rolloff. */ ON_ROLLOFF = 1953321574, /** * target is triggered on a button or self rollover. */ ON_ROLLOVER = 1953321590, /** * target is triggered on self click. */ ON_SELF_CLICK = 1951613804, /** * target is triggered on self rollover. */ ON_SELF_ROLLOVER = 1951617638, /** * target is triggered on loading of the state in a multi-state object. */ ON_STATE_LOAD = 1953321804, } /** * A placed EPS file. */ declare class EPS extends Graphic { /** * Indicates whether the EPS has been flipped independently of its parent * object and, if yes, the direction in which the EPS was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the EPS relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the EPS relative to its containing object. (Range: * -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the EPS relative to its containing object. (Range: -360 * to 360) */ absoluteShearAngle: number; /** * The vertical scale of the EPS relative to its containing object. */ absoluteVerticalScale: number; /** * The native resolution of a placed graphic. */ readonly actualPpi: number[]; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the EPS. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the EPS. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the EPS. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the EPS. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the EPS. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * Clipping path settings. */ readonly clippingPath: ClippingPathSettings; /** * The color profile policy for CMYK content in a placed vector. */ cmykVectorPolicy: PlacedVectorProfilePolicy; /** * Transparency settings for the content of the EPS. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The resolution of a graphic after it has been resized. */ readonly effectivePpi: number[]; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the EPS. */ endJoin: EndJoin; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * EPS. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the EPS's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the EPS. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the EPS excluding the stroke width, in the format [y1, x1, y2, * x2], which give the coordinates of the top-left and bottom-right corners of * the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the EPS. (Range: -180 * to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the EPS. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the EPS, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the EPS. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the EPS. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the EPS, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * The color profile policy for grayscale content in a placed vector. */ grayVectorPolicy: PlacedVectorProfilePolicy; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the EPS. */ horizontalScale: number; /** * The unique ID of the EPS. */ readonly id: number; /** * The type of the image. */ readonly imageTypeName: string; /** * The index of the EPS within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the EPS is on. */ itemLayer: Layer; /** * The source file of the link. */ readonly itemLink: Link; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the EPS. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the EPS is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * The name of the EPS. */ name: string; /** * If true, the EPS does not print. */ nonprinting: boolean; /** * If true, the EPS's fill color overprints any underlying objects. If false, * the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the EPS's stroke color overprints any underlying objects. If false, * the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the EPS (a Snippet, XMLElement, PlaceGun, TextBox, * SignatureField, ComboBox, ListBox, SplineItem, Polygon, GraphicLine, * Rectangle, Oval or State). */ readonly parent: ComboBox | GraphicLine | ListBox | Oval | PlaceGun | Polygon | Rectangle | SignatureField | SplineItem | TextBox | XMLElement | Snippet | State; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The color profile policy for RGB content in a placed vector. */ rgbVectorPolicy: PlacedVectorProfilePolicy; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the EPS. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the EPS. (Range: -360 to 360) */ shearAngle: number; /** * The color space. */ readonly space: string; /** * The stroke alignment applied to the EPS. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the EPS. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the EPS. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the EPS's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the EPS. */ verticalScale: number; /** * If true, the EPS is visible. */ visible: boolean; /** * The bounds of the EPS including the stroke width, in the format [y1, x1, y2, * x2], which give the coordinates of the top-left and bottom-right corners of * the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * Dispatched after a EPS is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a EPS is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the EPS's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the EPS that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the EPS. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the EPS to a different shape. * @param given The EPS's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new EPS. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new EPS. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new EPS. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new EPS. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new EPS. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the EPS at the specified location or offset. * @param to The location of the new EPS, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new EPS from the original EPS's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Exports the EPS for the web. * @param to The full path name of the exported file. */ exportForWeb(to: File): string[]; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the EPS. * @param given The axis around which to flip the EPS. * @param around The point around which to flip the EPS. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): EPS[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the EPS to a new location. Note: Either the 'to' or 'by' parameter is * required; if both parameters are defined, only the to value is used. * @param to The new location of the EPS,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the EPS relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the EPS. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the EPS in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new EPS (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the EPS. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the EPS using the last transformation performed on any object. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformAgain(): string[]; /** * Transforms the EPS using the last transformation performed on any EPS. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformAgainIndividually(): string[]; /** * Transforms the EPS using the last sequence of transform operations performed * on any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgain(): string[]; /** * Transforms the EPS using the last sequence of transformations performed on * any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * Color space options for representing color in the exported EPS. */ declare enum EPSColorSpace { /** * Creates a separable file by representing all color values using the gamut of * CYMK process color inks. */ CMYK = 1129142603, /** * Converts all color values to high-quality black-and-white images. Gray * levels of the converted objects represent the luminosity of the original * objects. */ GRAY = 1766290041, /** * Uses PostScript color management (includes profiles). */ POSTSCRIPT_COLOR_MANAGEMENT = 1164208483, /** * Represents all color values using the RGB color space. Best suited for * documents that will be viewed on-screen. */ RGB = 1666336578, /** * Leaves each image in its original color space. */ UNCHANGED_COLOR_SPACE = 1970161251, } /** * EPS export preferences. */ declare class EPSExportPreference extends Preference { /** * The transparency flattener preset to use. */ appliedFlattenerPreset: FlattenerPreset; /** * The height of the bleed area at the bottom of the page. Note: Valid only * when use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedBottom: number | string; /** * The width of the bleed area at the inside of the page. Note: Valid only when * use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedInside: number | string; /** * The width of the bleed area at the outside of the page. Note: Valid only * when use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedOutside: number | string; /** * The height of the bleed area at the top of the page. Note: Valid only when * use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedTop: number | string; /** * The format in which to send image data to the printer. */ dataFormat: DataFormat; /** * The color space for representing color in the exported EPS. */ epsColor: EPSColorSpace; /** * If true, exports facing pages as a single page that has the width of the * spread. If false, exports spread pages as separate pages. */ epsSpreads: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Controls how fonts are embedded in the exported EPS. */ fontEmbedding: FontEmbedding; /** * If true, ignores flattener spread overrides. */ ignoreSpreadOverrides: boolean; /** * The image data to export to the EPS document. */ imageData: EPSImageData; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * If true, replaces bitmap images with OPI links. */ omitBitmaps: boolean; /** * If true, replaces EPS images with OPI links. */ omitEPS: boolean; /** * If true, replaces PDF images with OPI links. */ omitPDF: boolean; /** * If true, prints graphics that are either OPI comments stored in imported EPS * files or linked using OPI comments. For information on linking files using * OPI comments, see omit EPS, omit PDF, or omit bitmaps. */ opiImageReplacement: boolean; /** * The pages to print, specified either as an enumeration or a string. To * specify a range, separate page numbers in the string with a hyphen (-). To * specify separate pages, separate page numbers in the string with a comma * (,). Can return: PageRange enumerator or String. */ pageRange: PageRange | string; /** * The parent of the EPSExportPreference (a Application). */ readonly parent: Application; /** * The PostScript level of the printer. */ postscriptLevel: PostScriptLevels; /** * The file format of the preview image saved with the exported EPS file. */ preview: PreviewTypes; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): EPSExportPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the EPSExportPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for exporting image data to the EPS document. */ declare enum EPSImageData { /** * Exports high-resolution data. Note: Use when the file will be printed on a * high-resolution output device. */ ALL_IMAGE_DATA = 1853058416, /** * Exports only screen-resolution versions (72 dpi) of placed bitmap images. * Note: Use in conjunction with OPI image replacement or if the resulting file * will be viewed on-screen. */ PROXY_IMAGE_DATA = 1819243130, } /** * EPS import preferences. */ declare class EPSImportPreference extends Preference { /** * If true, applies clipping paths stored in the EPS file. */ epsFrames: boolean; /** * Indicates when to create preview images. */ epsProxy: CreateProxy; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * If true, reads OPI image links in the imported EPS file. If false, preserves * the OPI links but does not read them. */ opiComments: boolean; /** * The parent of the EPSImportPreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): EPSImportPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the EPSImportPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * EPSText. */ declare class EPSText extends PageItem { /** * Indicates whether the EPSText has been flipped independently of its parent * object and, if yes, the direction in which the EPSText was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the EPSText relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the EPSText relative to its containing object. (Range: * -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the EPSText relative to its containing object. (Range: * -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the EPSText relative to its containing object. */ absoluteVerticalScale: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the EPSText. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the EPSText. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * Anchored object settings. */ readonly anchoredObjectSettings: AnchoredObjectSetting; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the EPSText. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the EPSText. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the EPSText. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * Transparency settings for the content of the EPSText. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the EPSText. */ endJoin: EndJoin; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * EPSText. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the EPSText's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the EPSText. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the EPSText excluding the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the EPSText. (Range: * -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the EPSText. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the EPSText, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the EPSText. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the EPSText. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the EPSText, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the EPSText. */ horizontalScale: number; /** * The unique ID of the EPSText. */ readonly id: number; /** * The index of the EPSText within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the EPSText is on. */ itemLayer: Layer; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the EPSText. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the EPSText is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * The name of the EPSText. */ name: string; /** * If true, the EPSText does not print. */ nonprinting: boolean; /** * If true, the EPSText's fill color overprints any underlying objects. If * false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the EPSText's stroke color overprints any underlying objects. If * false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the EPSText (a Snippet, PlaceGun, ComboBox, ListBox, TextBox, * SignatureField, Spread, MasterSpread, SplineItem, Polygon, GraphicLine, * Rectangle, Oval, Group, State or Character). */ readonly parent: ComboBox | GraphicLine | Group | ListBox | MasterSpread | Oval | PlaceGun | Polygon | Rectangle | SignatureField | SplineItem | Spread | State | TextBox | Character | Snippet; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the EPSText. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the EPSText. (Range: -360 to 360) */ shearAngle: number; /** * The stroke alignment applied to the EPSText. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the EPSText. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the EPSText. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the EPSText's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of text paths. */ readonly textPaths: TextPaths; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the EPSText. */ verticalScale: number; /** * If true, the EPSText is visible. */ visible: boolean; /** * The bounds of the EPSText including the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * Dispatched after a EPSText is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a EPSText is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the EPSText's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the EPSText that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Brings the EPSText forward one level in its layer. */ bringForward(): void; /** * Brings the EPSText to the front of its layer or in front of a particular * item. * @param reference The reference object to bring the object in front of (must have same parent) (Optional) */ bringToFront(reference?: PageItem): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the EPSText. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the EPSText to a different shape. * @param given The EPSText's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new EPSText. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new EPSText. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new EPSText. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new EPSText. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new EPSText. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the EPSText at the specified location or offset. * @param to The location of the new EPSText, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new EPSText from the original EPSText's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the EPSText. * @param given The axis around which to flip the EPSText. * @param around The point around which to flip the EPSText. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): EPSText[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the EPSText to a new location. Note: Either the 'to' or 'by' parameter * is required; if both parameters are defined, only the to value is used. * @param to The new location of the EPSText,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the EPSText relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the EPSText. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the EPSText in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Sends the EPSText back one level in its layer. */ sendBackward(): void; /** * Sends the EPSText to the back of its layer or behind a particular item (must * have same parent). * @param reference The reference object to send the object behind (Optional) */ sendToBack(reference?: PageItem): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new EPSText (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the EPSText. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the EPSText using the last transformation performed on any * object. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgain(): string[]; /** * Transforms the EPSText using the last transformation performed on any * EPSText. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgainIndividually(): string[]; /** * Transforms the EPSText using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the EPSText using the last sequence of transformations performed * on any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * EPSTexts */ declare class EPSTexts { /** Returns the EPSText with the specified index or name. */ [index: number]: EPSText; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any EPSText in the collection. */ anyItem(): EPSText; /** * Displays the number of elements in the EPSText. */ count(): number; /** * Returns every EPSText in the collection. */ everyItem(): EPSText; /** * Returns the first EPSText in the collection. */ firstItem(): EPSText; /** * Returns the EPSText with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): EPSText; /** * Returns the EPSText with the specified ID. * @param id The ID. */ itemByID(id: number): EPSText; /** * Returns the EPSText with the specified name. * @param name The name. */ itemByName(name: string): EPSText; /** * Returns the EPSTexts within the specified range. * @param from The EPSText, index, or name at the beginning of the range. Can accept: EPSText, Long Integer or String. * @param to The EPSText, index, or name at the end of the range. Can accept: EPSText, Long Integer or String. */ itemByRange(from: EPSText | number | string, to: EPSText | number | string): EPSText[]; /** * Returns the last EPSText in the collection. */ lastItem(): EPSText; /** * Returns the middle EPSText in the collection. */ middleItem(): EPSText; /** * Returns the EPSText whose index follows the specified EPSText in the * collection. * @param obj The EPSText whose index comes before the desired EPSText. */ nextItem(obj: EPSText): EPSText; /** * Returns the EPSText with the index previous to the specified index. * @param obj The index of the EPSText that follows the desired EPSText. */ previousItem(obj: EPSText): EPSText; /** * Generates a string which, if executed, will return the EPSText. */ toSource(): string; } /** * A collection of EPS files. */ declare class EPSs { /** Returns the EPS with the specified index or name. */ [index: number]: EPS; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any EPS in the collection. */ anyItem(): EPS; /** * Displays the number of elements in the EPS. */ count(): number; /** * Returns every EPS in the collection. */ everyItem(): EPS; /** * Returns the first EPS in the collection. */ firstItem(): EPS; /** * Returns the EPS with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): EPS; /** * Returns the EPS with the specified ID. * @param id The ID. */ itemByID(id: number): EPS; /** * Returns the EPS with the specified name. * @param name The name. */ itemByName(name: string): EPS; /** * Returns the EPSs within the specified range. * @param from The EPS, index, or name at the beginning of the range. Can accept: EPS, Long Integer or String. * @param to The EPS, index, or name at the end of the range. Can accept: EPS, Long Integer or String. */ itemByRange(from: EPS | number | string, to: EPS | number | string): EPS[]; /** * Returns the last EPS in the collection. */ lastItem(): EPS; /** * Returns the middle EPS in the collection. */ middleItem(): EPS; /** * Returns the EPS whose index follows the specified EPS in the collection. * @param obj The EPS whose index comes before the desired EPS. */ nextItem(obj: EPS): EPS; /** * Returns the EPS with the index previous to the specified index. * @param obj The index of the EPS that follows the desired EPS. */ previousItem(obj: EPS): EPS; /** * Generates a string which, if executed, will return the EPS. */ toSource(): string; } /** * EPub export preferences. */ declare class EPubExportPreference extends Preference { /** * Bottom margin of the epub. */ bottomMargin: number; /** * If true, break InDesign document into smaller piece when generating epub. */ breakDocument: boolean; /** * The bullet export option. */ bulletExportOption: BulletListExportOption; /** * The epub cover image file path. */ coverImageFile: string; /** * Allows user to select the image size option for conversion */ customImageSizeOption: ImageSizeOption; /** * If true, embed font in epub. */ embedFont: boolean; /** * The epub accessibility certified by. */ epubAccessibilityCertifiedBy: string; /** * The epub accessibility conforms to. */ epubAccessibilityConformsTo: string; /** * The epub accessibility credentials. */ epubAccessibilityCredentials: string; /** * The epub accessibility feature. */ epubAccessibilityFeature: string; /** * The epub accessibility hazard. */ epubAccessibilityHazard: string; /** * The epub accessibility mode. */ epubAccessibilityMode: string; /** * The epub accessibility mode sufficient. */ epubAccessibilityModeSufficient: string; /** * The epub accessibility report link. */ epubAccessibilityReportLink: string; /** * The epub accessibility summary. */ epubAccessibilitySummary: string; /** * The epub cover option. */ epubCover: EpubCover; /** * If true, The epub create page navigation. */ epubCreatePageNavigation: boolean; /** * The epub creator. */ epubCreator: string; /** * The epub date. */ epubDate: string; /** * The epub description. */ epubDescription: string; /** * The epub publisher. */ epubPublisher: string; /** * The epub rights. */ epubRights: string; /** * The epub subject. */ epubSubject: string; /** * The epub title. */ epubTitle: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The export order. */ exportOrder: ExportOrder; /** * The file path of external cascading style sheets. */ externalStyleSheets: string[]; /** * The placement of footnote for EPub export */ footnotePlacement: EPubFootnotePlacement; /** * If true, InDesign will generate cascade style sheet. */ generateCascadeStyleSheet: boolean; /** * If true, generates interlaced GIFs. Note: Not valid when image conversion is * JPEG. */ gifOptionsInterlaced: boolean; /** * The color palette for GIF conversion. Note: Not valid when image conversion * is JPEG. */ gifOptionsPalette: GIFOptionsPalette; /** * The epub unique identifier, like ISBN. */ id: string; /** * ignore object level image conversion settings. */ ignoreObjectConversionSettings: boolean; /** * Alignment applied to images */ imageAlignment: ImageAlignmentType; /** * The file format to use for converted images. Note: Valid only when copy * optimized images and/or copy formatted images is true. */ imageConversion: ImageConversion; /** * The export resolution */ imageExportResolution: ImageResolution; /** * Image page break settings to be used with objects */ imagePageBreak: ImagePageBreakType; /** * Space After applied to images * @remarks Range: 0 to 8640 */ imageSpaceAfter: number; /** * Space Before applied to images * @remarks Range: 0 to 8640 */ imageSpaceBefore: number; /** * If true, InDesign will generate class attributes for elements in HTML, else * will generate plain html without class attributes. */ includeClassesInHTML: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The file path of external javascripts. */ javascripts: string[]; /** * The formatting method for converted JPEG images. Note: Not valid when image * conversion is GIF. */ jpegOptionsFormat: JPEGOptionsFormat; /** * The quality of converted JPEG images. Note: Not valid when image conversion * is GIF. */ jpegOptionsQuality: JPEGOptionsQuality; /** * Left margin of the epub. */ leftMargin: number; /** * The PNG compression level. */ readonly level: number; /** * The numbered list export option. */ numberedListExportOption: NumberedListExportOption; /** * The name of paragraph style to break InDesign document. */ paragraphStyleName: string; /** * The parent of the EPubExportPreference (a Book or Document). */ readonly parent: Book | Document; /** * If true, format image based on layout appearence. */ preserveLayoutAppearence: boolean; /** * If true, output local style override. */ preserveLocalOverride: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Right margin of the epub. */ rightMargin: number; /** * If true, strip soft return. */ stripSoftReturn: boolean; /** * The name of TOC style to generate epub TOC. */ tocStyleName: string; /** * Top margin of the epub. */ topMargin: number; /** * If true, InDesign will use existing image for graphic objects on export. */ useExistingImageOnExport: boolean; /** * If true, image page break settings will be used in objects */ useImagePageBreak: boolean; /** * Use SVG As */ useSVGAs: UseSVGAsEnum; /** * The version of EPUB. */ version: EpubVersion; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): EPubExportPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the EPubExportPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * EPub export preview app preferences. */ declare class EPubExportPreviewAppPreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the EPubExportPreviewAppPreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, open docuemnt in viewer after export. */ viewDocumentAfterExport: boolean; /** * Add a new preview application preference * @param applicationPath The full path of the application to be added. * @param selectedForReflowableEpub Check if the app is selected in Reflowable ePub export. * @param selectedForFixedLayoutEpub Check if the app is selected in Fixed Layout ePub export. * @param withProperties Initial values for properties of the new EPubExportPreviewAppPreference (Optional) */ addApplication(applicationPath: string, selectedForReflowableEpub: boolean, selectedForFixedLayoutEpub: boolean, withProperties?: Object): void; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Get the application at index. * @param indexOfApp The index of the application to get information for. * @param withProperties Initial values for properties of the new EPubExportPreviewAppPreference (Optional) */ getApplicationAtIndex(indexOfApp: boolean, withProperties?: Object): any; /** * Number of applications added for ePub Preview. */ getApplicationCount(): number; /** * Resolves the object specifier, creating an array of object references. */ getElements(): EPubExportPreviewAppPreference[]; /** * Remove an application at specified index. * @param indexOfApp The index of the application to be removed. * @param withProperties Initial values for properties of the new EPubExportPreviewAppPreference (Optional) */ removeApplication(indexOfApp: number, withProperties?: Object): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * EPubExportPreviewAppPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * EPub fixed layout export preferences. */ declare class EPubFixedLayoutExportPreference extends Preference { /** * The epub cover image file path. */ coverImageFile: string; /** * The epub accessibility certified by. */ epubAccessibilityCertifiedBy: string; /** * The epub accessibility conforms to. */ epubAccessibilityConformsTo: string; /** * The epub accessibility credentials. */ epubAccessibilityCredentials: string; /** * The epub accessibility feature. */ epubAccessibilityFeature: string; /** * The epub accessibility hazard. */ epubAccessibilityHazard: string; /** * The epub accessibility mode. */ epubAccessibilityMode: string; /** * The epub accessibility mode sufficient. */ epubAccessibilityModeSufficient: string; /** * The epub accessibility report link. */ epubAccessibilityReportLink: string; /** * The epub accessibility summary. */ epubAccessibilitySummary: string; /** * The epub cover option. */ epubCover: EpubCover; /** * The epub creator. */ epubCreator: string; /** * The epub date. */ epubDate: string; /** * The epub description. */ epubDescription: string; /** * The epub navigation style. */ epubNavigationStyles: EpubNavigationStyle; /** * The epub page range. */ epubPageRange: string; /** * The epub page range format. */ epubPageRangeFormat: PageRangeFormat; /** * The epub publisher. */ epubPublisher: string; /** * The epub rights. */ epubRights: string; /** * The control for spreads in fixed layout EPub. */ epubSpreadControlOptions: EpubFixedLayoutSpreadControl; /** * The epub subject. */ epubSubject: string; /** * The epub title. */ epubTitle: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The file path of external cascading style sheets. */ externalStyleSheets: string[]; /** * If true, generates interlaced GIFs. Note: Not valid when image conversion is * JPEG. */ gifOptionsInterlaced: boolean; /** * The color palette for GIF conversion. Note: Not valid when image conversion * is JPEG. */ gifOptionsPalette: GIFOptionsPalette; /** * The epub unique identifier, like ISBN. */ id: string; /** * The file format to use for converted images. Note: Valid only when copy * optimized images and/or copy formatted images is true. */ imageConversion: ImageConversion; /** * The export resolution */ imageExportResolution: ImageResolution; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The file path of external javascripts. */ javascripts: string[]; /** * The formatting method for converted JPEG images. Note: Not valid when image * conversion is GIF. */ jpegOptionsFormat: JPEGOptionsFormat; /** * The quality of converted JPEG images. Note: Not valid when image conversion * is GIF. */ jpegOptionsQuality: JPEGOptionsQuality; /** * The PNG compression level. */ readonly level: number; /** * The parent of the EPubFixedLayoutExportPreference (a Book or Document). */ readonly parent: Book | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The name of TOC style to generate epub TOC. */ tocStyleName: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): EPubFixedLayoutExportPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * EPubFixedLayoutExportPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Choices for footnote placement. */ declare enum EPubFootnotePlacement { /** * Footnote after paragraph. */ FOOTNOTE_AFTER_PARAGRAPH = 1701213296, /** * Footnote after story. */ FOOTNOTE_AFTER_STORY = 1701213267, /** * Footnote inside popup. */ FOOTNOTE_INSIDE_POPUP = 1701213235, } /** * The editing state of the file in Version Cue. */ declare enum EditingState { /** * The file was modified locally or remotely while it was locked and therefore * two versions exist. */ EDITING_CONFLICT = 1986217283, /** * The file has been modified locally and not locked. */ EDITING_LOCALLY = 1986217292, /** * The file has been locked locally and may be modified. */ EDITING_LOCALLY_LOCKED = 1986217291, /** * The file is not currently in use and is not locked. */ EDITING_NOWHERE = 1986217294, /** * Lock held but not usable. */ EDITING_REMOTELY = 1986217298, /** * The editing status is not known. */ EDITING_UNKNOWN = 1986217301, } /** * Options for fitting content in an empty frame. */ declare enum EmptyFrameFittingOptions { /** * Resizes content to fit the frame. Note: Content that has different * proportions than the frame appears stretched or squeezed. */ CONTENT_TO_FRAME = 1668575078, /** * Resizes content to fill the frame while perserving the content's * proportions. If the content and frame have different proportions, some of * the content is obscured by the frame. */ FILL_PROPORTIONALLY = 1718185072, /** * Does not use a fitting option. */ NONE = 1852796517, /** * Resizes content to fit the frame while preserving content proportions. If * the content and frame have different proportions, some empty space appears * in the frame. */ PROPORTIONALLY = 1668247152, } /** * A bordered panel that contains an enabling checkbox. A user makes the * enabling group active or inactive by clicking the checkbox. An enabling * group can contain any type and number of controls. */ declare class EnablingGroup extends Widget { /** * A collection of angle comboboxes. */ readonly angleComboboxes: AngleComboboxes; /** * A collection of angle editboxes. */ readonly angleEditboxes: AngleEditboxes; /** * A collection of border panels. */ readonly borderPanels: BorderPanels; /** * A collection of checkbox controls. */ readonly checkboxControls: CheckboxControls; /** * If true, the control is checked by default in the dialog. */ checkedState: boolean; /** * A collection of dialog columns. */ readonly dialogColumns: DialogColumns; /** * A collection of dropdowns. */ readonly dropdowns: Dropdowns; /** * A collection of enabling groups. */ readonly enablingGroups: EnablingGroups; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the EnablingGroup. */ readonly id: number; /** * The index of the EnablingGroup within its containing object. */ readonly index: number; /** * A collection of integer comboboxes. */ readonly integerComboboxes: IntegerComboboxes; /** * A collection of integer editboxes. */ readonly integerEditboxes: IntegerEditboxes; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A collection of measurement comboboxes. */ readonly measurementComboboxes: MeasurementComboboxes; /** * A collection of measurement editboxes. */ readonly measurementEditboxes: MeasurementEditboxes; /** * The width of the control. For an editbox or combobox, specifies the minimum * width of the box. */ minWidth: number; /** * The parent of the EnablingGroup (a DialogColumn, DialogRow, EnablingGroup or * BorderPanel). */ readonly parent: DialogRow | EnablingGroup | BorderPanel | DialogColumn; /** * A collection of percent comboboxes. */ readonly percentComboboxes: PercentComboboxes; /** * A collection of percent editboxes. */ readonly percentEditboxes: PercentEditboxes; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of radiobutton groups. */ readonly radiobuttonGroups: RadiobuttonGroups; /** * A collection of real number comboboxes. */ readonly realComboboxes: RealComboboxes; /** * A collection of real number editboxes. */ readonly realEditboxes: RealEditboxes; /** * Text that appears in the EnablingGroup. */ staticLabel: string; /** * A collection of static text objects. */ readonly staticTexts: StaticTexts; /** * A collection of text editboxes. */ readonly textEditboxes: TextEditboxes; /** * A collection of widgets. */ readonly widgets: Widgets; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): EnablingGroup[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the EnablingGroup. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of enabling groups. */ declare class EnablingGroups { /** Returns the EnablingGroup with the specified index or name. */ [index: number]: EnablingGroup; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new EnablingGroup. * @param withProperties Initial values for properties of the new EnablingGroup (Optional) */ add(withProperties?: Object): EnablingGroup; /** * Returns any EnablingGroup in the collection. */ anyItem(): EnablingGroup; /** * Displays the number of elements in the EnablingGroup. */ count(): number; /** * Returns every EnablingGroup in the collection. */ everyItem(): EnablingGroup; /** * Returns the first EnablingGroup in the collection. */ firstItem(): EnablingGroup; /** * Returns the EnablingGroup with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): EnablingGroup; /** * Returns the EnablingGroup with the specified ID. * @param id The ID. */ itemByID(id: number): EnablingGroup; /** * Returns the EnablingGroups within the specified range. * @param from The EnablingGroup, index, or name at the beginning of the range. Can accept: EnablingGroup, Long Integer or String. * @param to The EnablingGroup, index, or name at the end of the range. Can accept: EnablingGroup, Long Integer or String. */ itemByRange(from: EnablingGroup | number | string, to: EnablingGroup | number | string): EnablingGroup[]; /** * Returns the last EnablingGroup in the collection. */ lastItem(): EnablingGroup; /** * Returns the middle EnablingGroup in the collection. */ middleItem(): EnablingGroup; /** * Returns the EnablingGroup whose index follows the specified EnablingGroup in * the collection. * @param obj The EnablingGroup whose index comes before the desired EnablingGroup. */ nextItem(obj: EnablingGroup): EnablingGroup; /** * Returns the EnablingGroup with the index previous to the specified index. * @param obj The index of the EnablingGroup that follows the desired EnablingGroup. */ previousItem(obj: EnablingGroup): EnablingGroup; /** * Generates a string which, if executed, will return the EnablingGroup. */ toSource(): string; } /** * End cap types. */ declare enum EndCap { /** * A squared end that stops at the path's endpoint. */ BUTT_END_CAP = 1650680176, /** * A squared end that extends beyond the endpoint by half the stroke-width. */ PROJECTING_END_CAP = 1886020464, /** * A semicircular end that extends beyond the endpoint by half the * stroke-width. */ ROUND_END_CAP = 1919115632, } /** * End join types. */ declare enum EndJoin { /** * Beveled end join. */ BEVEL_END_JOIN = 1651142510, /** * Miter end join. */ MITER_END_JOIN = 1835691886, /** * Rounded end join. */ ROUND_END_JOIN = 1919577966, } /** * An endnote. */ declare class Endnote { /** * A collection of characters. */ readonly characters: Characters; /** * The endnote range object. */ endnoteTextRange: EndnoteRange; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the Endnote. */ readonly id: number; /** * The index of the Endnote within its containing object. */ readonly index: number; /** * A collection of insertion points. */ readonly insertionPoints: InsertionPoints; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * A collection of lines. */ readonly lines: Lines; /** * The name of the Endnote; this is an alias to the Endnote's label property. */ name: string; /** * The parent of the Endnote (a InsertionPoint, Story, XmlStory, Cell or * Table). */ readonly parent: Cell | Story | XmlStory | InsertionPoint | Table; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The location of the endnote marker in the parent story */ readonly storyOffset: InsertionPoint; /** * A collection of text columns. */ readonly textColumns: TextColumns; /** * A collection of text style ranges. */ readonly textStyleRanges: TextStyleRanges; /** * A collection of text objects. */ readonly texts: Texts; /** * A collection of words. */ readonly words: Words; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Deletes the endnote reference and the associated endnote text range. */ deleteEndnote(): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Endnote[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Insert the text in endnote text range at specified text index. Insertion * position should lie within the start and end range indices excluding the * markers * @param storyOffset The location within the story, specified as an insertion point. * @param contents The content to insert. */ insertTextInEndnote(storyOffset: InsertionPoint, contents: string): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Endnote. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for frame creation of endnotes. */ declare enum EndnoteFrameCreate { /** * Endnotes are loaded in placegun to be placed anywhere in document. */ LOAD_ENDNOTE_PLACE_GUN = 1162768487, /** * Endnotes created on a new page and frame which are automatically created. */ NEW_PAGE = 1162767984, } /** * Options for specifying default endnote formatting. */ declare class EndnoteOption extends Preference { /** * The position of endnote reference numbers in the main text. Can return: * FootnoteMarkerPositioning enumerator or String. */ endnoteMarkerPositioning: FootnoteMarkerPositioning | string; /** * The character style to apply to endnote reference numbers in the main text. */ endnoteMarkerStyle: CharacterStyle; /** * The endnote numbering style. Can return: FootnoteNumberingStyle enumerator * or String. */ endnoteNumberingStyle: FootnoteNumberingStyle | string; /** * The prefix text of the endnote. (Limit: 0 to 100 characters) */ endnotePrefix: string; /** * The text to insert between the endnote marker number and the endnote text. * (Range: 0 to 100 characters) * @remarks Range: 0 to 100 */ endnoteSeparatorText: string; /** * The suffix text of the endnote. (Limit: 0 to 100 characters) */ endnoteSuffix: string; /** * The paragraph style to apply to endnote text. */ endnoteTextStyle: ParagraphStyle; /** * Title of the endnotes. (Limit: 0 to 100 characters) */ endnoteTitle: string; /** * The paragraph style to apply to endnote title. */ endnoteTitleStyle: ParagraphStyle; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Frame creation of the endnotes. Can return: EndnoteFrameCreate enumerator or * String. */ frameCreateOption: EndnoteFrameCreate | string; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the EndnoteOption (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The point at which to restart endnote numbering. Can return: * EndnoteRestarting enumerator or String. */ restartEndnoteNumbering: EndnoteRestarting | string; /** * Scope value of the endnotes. Can return: EndnoteScope enumerator or String. */ scopeValue: EndnoteScope | string; /** * The position of the endnote prefix and/or suffix. Can return: * FootnotePrefixSuffix enumerator or String. */ showEndnotePrefixSuffix: FootnotePrefixSuffix | string; /** * The number at which to start endnote numbering. * @remarks Range: 1 to 100000 */ startEndnoteNumberAt: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): EndnoteOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the EndnoteOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * An endnote text range. */ declare class EndnoteRange { /** * EndnoteRange Contents, It will skip the endnote number while * setting/replacing the content into endnote range. Can return: String, * SpecialCharacters enumerator or Array of Strings or SpecialCharacters * enumerators. Can also accept: NothingEnum enumerator or Array of Strings, * SpecialCharacters enumerators or NothingEnum enumerators. */ endnoteRangeContent: (NothingEnum | SpecialCharacters | string | string[] | NothingEnum[])[]; /** * Ending Index of the endnote range object. */ readonly endnoteRangeEndIndex: number; /** * Starting Index of the endnote range object. */ readonly endnoteRangeStartIndex: number; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the EndnoteRange. */ readonly id: number; /** * The index of the EndnoteRange within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the EndnoteRange; this is an alias to the EndnoteRange's label * property. */ name: string; /** * The parent of the EndnoteRange (a Text, InsertionPoint, TextStyleRange, * Paragraph, TextColumn, Line, Word, Character, Story or XmlStory). */ readonly parent: Character | InsertionPoint | Line | Paragraph | Story | TextColumn | TextStyleRange | Word | Text | XmlStory; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The endnote reference corresponding to the endnote text range. */ sourceEndnote: Endnote; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Deletes the endnote range and the associated endnote anchor. */ deleteEndnoteRange(): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): EndnoteRange[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the EndnoteRange. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of endnote text ranges. */ declare class EndnoteRanges { /** Returns the EndnoteRange with the specified index or name. */ [index: number]: EndnoteRange; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any EndnoteRange in the collection. */ anyItem(): EndnoteRange; /** * Displays the number of elements in the EndnoteRange. */ count(): number; /** * Returns every EndnoteRange in the collection. */ everyItem(): EndnoteRange; /** * Returns the first EndnoteRange in the collection. */ firstItem(): EndnoteRange; /** * Returns the EndnoteRange with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): EndnoteRange; /** * Returns the EndnoteRange with the specified ID. * @param id The ID. */ itemByID(id: number): EndnoteRange; /** * Returns the EndnoteRange with the specified name. * @param name The name. */ itemByName(name: string): EndnoteRange; /** * Returns the EndnoteRanges within the specified range. * @param from The EndnoteRange, index, or name at the beginning of the range. Can accept: EndnoteRange, Long Integer or String. * @param to The EndnoteRange, index, or name at the end of the range. Can accept: EndnoteRange, Long Integer or String. */ itemByRange(from: EndnoteRange | number | string, to: EndnoteRange | number | string): EndnoteRange[]; /** * Returns the last EndnoteRange in the collection. */ lastItem(): EndnoteRange; /** * Returns the middle EndnoteRange in the collection. */ middleItem(): EndnoteRange; /** * Returns the EndnoteRange whose index follows the specified EndnoteRange in * the collection. * @param obj The EndnoteRange whose index comes before the desired EndnoteRange. */ nextItem(obj: EndnoteRange): EndnoteRange; /** * Returns the EndnoteRange with the index previous to the specified index. * @param obj The index of the EndnoteRange that follows the desired EndnoteRange. */ previousItem(obj: EndnoteRange): EndnoteRange; /** * Generates a string which, if executed, will return the EndnoteRange. */ toSource(): string; } /** * Options for restarting endnote numbering. */ declare enum EndnoteRestarting { /** * Does not restart numbering; numbers endnotes sequentially throughout the * document. */ CONTINUOUS = 1164210803, /** * Restarts endnote numbering on each story. */ STORY_RESTART = 1165193843, } /** * Options for scope of endnote placement. */ declare enum EndnoteScope { /** * Endnotes specific to each document. */ ENDNOTE_DOCUMENT_SCOPE = 1162765427, /** * Endnotes specific to each story. */ STORY_SCOPE = 1162769267, } /** * An endnote text frame. */ declare class EndnoteTextFrame extends TextFrame { /** * Indicates whether the EndnoteTextFrame has been flipped independently of its * parent object and, if yes, the direction in which the EndnoteTextFrame was * flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the EndnoteTextFrame relative to its containing * object. */ absoluteHorizontalScale: number; /** * The rotation angle of the EndnoteTextFrame relative to its containing * object. (Range: -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the EndnoteTextFrame relative to its containing object. * (Range: -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the EndnoteTextFrame relative to its containing * object. */ absoluteVerticalScale: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the EndnoteTextFrame. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the EndnoteTextFrame. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * Anchored object settings. */ readonly anchoredObjectSettings: AnchoredObjectSetting; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the EndnoteTextFrame. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the EndnoteTextFrame. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the EndnoteTextFrame. */ readonly associatedXMLElement: XMLItem; /** * Baseline frame grid option settings. */ readonly baselineFrameGridOptions: BaselineFrameGridOption; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * A collection of buttons. */ readonly buttons: Buttons; /** * A collection of characters. */ readonly characters: Characters; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * Transparency settings for the content of the EndnoteTextFrame. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The type of content that a frame can contain. */ contentType: ContentType; /** * The contents of the text frame. Can return: String, TextFrameContents * enumerator or SpecialCharacters enumerator. */ contents: string | TextFrameContents | SpecialCharacters; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the EndnoteTextFrame. */ endJoin: EndJoin; /** * The last text frame in the thread. Can return: TextFrame or TextPath. */ readonly endTextFrame: TextFrame | TextPath; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * EndnoteTextFrame. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the EndnoteTextFrame's fill color. (To specify * a tint percent, use a number in the range of 0 to 100; to use the inherited * or overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the EndnoteTextFrame. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * A collection of footnotes. */ readonly footnotes: Footnotes; /** * A collection of form fields. */ readonly formFields: FormFields; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the EndnoteTextFrame excluding the stroke width, in the format * [y1, x1, y2, x2], which give the coordinates of the top-left and * bottom-right corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the EndnoteTextFrame. * (Range: -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the EndnoteTextFrame. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the EndnoteTextFrame, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the * EndnoteTextFrame. (Range: -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the EndnoteTextFrame. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the EndnoteTextFrame, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * Default grid properties. Note: Applies to named, layout, and frame (story) * grids. */ readonly gridData: GridDataInformation; /** * A collection of groups. */ readonly groups: Groups; /** * A collection of hidden text objects. */ readonly hiddenTexts: HiddenTexts; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the EndnoteTextFrame. */ horizontalScale: number; /** * The unique ID of the EndnoteTextFrame. */ readonly id: number; /** * The index of the EndnoteTextFrame within its containing object. */ readonly index: number; /** * A collection of insertion points. */ readonly insertionPoints: InsertionPoints; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the EndnoteTextFrame is on. */ itemLayer: Layer; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * A collection of lines. */ readonly lines: Lines; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * Display performance options for the EndnoteTextFrame. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the EndnoteTextFrame is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * The name of the EndnoteTextFrame. */ name: string; /** * The next text frame in the thread. Can return: TextFrame or TextPath. Can * also accept: NothingEnum enumerator. */ nextTextFrame: NothingEnum | TextFrame | TextPath; /** * If true, the EndnoteTextFrame does not print. */ nonprinting: boolean; /** * A collection of notes. */ readonly notes: Notes; /** * Export options for the object */ readonly objectExportOptions: ObjectExportOption; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the story has overset text. */ readonly overflows: boolean; /** * If true, the EndnoteTextFrame's fill color overprints any underlying * objects. If false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the EndnoteTextFrame's stroke color overprints any underlying * objects. If false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * A collection of paragraphs. */ readonly paragraphs: Paragraphs; /** * The parent of the EndnoteTextFrame (a Spread, MasterSpread, SplineItem, * Polygon, GraphicLine, Rectangle, Oval, Group, State, Cell or FlexObject). */ readonly parent: Cell | GraphicLine | Group | MasterSpread | Oval | Polygon | Rectangle | SplineItem | State | FlexObject | Spread; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * The story that contains the text. */ readonly parentStory: Story; /** * A collection of paths. */ readonly paths: Paths; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * The previous text frame in the thread. Can return: TextFrame or TextPath. * Can also accept: NothingEnum enumerator. */ previousTextFrame: NothingEnum | TextFrame | TextPath; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the EndnoteTextFrame. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the EndnoteTextFrame. (Range: -360 to 360) */ shearAngle: number; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The first text frame in the thread. Can return: TextFrame or TextPath. */ readonly startTextFrame: TextFrame | TextPath; /** * The stroke alignment applied to the EndnoteTextFrame. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the EndnoteTextFrame. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the EndnoteTextFrame. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the EndnoteTextFrame's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of tables. */ readonly tables: Tables; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text columns. */ readonly textColumns: TextColumns; /** * The index of the text frame within the story. */ readonly textFrameIndex: number; /** * Text frame preference settings. */ readonly textFramePreferences: TextFramePreference; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * A collection of text paths. */ readonly textPaths: TextPaths; /** * A collection of text style ranges. */ readonly textStyleRanges: TextStyleRanges; /** * A collection of text variable instances. */ readonly textVariableInstances: TextVariableInstances; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * A collection of text objects. */ readonly texts: Texts; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the EndnoteTextFrame. */ verticalScale: number; /** * If true, the EndnoteTextFrame is visible. */ visible: boolean; /** * The bounds of the EndnoteTextFrame including the stroke width, in the format * [y1, x1, y2, x2], which give the coordinates of the top-left and * bottom-right corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * A collection of words. */ readonly words: Words; /** * Dispatched after a EndnoteTextFrame is placed. This event bubbles. This * event is not cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a EndnoteTextFrame is placed. This event bubbles. This * event is cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Creates a new page item by combining the EndnoteTextFrame with other * objects. Deletes the objects if they do not intersect. * @param with_ The object(s) to add. */ addPath(with_: PageItem[]): PageItem; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the EndnoteTextFrame's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the EndnoteTextFrame that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Brings the EndnoteTextFrame forward one level in its layer. */ bringForward(): void; /** * Brings the EndnoteTextFrame to the front of its layer or in front of a * particular item. * @param reference The reference object to bring the object in front of (must have same parent) (Optional) */ bringToFront(reference?: PageItem): void; /** * Finds glyphs that match the find what value and replaces the glyphs with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGrep(reverseOrder?: boolean): Text[]; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value and replaces the text * with the change character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeTransliterate(reverseOrder?: boolean): Text[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the EndnoteTextFrame. Transformations include * rotation, scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the EndnoteTextFrame to a different shape. * @param given The EndnoteTextFrame's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Convert the text frame contents to raw text */ convertToRawText(): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new EndnoteTextFrame. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new EndnoteTextFrame. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Converts text to outlines. Each line of text becomes a polygon object. When * the converted text is a single letter that has no internal spaces or * detached parts, the polygon contains only a single path. Note: To determine * whether a font allows the creation of outlines, see allow outlines. * @param deleteOriginal If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) */ createOutlines(deleteOriginal?: boolean): PageItem[]; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new EndnoteTextFrame. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new EndnoteTextFrame. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new EndnoteTextFrame. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the EndnoteTextFrame at the specified location or offset. * @param to The location of the new EndnoteTextFrame, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new EndnoteTextFrame from the original EndnoteTextFrame's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Creates a new page item by excluding the overlapping areas of the * EndnoteTextFrame and other objects. * @param with_ The object(s) to exclude. */ excludeOverlapPath(with_: PageItem[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds glyphs that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGrep(reverseOrder?: boolean): Text[]; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findTransliterate(reverseOrder?: boolean): Text[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the EndnoteTextFrame. * @param given The axis around which to flip the EndnoteTextFrame. * @param around The point around which to flip the EndnoteTextFrame. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): EndnoteTextFrame[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Creates a new page item by intersecting the EndnoteTextFrame with other * objects. Returns an error if the objects do not intersect. * @param with_ The object(s) with which to intersect. */ intersectPath(with_: PageItem[]): PageItem; /** * Creates a compound path by combining the path(s) of the EndnoteTextFrame * with the paths of other objects. * @param with_ The other objects whose paths to include in the new compound path. */ makeCompoundPath(with_: PageItem[]): PageItem; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Creates a new page item by reverse subtracting the overlapping areas of the * EndnoteTextFrame and other objects. * @param with_ The object(s) to reverse subtract. */ minusBack(with_: PageItem[]): PageItem; /** * Moves the EndnoteTextFrame to a new location. Note: Either the 'to' or 'by' * parameter is required; if both parameters are defined, only the to value is * used. * @param to The new location of the EndnoteTextFrame,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the EndnoteTextFrame relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Deprecated: Use contentPlace method. Original Description: Create a linked * story and place it into the target page item. * @param parentStory The story to place and link from. * @param showingOptions Whether to display the link options dialog (Optional) */ placeAndLink(parentStory: Story, showingOptions?: boolean): Story; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Recomposes the text in the EndnoteTextFrame. */ recompose(): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Releases a compound path. */ releaseCompoundPath(): PageItem[]; /** * Deletes the EndnoteTextFrame. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the EndnoteTextFrame in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Sends the EndnoteTextFrame back one level in its layer. */ sendBackward(): void; /** * Sends the EndnoteTextFrame to the back of its layer or behind a particular * item (must have same parent). * @param reference The reference object to send the object behind (Optional) */ sendToBack(reference?: PageItem): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new EndnoteTextFrame (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Creates a new page item by subtracting the overlapping areas of the * EndnoteTextFrame and other objects. * @param with_ The object(s) to subtract. */ subtractPath(with_: PageItem[]): PageItem; /** * Generates a string which, if executed, will return the EndnoteTextFrame. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the EndnoteTextFrame using the last transformation performed on * any object. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgain(): string[]; /** * Transforms the EndnoteTextFrame using the last transformation performed on * any EndnoteTextFrame. Transformations include moving, rotating, shearing, * scaling, and flipping. */ transformAgainIndividually(): string[]; /** * Transforms the EndnoteTextFrame using the last sequence of transform * operations performed on any single object or performed at the same time on * any group of objects. Transformations include moving, rotating, shearing, * scaling, and flipping. */ transformSequenceAgain(): string[]; /** * Transforms the EndnoteTextFrame using the last sequence of transformations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * A collection of endnote text frames. */ declare class EndnoteTextFrames { /** Returns the EndnoteTextFrame with the specified index or name. */ [index: number]: EndnoteTextFrame; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new EndnoteTextFrame * @param layer The layer on which to create the EndnoteTextFrame. (Optional) * @param at The location at which to insert the EndnoteTextFrame relative to the reference object or within the container object. (Optional) * @param reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) * @param withProperties Initial values for properties of the new EndnoteTextFrame (Optional) */ add(layer?: Layer, at?: LocationOptions, reference?: Document | Layer | MasterSpread | Page | Spread | PageItem, withProperties?: Object): EndnoteTextFrame; /** * Returns any EndnoteTextFrame in the collection. */ anyItem(): EndnoteTextFrame; /** * Displays the number of elements in the EndnoteTextFrame. */ count(): number; /** * Returns every EndnoteTextFrame in the collection. */ everyItem(): EndnoteTextFrame; /** * Returns the first EndnoteTextFrame in the collection. */ firstItem(): EndnoteTextFrame; /** * Returns the EndnoteTextFrame with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): EndnoteTextFrame; /** * Returns the EndnoteTextFrame with the specified ID. * @param id The ID. */ itemByID(id: number): EndnoteTextFrame; /** * Returns the EndnoteTextFrame with the specified name. * @param name The name. */ itemByName(name: string): EndnoteTextFrame; /** * Returns the EndnoteTextFrames within the specified range. * @param from The EndnoteTextFrame, index, or name at the beginning of the range. Can accept: EndnoteTextFrame, Long Integer or String. * @param to The EndnoteTextFrame, index, or name at the end of the range. Can accept: EndnoteTextFrame, Long Integer or String. */ itemByRange(from: EndnoteTextFrame | number | string, to: EndnoteTextFrame | number | string): EndnoteTextFrame[]; /** * Returns the last EndnoteTextFrame in the collection. */ lastItem(): EndnoteTextFrame; /** * Returns the middle EndnoteTextFrame in the collection. */ middleItem(): EndnoteTextFrame; /** * Returns the EndnoteTextFrame whose index follows the specified * EndnoteTextFrame in the collection. * @param obj The EndnoteTextFrame whose index comes before the desired EndnoteTextFrame. */ nextItem(obj: EndnoteTextFrame): EndnoteTextFrame; /** * Returns the EndnoteTextFrame with the index previous to the specified index. * @param obj The index of the EndnoteTextFrame that follows the desired EndnoteTextFrame. */ previousItem(obj: EndnoteTextFrame): EndnoteTextFrame; /** * Generates a string which, if executed, will return the EndnoteTextFrame. */ toSource(): string; } /** * A collection of endnotes. */ declare class Endnotes { /** Returns the Endnote with the specified index or name. */ [index: number]: Endnote; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Endnote in the collection. */ anyItem(): Endnote; /** * Displays the number of elements in the Endnote. */ count(): number; /** * Returns every Endnote in the collection. */ everyItem(): Endnote; /** * Returns the first Endnote in the collection. */ firstItem(): Endnote; /** * Returns the Endnote with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Endnote; /** * Returns the Endnote with the specified ID. * @param id The ID. */ itemByID(id: number): Endnote; /** * Returns the Endnote with the specified name. * @param name The name. */ itemByName(name: string): Endnote; /** * Returns the Endnotes within the specified range. * @param from The Endnote, index, or name at the beginning of the range. Can accept: Endnote, Long Integer or String. * @param to The Endnote, index, or name at the end of the range. Can accept: Endnote, Long Integer or String. */ itemByRange(from: Endnote | number | string, to: Endnote | number | string): Endnote[]; /** * Returns the last Endnote in the collection. */ lastItem(): Endnote; /** * Returns the middle Endnote in the collection. */ middleItem(): Endnote; /** * Returns the Endnote whose index follows the specified Endnote in the * collection. * @param obj The Endnote whose index comes before the desired Endnote. */ nextItem(obj: Endnote): Endnote; /** * Returns the Endnote with the index previous to the specified index. * @param obj The index of the Endnote that follows the desired Endnote. */ previousItem(obj: Endnote): Endnote; /** * Generates a string which, if executed, will return the Endnote. */ toSource(): string; } /** * ARIA label source type options for EPUB export. */ declare enum EpubAriaLabelSourceType { /** * Automatically derive the aria-label. */ AUTOMATIC_ARIA_LABEL = 1095516533, /** * Use the custom aria-label string. */ CUSTOM_ARIA_LABEL = 1095517045, /** * Do not emit an aria-label. */ NONE_ARIA_LABEL = 1095519855, } /** * EPub export option for cover image. */ declare enum EpubCover { /** * Use external image as cover image. */ EXTERNAL_IMAGE = 1700952169, /** * Rasterize first page as cover image. */ FIRST_PAGE = 1700947536, /** * no cover image. */ NONE = 1852796517, } /** * Choices for spread control for fixed layout EPub. */ declare enum EpubFixedLayoutSpreadControl { /** * No spreads. */ NO_SPREADS = 1702063727, /** * Physical spreads. */ PHYSICAL_SPREADS = 1701865593, /** * Spreads based on document. */ SPREADS_BASED_ON_DOC = 1700949860, /** * Synthetic spreads. */ SYNTHETIC_SPREADS = 1702066542, } /** * Choices for epub navigation style. */ declare enum EpubNavigationStyle { /** * Bookmarks based navigation */ BOOKMARKS_NAVIGATION = 1700949622, /** * File name based navigation */ FILENAME_NAVIGATION = 1701211766, /** * No navigation. */ NO_NAVIGATION = 1701736054, /** * TOC style based navigation */ TOC_STYLE_NAVIGATION = 1702129270, } /** * EPub export option for epub version. */ declare enum EpubVersion { /** * EPUB 2.0.1. */ EPUB2 = 1702257970, /** * EPUB 3.0. */ EPUB3 = 1702257971, } /** * An event. */ declare class Event { /** * If true, the event supports the bubbling phase of propagation. */ readonly bubbles: boolean; /** * If true, the default behavior of the event on its target can be canceled. */ readonly cancelable: boolean; /** * The current propagation target of the event. */ readonly currentTarget: any; /** * If true, the default behavior of the event on its target has been canceled. */ readonly defaultPrevented: boolean; /** * The current propagation phase of the event. */ readonly eventPhase: EventPhases; /** * The name of the event. */ readonly eventType: string; /** * The unique ID of the Event. */ readonly id: number; /** * The index of the Event within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the Event (a Object, UIDBasedObject, CellStyleGroup, * CellStyle, TableStyleGroup, Article, ConditionSet, HiddenText, Condition, * MotionPreset, AssignedStory, Assignment, ObjectStyleGroup, ObjectStyle, * NumberingList, Snippet, Dialog, ColorGroup, Swatch, Color, Tint, Gradient, * MixedInkGroup, MixedInk, Behavior, SubmitFormBehavior, PrintFormBehavior, * ClearFormBehavior, GotoPageBehavior, GotoAnchorBehavior, SoundBehavior, * ViewZoomBehavior, GotoStateBehavior, GotoPreviousStateBehavior, * GotoNextStateBehavior, OpenFileBehavior, AnimationBehavior, * ShowHideFieldsBehavior, MovieBehavior, GotoURLBehavior, * GotoPreviousViewBehavior, GotoNextViewBehavior, GotoPreviousPageBehavior, * GotoNextPageBehavior, GotoLastPageBehavior, GotoFirstPageBehavior, * PreflightProfileRule, PreflightRuleInstance, PreflightProfile, * CrossReferenceFormat, HyperlinkURLDestination, * HyperlinkExternalPageDestination, HyperlinkPageDestination, * HyperlinkTextDestination, ParagraphDestination, HyperlinkTextSource, * CrossReferenceSource, HyperlinkPageItemSource, Bookmark, Hyperlink, * IndexSection, PageReference, CrossReference, Index, TOCStyle, * FlattenerPreset, BookContent, MenuAction, ScriptMenuAction, NamedGrid, * CompositeFontEntry, CompositeFont, CharacterStyleGroup, ParagraphStyleGroup, * TextVariableInstance, Footnote, XMLRuleProcessor, XMLTag, Note, TableStyle, * TextPath, Asset, Link, MathObject, Section, MojikumiTable, KinsokuTable, * Guide, LanguageWithVendors, Language, PageItem, HtmlItem, FlexObject, * FormField, SignatureField, TextBox, RadioButton, ListBox, ComboBox, * CheckBox, MultiStateObject, Button, MediaItem, Sound, Movie, EPSText, * SplineItem, Polygon, GraphicLine, Rectangle, Oval, Graphic, SVG, * ImportedPage, PICT, WMF, PDF, EPS, Image, Group, TextFrame, * EndnoteTextFrame, EndnoteRange, Endnote, Reply, PDFComment, MasterSpread, * TrapPreset, Ink, DocumentPreset, Page, Spread, Layer, CharacterStyle, * ParagraphStyle, Story, XmlStory, IDBasedObject, ArticleChild, ArticleMember, * DialogRow, DialogColumn, Widget, BorderPanel, MeasurementEditbox, * MeasurementCombobox, RealCombobox, AngleEditbox, PercentEditbox, * RealEditbox, PercentCombobox, AngleCombobox, EnablingGroup, IntegerCombobox, * IntegerEditbox, RadiobuttonControl, RadiobuttonGroup, CheckboxControl, * Dropdown, StaticText, TextEditbox, ColorGroupSwatch, BackgroundTask, State, * RuleDataObject, XMLItem, DTD, XMLInstruction, XMLComment, XMLElement, Table, * Cell, IdleTask, StrokeStyle, StripedStrokeStyle, DottedStrokeStyle, * DashedStrokeStyle, GraphicLayer, NonIDBasedObject, TableStyleMapping, * CharStyleMapping, CellStyleMapping, ParaStyleMapping, TimingTarget, * TimingGroup, TimingList, OpacityGradientStop, ObjectStyleExportTagMap, * DataMergeQrcodePlaceholder, DataMergeField, DataMergeImagePlaceholder, * DataMergeTextPlaceholder, Panel, LibraryPanel, PagesPanel, Window, * StoryWindow, LayoutWindow, NavigationPoint, PreflightProcess, PreflightRule, * BuildingBlock, IndexingSortOption, Topic, TOCStyleEntry, MenuElement, * MenuSeparator, MenuItem, Submenu, Menu, StyleExportTagMap, TextVariable, * XMLRuleMatchData, ValidationError, XMLExportMap, XMLImportMap, XMLAttribute, * PrinterPreset, Row, Column, Change, HttpLinkConnectionManagerObject, * RootObject, Document, Application, Book, Library, Preference, * ContentPlacerObject, LinkedPageItemOption, LinkedStoryOption, * Html5ExportPreference, PublishExportPreference, HTMLFXLExportPreference, * EPubExportPreviewAppPreference, EPubFixedLayoutExportPreference, * HTMLExportPreference, EPubExportPreference, ConditionalTextPreference, * TimingSetting, AnimationSetting, TransformAttributeOption, * AlignDistributePreference, TypeContextualUiPreference, GrabberPreference, * FlexLayoutAttributeOption, ObjectStyleContentEffectsCategorySettings, * ObjectStyleFillEffectsCategorySettings, * ObjectStyleStrokeEffectsCategorySettings, * ObjectStyleObjectEffectsCategorySettings, ChapterNumberPreference, * NumberingRestartPolicy, Bullet, DataMerge, DataMergeOption, * DataMergePreference, JPEGExportPreference, TrackChangesPreference, * NotePreference, TransformPreference, ClipboardPreference, GeneralPreference, * WatermarkPreference, ButtonPreference, PNGExportPreference, * PreflightBookOption, PreflightOption, XMLViewPreference, * GpuPerformancePreference, DisplaySetting, DisplayPerformancePreference, * IndexOptions, LinkMetadata, MetadataPreference, ExcelImportPreference, * TaggedTextImportPreference, TaggedTextExportPreference, * WordRTFImportPreference, TextExportPreference, TextImportPreference, * FindChangeContentTransparencySetting, FindChangeFillTransparencySetting, * FindChangeStrokeTransparencySetting, FindChangeTransparencySetting, * GradientFeatherSetting, FindChangeGradientFeatherSetting, * DirectionalFeatherSetting, FindChangeDirectionalFeatherSetting, * ContentTransparencySetting, SatinSetting, FindChangeSatinSetting, * BevelAndEmbossSetting, FindChangeBevelAndEmbossSetting, InnerGlowSetting, * FindChangeInnerGlowSetting, OuterGlowSetting, FindChangeOuterGlowSetting, * InnerShadowSetting, FindChangeInnerShadowSetting, FeatherSetting, * FindChangeFeatherSetting, DropShadowSetting, FindChangeDropShadowSetting, * BlendingSetting, FindChangeBlendingSetting, FillTransparencySetting, * StrokeTransparencySetting, TransparencySetting, TransparencyPreference, * FlattenerPreference, GalleyPreference, GridPrintingPreference, * CjkGridPreference, StoryGridDataInformation, LayoutGridDataInformation, * GridDataInformation, CaptionMetadataVariablePreference, * CustomTextVariablePreference, MatchParagraphStylePreference, * MatchCharacterStylePreference, FileNameVariablePreference, * DateVariablePreference, ChapterNumberVariablePreference, * PageNumberVariablePreference, FootnoteOption, BaselineFrameGridOption, * AnchoredObjectSetting, AnchoredObjectDefault, ExportForWebPreference, * XMLPreference, XMLExportPreference, XMLImportPreference, InCopyExportOption, * LinkingPreference, ChangeColorPreference, FindColorPreference, * FindChangeColorOption, ChangeTransliteratePreference, * ChangeObjectPreference, ChangeGlyphPreference, ChangeGrepPreference, * ChangeTextPreference, FindTransliteratePreference, FindObjectPreference, * FindGlyphPreference, FindGrepPreference, FindTextPreference, * FindChangeTransliterateOption, FindChangeObjectOption, * FindChangeGlyphOption, FindChangeGrepOption, FindChangeTextOption, * ColorSetting, ScriptArg, ScriptPreference, PlaceGun, AdjustLayoutPreference, * StrokeFillProxySetting, ImportedPageAttribute, EPSImportPreference, * SmartGuidePreference, AutoCorrectPreference, SpellPreference, * PolygonPreference, DictionaryPreference, FontLockingPreference, * MojikumiUiPreference, ContourOption, TextWrapPreference, * TextEditingPreference, FrameFittingOption, ObjectExportOption, * PageItemDefault, FontSyncPreference, EndnoteOption, TaggedPDFPreference, * InteractivePDFExportPreference, PDFAttribute, PDFPlacePreference, * PDFExportPreference, IMEPreference, GraphicLayerOption, * ClippingPathSettings, ImageIOPreference, ImagePreference, ToolBox, * EPSExportPreference, PrintBookletPrintPreference, PrintBookletOption, * PrintPreference, ViewPreference, PasteboardPreference, MarginPreference, * GuidePreference, GridPreference, DocumentPreference, TextDefault, * TextPreference, TextFramePreference, StoryPreference, PathPoint, Path, * GradientStop, AutoCorrectTable, UserDictionary, HyphenationException, Font, * TransformationMatrix, PDFExportPreset, NestedStyle, TabStop, Text, * InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, * Character, NestedGrepStyle or NestedLineStyle). */ readonly parent: AdjustLayoutPreference | AlignDistributePreference | AnchoredObjectDefault | AnchoredObjectSetting | AngleCombobox | AngleEditbox | AnimationBehavior | AnimationSetting | Application | Article | ArticleChild | ArticleMember | Asset | AssignedStory | Assignment | AutoCorrectPreference | AutoCorrectTable | BackgroundTask | BaselineFrameGridOption | Behavior | BevelAndEmbossSetting | BlendingSetting | Book | BookContent | Bookmark | BorderPanel | BuildingBlock | Bullet | Button | ButtonPreference | CaptionMetadataVariablePreference | Cell | CellStyle | CellStyleGroup | CellStyleMapping | Change | ChangeColorPreference | ChangeGlyphPreference | ChangeGrepPreference | ChangeObjectPreference | ChangeTextPreference | ChangeTransliteratePreference | ChapterNumberPreference | ChapterNumberVariablePreference | CharStyleMapping | Character | CharacterStyle | CharacterStyleGroup | CheckBox | CheckboxControl | CjkGridPreference | ClearFormBehavior | ClipboardPreference | ClippingPathSettings | Color | ColorGroup | ColorGroupSwatch | ColorSetting | Column | ComboBox | CompositeFont | CompositeFontEntry | Condition | ConditionSet | ConditionalTextPreference | ContentPlacerObject | ContentTransparencySetting | ContourOption | CrossReference | CrossReferenceFormat | CrossReferenceSource | CustomTextVariablePreference | DTD | DashedStrokeStyle | DataMerge | DataMergeField | DataMergeImagePlaceholder | DataMergeOption | DataMergePreference | DataMergeQrcodePlaceholder | DataMergeTextPlaceholder | DateVariablePreference | Dialog | DialogColumn | DialogRow | DictionaryPreference | DirectionalFeatherSetting | DisplayPerformancePreference | DisplaySetting | Document | DocumentPreference | DocumentPreset | DottedStrokeStyle | DropShadowSetting | Dropdown | EPS | EPSExportPreference | EPSImportPreference | EPSText | EPubExportPreference | EPubExportPreviewAppPreference | EPubFixedLayoutExportPreference | EnablingGroup | Endnote | EndnoteOption | EndnoteRange | EndnoteTextFrame | ExcelImportPreference | ExportForWebPreference | FeatherSetting | FileNameVariablePreference | FillTransparencySetting | FindChangeBevelAndEmbossSetting | FindChangeBlendingSetting | FindChangeColorOption | FindChangeContentTransparencySetting | FindChangeDirectionalFeatherSetting | FindChangeDropShadowSetting | FindChangeFeatherSetting | FindChangeFillTransparencySetting | FindChangeGlyphOption | FindChangeGradientFeatherSetting | FindChangeGrepOption | FindChangeInnerGlowSetting | FindChangeInnerShadowSetting | FindChangeObjectOption | FindChangeOuterGlowSetting | FindChangeSatinSetting | FindChangeStrokeTransparencySetting | FindChangeTextOption | FindChangeTransliterateOption | FindChangeTransparencySetting | FindColorPreference | FindGlyphPreference | FindGrepPreference | FindObjectPreference | FindTextPreference | FindTransliteratePreference | FlattenerPreference | FlattenerPreset | FlexLayoutAttributeOption | FlexObject | Font | FontLockingPreference | FontSyncPreference | Footnote | FootnoteOption | FormField | FrameFittingOption | GalleyPreference | GeneralPreference | GotoAnchorBehavior | GotoFirstPageBehavior | GotoLastPageBehavior | GotoNextPageBehavior | GotoNextStateBehavior | GotoNextViewBehavior | GotoPageBehavior | GotoPreviousPageBehavior | GotoPreviousStateBehavior | GotoPreviousViewBehavior | GotoStateBehavior | GotoURLBehavior | GpuPerformancePreference | GrabberPreference | Gradient | GradientFeatherSetting | GradientStop | Graphic | GraphicLayer | GraphicLayerOption | GraphicLine | GridDataInformation | GridPreference | GridPrintingPreference | Group | Guide | GuidePreference | HTMLExportPreference | HTMLFXLExportPreference | HiddenText | Html5ExportPreference | HtmlItem | HttpLinkConnectionManagerObject | Hyperlink | HyperlinkExternalPageDestination | HyperlinkPageDestination | HyperlinkPageItemSource | HyperlinkTextDestination | HyperlinkTextSource | HyperlinkURLDestination | HyphenationException | any | IMEPreference | IdleTask | Image | ImageIOPreference | ImagePreference | ImportedPage | ImportedPageAttribute | InCopyExportOption | Index_ | IndexOptions | IndexSection | IndexingSortOption | Ink | InnerGlowSetting | InnerShadowSetting | InsertionPoint | IntegerCombobox | IntegerEditbox | InteractivePDFExportPreference | JPEGExportPreference | KinsokuTable | Language | LanguageWithVendors | Layer | LayoutGridDataInformation | LayoutWindow | Library | LibraryPanel | Line | Link | LinkMetadata | LinkedPageItemOption | LinkedStoryOption | LinkingPreference | ListBox | MarginPreference | MasterSpread | MatchCharacterStylePreference | MatchParagraphStylePreference | MathObject | MeasurementCombobox | MeasurementEditbox | MediaItem | Menu | MenuAction | MenuElement | MenuItem | MenuSeparator | MetadataPreference | MixedInk | MixedInkGroup | MojikumiTable | MojikumiUiPreference | MotionPreset | Movie | MovieBehavior | MultiStateObject | NamedGrid | NavigationPoint | NestedGrepStyle | NestedStyle | Note | NotePreference | NumberingList | NumberingRestartPolicy | ObjectExportOption | ObjectStyle | ObjectStyleContentEffectsCategorySettings | ObjectStyleExportTagMap | ObjectStyleFillEffectsCategorySettings | ObjectStyleGroup | ObjectStyleObjectEffectsCategorySettings | ObjectStyleStrokeEffectsCategorySettings | OpacityGradientStop | OpenFileBehavior | OuterGlowSetting | Oval | PDF | PDFAttribute | PDFComment | PDFExportPreference | PDFExportPreset | PDFPlacePreference | PICT | PNGExportPreference | Page | PageItem | PageItemDefault | PageNumberVariablePreference | PageReference | PagesPanel | Panel | ParaStyleMapping | Paragraph | ParagraphDestination | ParagraphStyle | ParagraphStyleGroup | PasteboardPreference | Path | PathPoint | PercentCombobox | PercentEditbox | PlaceGun | Polygon | PolygonPreference | Preference | PreflightBookOption | PreflightOption | PreflightProcess | PreflightProfile | PreflightProfileRule | PreflightRule | PreflightRuleInstance | PrintBookletOption | PrintBookletPrintPreference | PrintFormBehavior | PrintPreference | PrinterPreset | PublishExportPreference | RadioButton | RadiobuttonControl | RadiobuttonGroup | RealCombobox | RealEditbox | Rectangle | Reply | Row | RuleDataObject | SVG | SatinSetting | ScriptArg | ScriptMenuAction | ScriptPreference | Section | ShowHideFieldsBehavior | SignatureField | SmartGuidePreference | Snippet | Sound | SoundBehavior | SpellPreference | SplineItem | Spread | State | StaticText | Story | StoryGridDataInformation | StoryPreference | StoryWindow | StripedStrokeStyle | StrokeFillProxySetting | StrokeStyle | StrokeTransparencySetting | StyleExportTagMap | Submenu | SubmitFormBehavior | Swatch | TOCStyle | TOCStyleEntry | TabStop | Table | TableStyle | TableStyleGroup | TableStyleMapping | TaggedPDFPreference | TaggedTextExportPreference | TaggedTextImportPreference | Text | TextBox | TextColumn | TextDefault | TextEditbox | TextEditingPreference | TextExportPreference | TextFrame | TextFramePreference | TextImportPreference | TextPath | TextPreference | TextStyleRange | TextVariable | TextVariableInstance | TextWrapPreference | TimingGroup | TimingList | TimingSetting | TimingTarget | Tint | ToolBox | Topic | TrackChangesPreference | TransformAttributeOption | TransformPreference | TransformationMatrix | TransparencyPreference | TransparencySetting | TrapPreset | TypeContextualUiPreference | UserDictionary | ValidationError | ViewPreference | ViewZoomBehavior | WMF | WatermarkPreference | Widget | Window | Word | WordRTFImportPreference | XMLAttribute | XMLComment | XMLElement | XMLExportMap | XMLExportPreference | XMLImportMap | XMLImportPreference | XMLInstruction | XMLItem | XMLPreference | XMLRuleMatchData | XMLRuleProcessor | XMLTag | XMLViewPreference | XmlStory | NestedLineStyle | Object; /** * If true, propagation of the event beyond the current target has been * stopped. */ readonly propagationStopped: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The target of the event. */ readonly target: any; /** * The time the event was initialized. */ readonly timeStamp: Date; /** * Dispatched after the Event becomes active. This event bubbles. This event is * not cancelable. */ static readonly AFTER_ACTIVATE: string; /** * Dispatched when a Event is closing. Since the close has been committed, it * can no longer be canceled. This event bubbles. This event is not cancelable. */ static readonly AFTER_CLOSE: string; /** * Dispatched after the active context changes. This event bubbles. This event * is not cancelable. */ static readonly AFTER_CONTEXT_CHANGED: string; /** * Dispatched after a Event is deleted. This event bubbles. This event is not * cancelable. */ static readonly AFTER_DELETE: string; /** * Dispatched after a Event is embedded. This event bubbles. This event is not * cancelable. */ static readonly AFTER_EMBED: string; /** * Dispatched after the Event is invoked. This event does not bubble. This * event is not cancelable. */ static readonly AFTER_INVOKE: string; /** * Dispatched after one or more links in the Event have been added, deleted, or * modified. This event bubbles. This event is not cancelable. */ static readonly AFTER_LINKS_CHANGED: string; /** * Dispatched after a Event is relocated from one object to another. This event * bubbles. This event is not cancelable. */ static readonly AFTER_MOVE: string; /** * Dispatched after a Event is created. This event bubbles. This event is not * cancelable. */ static readonly AFTER_NEW: string; /** * Dispatched after a Event is opened. This event bubbles. This event is not * cancelable. */ static readonly AFTER_OPEN: string; /** * Dispatched after a Event is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched when the Event is quitting. Since the quit has been committed, it * can not be canceled. This event bubbles. This event is not cancelable. */ static readonly AFTER_QUIT: string; /** * Dispatched after a script method is invoked. This event bubbles. This event * is not cancelable. */ static readonly AFTER_SCRIPT_METHOD: string; /** * Dispatched after an attribute on the active selection changes. This event * bubbles. This event is not cancelable. */ static readonly AFTER_SELECTION_ATTRIBUTE_CHANGED: string; /** * Dispatched after the active selection changes. This event bubbles. This * event is not cancelable. */ static readonly AFTER_SELECTION_CHANGED: string; /** * Dispatched after a Event is unembedded. This event bubbles. This event is * not cancelable. */ static readonly AFTER_UNEMBED: string; /** * Dispatched after a Event is updated. This event bubbles. This event is not * cancelable. */ static readonly AFTER_UPDATE: string; /** * Dispatched before a Event is closed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_CLOSE: string; /** * Dispatched before the Event becomes inactive. This event bubbles. This event * is not cancelable. */ static readonly BEFORE_DEACTIVATE: string; /** * Dispatched before a Event is deleted. This event bubbles. This event is * cancelable. */ static readonly BEFORE_DELETE: string; /** * Dispatched before the Event is displayed. This event does not bubble. This * event is not cancelable. */ static readonly BEFORE_DISPLAY: string; /** * Dispatched before a Event is embedded. This event bubbles. This event is * cancelable. */ static readonly BEFORE_EMBED: string; /** * Dispatched before the Event is invoked. This event does not bubble. This * event is cancelable. */ static readonly BEFORE_INVOKE: string; /** * Dispatched before a Event is relocated from one object to another. This * event bubbles. This event is cancelable. */ static readonly BEFORE_MOVE: string; /** * Dispatched before a Event is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Dispatched before the Event is quit. Allows the quit to be canceled. This * event bubbles. This event is cancelable. */ static readonly BEFORE_QUIT: string; /** * Dispatched before a script method is invoked. This event bubbles. This event * is not cancelable. */ static readonly BEFORE_SCRIPT_METHOD: string; /** * Dispatched before a Event is unembedded. This event bubbles. This event is * cancelable. */ static readonly BEFORE_UNEMBED: string; /** * Dispatched before a Event is updated. This event bubbles. This event is * cancelable. */ static readonly BEFORE_UPDATE: string; /** * Dispatched after the Event changes. This event bubbles. This event is not * cancelable. */ static readonly HOME_SCREEN_VISIBILITY_CHANGE: string; /** * Dispatched when the Event is invoked. This event does not bubble. This event * is not cancelable. */ static readonly ON_INVOKE: string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Event[]; /** * Cancels the default behavior of the event on its target. */ preventDefault(): void; /** * Stops propagation of the event beyond the current target. */ stopPropagation(): void; /** * Generates a string which, if executed, will return the Event. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * An event listener. */ declare class EventListener { /** * The name of the event. */ readonly eventType: string; /** * The handler to invoke when the event occurs. Can return: File or JavaScript * Function. */ readonly handler: File | Function; /** * The unique ID of the EventListener. */ readonly id: number; /** * The index of the EventListener within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the EventListener; this is an alias to the EventListener's label * property. */ name: string; /** * The parent of the EventListener (a Object, UIDBasedObject, CellStyleGroup, * CellStyle, TableStyleGroup, Article, ConditionSet, HiddenText, Condition, * MotionPreset, AssignedStory, Assignment, ObjectStyleGroup, ObjectStyle, * NumberingList, Snippet, Dialog, ColorGroup, Swatch, Color, Tint, Gradient, * MixedInkGroup, MixedInk, Behavior, SubmitFormBehavior, PrintFormBehavior, * ClearFormBehavior, GotoPageBehavior, GotoAnchorBehavior, SoundBehavior, * ViewZoomBehavior, GotoStateBehavior, GotoPreviousStateBehavior, * GotoNextStateBehavior, OpenFileBehavior, AnimationBehavior, * ShowHideFieldsBehavior, MovieBehavior, GotoURLBehavior, * GotoPreviousViewBehavior, GotoNextViewBehavior, GotoPreviousPageBehavior, * GotoNextPageBehavior, GotoLastPageBehavior, GotoFirstPageBehavior, * PreflightProfileRule, PreflightRuleInstance, PreflightProfile, * CrossReferenceFormat, HyperlinkURLDestination, * HyperlinkExternalPageDestination, HyperlinkPageDestination, * HyperlinkTextDestination, ParagraphDestination, HyperlinkTextSource, * CrossReferenceSource, HyperlinkPageItemSource, Bookmark, Hyperlink, * IndexSection, PageReference, CrossReference, Index, TOCStyle, * FlattenerPreset, BookContent, MenuAction, ScriptMenuAction, NamedGrid, * CompositeFontEntry, CompositeFont, CharacterStyleGroup, ParagraphStyleGroup, * TextVariableInstance, Footnote, XMLRuleProcessor, XMLTag, Note, TableStyle, * TextPath, Asset, Link, MathObject, Section, MojikumiTable, KinsokuTable, * Guide, LanguageWithVendors, Language, PageItem, HtmlItem, FlexObject, * FormField, SignatureField, TextBox, RadioButton, ListBox, ComboBox, * CheckBox, MultiStateObject, Button, MediaItem, Sound, Movie, EPSText, * SplineItem, Polygon, GraphicLine, Rectangle, Oval, Graphic, SVG, * ImportedPage, PICT, WMF, PDF, EPS, Image, Group, TextFrame, * EndnoteTextFrame, EndnoteRange, Endnote, Reply, PDFComment, MasterSpread, * TrapPreset, Ink, DocumentPreset, Page, Spread, Layer, CharacterStyle, * ParagraphStyle, Story, XmlStory, IDBasedObject, ArticleChild, ArticleMember, * DialogRow, DialogColumn, Widget, BorderPanel, MeasurementEditbox, * MeasurementCombobox, RealCombobox, AngleEditbox, PercentEditbox, * RealEditbox, PercentCombobox, AngleCombobox, EnablingGroup, IntegerCombobox, * IntegerEditbox, RadiobuttonControl, RadiobuttonGroup, CheckboxControl, * Dropdown, StaticText, TextEditbox, ColorGroupSwatch, BackgroundTask, State, * RuleDataObject, XMLItem, DTD, XMLInstruction, XMLComment, XMLElement, Table, * Cell, IdleTask, StrokeStyle, StripedStrokeStyle, DottedStrokeStyle, * DashedStrokeStyle, GraphicLayer, NonIDBasedObject, TableStyleMapping, * CharStyleMapping, CellStyleMapping, ParaStyleMapping, TimingTarget, * TimingGroup, TimingList, OpacityGradientStop, ObjectStyleExportTagMap, * DataMergeQrcodePlaceholder, DataMergeField, DataMergeImagePlaceholder, * DataMergeTextPlaceholder, Panel, LibraryPanel, PagesPanel, Window, * StoryWindow, LayoutWindow, NavigationPoint, PreflightProcess, PreflightRule, * BuildingBlock, IndexingSortOption, Topic, TOCStyleEntry, MenuElement, * MenuSeparator, MenuItem, Submenu, Menu, StyleExportTagMap, TextVariable, * XMLRuleMatchData, ValidationError, XMLExportMap, XMLImportMap, XMLAttribute, * PrinterPreset, Row, Column, Change, HttpLinkConnectionManagerObject, * RootObject, Document, Application, Book, Library, Preference, * ContentPlacerObject, LinkedPageItemOption, LinkedStoryOption, * Html5ExportPreference, PublishExportPreference, HTMLFXLExportPreference, * EPubExportPreviewAppPreference, EPubFixedLayoutExportPreference, * HTMLExportPreference, EPubExportPreference, ConditionalTextPreference, * TimingSetting, AnimationSetting, TransformAttributeOption, * AlignDistributePreference, TypeContextualUiPreference, GrabberPreference, * FlexLayoutAttributeOption, ObjectStyleContentEffectsCategorySettings, * ObjectStyleFillEffectsCategorySettings, * ObjectStyleStrokeEffectsCategorySettings, * ObjectStyleObjectEffectsCategorySettings, ChapterNumberPreference, * NumberingRestartPolicy, Bullet, DataMerge, DataMergeOption, * DataMergePreference, JPEGExportPreference, TrackChangesPreference, * NotePreference, TransformPreference, ClipboardPreference, GeneralPreference, * WatermarkPreference, ButtonPreference, PNGExportPreference, * PreflightBookOption, PreflightOption, XMLViewPreference, * GpuPerformancePreference, DisplaySetting, DisplayPerformancePreference, * IndexOptions, LinkMetadata, MetadataPreference, ExcelImportPreference, * TaggedTextImportPreference, TaggedTextExportPreference, * WordRTFImportPreference, TextExportPreference, TextImportPreference, * FindChangeContentTransparencySetting, FindChangeFillTransparencySetting, * FindChangeStrokeTransparencySetting, FindChangeTransparencySetting, * GradientFeatherSetting, FindChangeGradientFeatherSetting, * DirectionalFeatherSetting, FindChangeDirectionalFeatherSetting, * ContentTransparencySetting, SatinSetting, FindChangeSatinSetting, * BevelAndEmbossSetting, FindChangeBevelAndEmbossSetting, InnerGlowSetting, * FindChangeInnerGlowSetting, OuterGlowSetting, FindChangeOuterGlowSetting, * InnerShadowSetting, FindChangeInnerShadowSetting, FeatherSetting, * FindChangeFeatherSetting, DropShadowSetting, FindChangeDropShadowSetting, * BlendingSetting, FindChangeBlendingSetting, FillTransparencySetting, * StrokeTransparencySetting, TransparencySetting, TransparencyPreference, * FlattenerPreference, GalleyPreference, GridPrintingPreference, * CjkGridPreference, StoryGridDataInformation, LayoutGridDataInformation, * GridDataInformation, CaptionMetadataVariablePreference, * CustomTextVariablePreference, MatchParagraphStylePreference, * MatchCharacterStylePreference, FileNameVariablePreference, * DateVariablePreference, ChapterNumberVariablePreference, * PageNumberVariablePreference, FootnoteOption, BaselineFrameGridOption, * AnchoredObjectSetting, AnchoredObjectDefault, ExportForWebPreference, * XMLPreference, XMLExportPreference, XMLImportPreference, InCopyExportOption, * LinkingPreference, ChangeColorPreference, FindColorPreference, * FindChangeColorOption, ChangeTransliteratePreference, * ChangeObjectPreference, ChangeGlyphPreference, ChangeGrepPreference, * ChangeTextPreference, FindTransliteratePreference, FindObjectPreference, * FindGlyphPreference, FindGrepPreference, FindTextPreference, * FindChangeTransliterateOption, FindChangeObjectOption, * FindChangeGlyphOption, FindChangeGrepOption, FindChangeTextOption, * ColorSetting, ScriptArg, ScriptPreference, PlaceGun, AdjustLayoutPreference, * StrokeFillProxySetting, ImportedPageAttribute, EPSImportPreference, * SmartGuidePreference, AutoCorrectPreference, SpellPreference, * PolygonPreference, DictionaryPreference, FontLockingPreference, * MojikumiUiPreference, ContourOption, TextWrapPreference, * TextEditingPreference, FrameFittingOption, ObjectExportOption, * PageItemDefault, FontSyncPreference, EndnoteOption, TaggedPDFPreference, * InteractivePDFExportPreference, PDFAttribute, PDFPlacePreference, * PDFExportPreference, IMEPreference, GraphicLayerOption, * ClippingPathSettings, ImageIOPreference, ImagePreference, ToolBox, * EPSExportPreference, PrintBookletPrintPreference, PrintBookletOption, * PrintPreference, ViewPreference, PasteboardPreference, MarginPreference, * GuidePreference, GridPreference, DocumentPreference, TextDefault, * TextPreference, TextFramePreference, StoryPreference, PathPoint, Path, * GradientStop, AutoCorrectTable, UserDictionary, HyphenationException, Font, * TransformationMatrix, PDFExportPreset, NestedStyle, TabStop, Text, * InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, * Character, NestedGrepStyle or NestedLineStyle). */ readonly parent: AdjustLayoutPreference | AlignDistributePreference | AnchoredObjectDefault | AnchoredObjectSetting | AngleCombobox | AngleEditbox | AnimationBehavior | AnimationSetting | Application | Article | ArticleChild | ArticleMember | Asset | AssignedStory | Assignment | AutoCorrectPreference | AutoCorrectTable | BackgroundTask | BaselineFrameGridOption | Behavior | BevelAndEmbossSetting | BlendingSetting | Book | BookContent | Bookmark | BorderPanel | BuildingBlock | Bullet | Button | ButtonPreference | CaptionMetadataVariablePreference | Cell | CellStyle | CellStyleGroup | CellStyleMapping | Change | ChangeColorPreference | ChangeGlyphPreference | ChangeGrepPreference | ChangeObjectPreference | ChangeTextPreference | ChangeTransliteratePreference | ChapterNumberPreference | ChapterNumberVariablePreference | CharStyleMapping | Character | CharacterStyle | CharacterStyleGroup | CheckBox | CheckboxControl | CjkGridPreference | ClearFormBehavior | ClipboardPreference | ClippingPathSettings | Color | ColorGroup | ColorGroupSwatch | ColorSetting | Column | ComboBox | CompositeFont | CompositeFontEntry | Condition | ConditionSet | ConditionalTextPreference | ContentPlacerObject | ContentTransparencySetting | ContourOption | CrossReference | CrossReferenceFormat | CrossReferenceSource | CustomTextVariablePreference | DTD | DashedStrokeStyle | DataMerge | DataMergeField | DataMergeImagePlaceholder | DataMergeOption | DataMergePreference | DataMergeQrcodePlaceholder | DataMergeTextPlaceholder | DateVariablePreference | Dialog | DialogColumn | DialogRow | DictionaryPreference | DirectionalFeatherSetting | DisplayPerformancePreference | DisplaySetting | Document | DocumentPreference | DocumentPreset | DottedStrokeStyle | DropShadowSetting | Dropdown | EPS | EPSExportPreference | EPSImportPreference | EPSText | EPubExportPreference | EPubExportPreviewAppPreference | EPubFixedLayoutExportPreference | EnablingGroup | Endnote | EndnoteOption | EndnoteRange | EndnoteTextFrame | ExcelImportPreference | ExportForWebPreference | FeatherSetting | FileNameVariablePreference | FillTransparencySetting | FindChangeBevelAndEmbossSetting | FindChangeBlendingSetting | FindChangeColorOption | FindChangeContentTransparencySetting | FindChangeDirectionalFeatherSetting | FindChangeDropShadowSetting | FindChangeFeatherSetting | FindChangeFillTransparencySetting | FindChangeGlyphOption | FindChangeGradientFeatherSetting | FindChangeGrepOption | FindChangeInnerGlowSetting | FindChangeInnerShadowSetting | FindChangeObjectOption | FindChangeOuterGlowSetting | FindChangeSatinSetting | FindChangeStrokeTransparencySetting | FindChangeTextOption | FindChangeTransliterateOption | FindChangeTransparencySetting | FindColorPreference | FindGlyphPreference | FindGrepPreference | FindObjectPreference | FindTextPreference | FindTransliteratePreference | FlattenerPreference | FlattenerPreset | FlexLayoutAttributeOption | FlexObject | Font | FontLockingPreference | FontSyncPreference | Footnote | FootnoteOption | FormField | FrameFittingOption | GalleyPreference | GeneralPreference | GotoAnchorBehavior | GotoFirstPageBehavior | GotoLastPageBehavior | GotoNextPageBehavior | GotoNextStateBehavior | GotoNextViewBehavior | GotoPageBehavior | GotoPreviousPageBehavior | GotoPreviousStateBehavior | GotoPreviousViewBehavior | GotoStateBehavior | GotoURLBehavior | GpuPerformancePreference | GrabberPreference | Gradient | GradientFeatherSetting | GradientStop | Graphic | GraphicLayer | GraphicLayerOption | GraphicLine | GridDataInformation | GridPreference | GridPrintingPreference | Group | Guide | GuidePreference | HTMLExportPreference | HTMLFXLExportPreference | HiddenText | Html5ExportPreference | HtmlItem | HttpLinkConnectionManagerObject | Hyperlink | HyperlinkExternalPageDestination | HyperlinkPageDestination | HyperlinkPageItemSource | HyperlinkTextDestination | HyperlinkTextSource | HyperlinkURLDestination | HyphenationException | any | IMEPreference | IdleTask | Image | ImageIOPreference | ImagePreference | ImportedPage | ImportedPageAttribute | InCopyExportOption | Index_ | IndexOptions | IndexSection | IndexingSortOption | Ink | InnerGlowSetting | InnerShadowSetting | InsertionPoint | IntegerCombobox | IntegerEditbox | InteractivePDFExportPreference | JPEGExportPreference | KinsokuTable | Language | LanguageWithVendors | Layer | LayoutGridDataInformation | LayoutWindow | Library | LibraryPanel | Line | Link | LinkMetadata | LinkedPageItemOption | LinkedStoryOption | LinkingPreference | ListBox | MarginPreference | MasterSpread | MatchCharacterStylePreference | MatchParagraphStylePreference | MathObject | MeasurementCombobox | MeasurementEditbox | MediaItem | Menu | MenuAction | MenuElement | MenuItem | MenuSeparator | MetadataPreference | MixedInk | MixedInkGroup | MojikumiTable | MojikumiUiPreference | MotionPreset | Movie | MovieBehavior | MultiStateObject | NamedGrid | NavigationPoint | NestedGrepStyle | NestedStyle | Note | NotePreference | NumberingList | NumberingRestartPolicy | ObjectExportOption | ObjectStyle | ObjectStyleContentEffectsCategorySettings | ObjectStyleExportTagMap | ObjectStyleFillEffectsCategorySettings | ObjectStyleGroup | ObjectStyleObjectEffectsCategorySettings | ObjectStyleStrokeEffectsCategorySettings | OpacityGradientStop | OpenFileBehavior | OuterGlowSetting | Oval | PDF | PDFAttribute | PDFComment | PDFExportPreference | PDFExportPreset | PDFPlacePreference | PICT | PNGExportPreference | Page | PageItem | PageItemDefault | PageNumberVariablePreference | PageReference | PagesPanel | Panel | ParaStyleMapping | Paragraph | ParagraphDestination | ParagraphStyle | ParagraphStyleGroup | PasteboardPreference | Path | PathPoint | PercentCombobox | PercentEditbox | PlaceGun | Polygon | PolygonPreference | Preference | PreflightBookOption | PreflightOption | PreflightProcess | PreflightProfile | PreflightProfileRule | PreflightRule | PreflightRuleInstance | PrintBookletOption | PrintBookletPrintPreference | PrintFormBehavior | PrintPreference | PrinterPreset | PublishExportPreference | RadioButton | RadiobuttonControl | RadiobuttonGroup | RealCombobox | RealEditbox | Rectangle | Reply | Row | RuleDataObject | SVG | SatinSetting | ScriptArg | ScriptMenuAction | ScriptPreference | Section | ShowHideFieldsBehavior | SignatureField | SmartGuidePreference | Snippet | Sound | SoundBehavior | SpellPreference | SplineItem | Spread | State | StaticText | Story | StoryGridDataInformation | StoryPreference | StoryWindow | StripedStrokeStyle | StrokeFillProxySetting | StrokeStyle | StrokeTransparencySetting | StyleExportTagMap | Submenu | SubmitFormBehavior | Swatch | TOCStyle | TOCStyleEntry | TabStop | Table | TableStyle | TableStyleGroup | TableStyleMapping | TaggedPDFPreference | TaggedTextExportPreference | TaggedTextImportPreference | Text | TextBox | TextColumn | TextDefault | TextEditbox | TextEditingPreference | TextExportPreference | TextFrame | TextFramePreference | TextImportPreference | TextPath | TextPreference | TextStyleRange | TextVariable | TextVariableInstance | TextWrapPreference | TimingGroup | TimingList | TimingSetting | TimingTarget | Tint | ToolBox | Topic | TrackChangesPreference | TransformAttributeOption | TransformPreference | TransformationMatrix | TransparencyPreference | TransparencySetting | TrapPreset | TypeContextualUiPreference | UserDictionary | ValidationError | ViewPreference | ViewZoomBehavior | WMF | WatermarkPreference | Widget | Window | Word | WordRTFImportPreference | XMLAttribute | XMLComment | XMLElement | XMLExportMap | XMLExportPreference | XMLImportMap | XMLImportPreference | XMLInstruction | XMLItem | XMLPreference | XMLRuleMatchData | XMLRuleProcessor | XMLTag | XMLViewPreference | XmlStory | NestedLineStyle | Object; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): EventListener[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the EventListener. */ remove(): void; /** * Generates a string which, if executed, will return the EventListener. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of event listeners. */ declare class EventListeners { /** Returns the EventListener with the specified index or name. */ [index: number]: EventListener; /** * The number of objects in the collection. */ readonly length: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) * @param withProperties Initial values for properties of the new EventListener (Optional) */ add(eventType: string, handler: File | Function, captures?: boolean, withProperties?: Object): EventListener; /** * Returns any EventListener in the collection. */ anyItem(): EventListener; /** * Displays the number of elements in the EventListener. */ count(): number; /** * Returns every EventListener in the collection. */ everyItem(): EventListener; /** * Returns the first EventListener in the collection. */ firstItem(): EventListener; /** * Returns the EventListener with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): EventListener; /** * Returns the EventListener with the specified ID. * @param id The ID. */ itemByID(id: number): EventListener; /** * Returns the EventListener with the specified name. * @param name The name. */ itemByName(name: string): EventListener; /** * Returns the EventListeners within the specified range. * @param from The EventListener, index, or name at the beginning of the range. Can accept: EventListener, Long Integer or String. * @param to The EventListener, index, or name at the end of the range. Can accept: EventListener, Long Integer or String. */ itemByRange(from: EventListener | number | string, to: EventListener | number | string): EventListener[]; /** * Returns the last EventListener in the collection. */ lastItem(): EventListener; /** * Returns the middle EventListener in the collection. */ middleItem(): EventListener; /** * Returns the EventListener whose index follows the specified EventListener in * the collection. * @param obj The EventListener whose index comes before the desired EventListener. */ nextItem(obj: EventListener): EventListener; /** * Returns the EventListener with the index previous to the specified index. * @param obj The index of the EventListener that follows the desired EventListener. */ previousItem(obj: EventListener): EventListener; /** * Generates a string which, if executed, will return the EventListener. */ toSource(): string; } /** * Phase options for event propagation. */ declare enum EventPhases { /** * The at-target phase of propagation. */ AT_TARGET = 1701724500, /** * The bubbling phase of propagation. */ BUBBLING_PHASE = 1701724789, /** * The propagation is complete. */ DONE = 1701725252, /** * Not yet propagating. */ NOT_DISPATCHING = 1701727812, } /** * A collection of events. */ declare class Events { /** Returns the Event with the specified index or name. */ [index: number]: Event; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Event in the collection. */ anyItem(): Event; /** * Displays the number of elements in the Event. */ count(): number; /** * Returns every Event in the collection. */ everyItem(): Event; /** * Returns the first Event in the collection. */ firstItem(): Event; /** * Returns the Event with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Event; /** * Returns the Event with the specified ID. * @param id The ID. */ itemByID(id: number): Event; /** * Returns the Events within the specified range. * @param from The Event, index, or name at the beginning of the range. Can accept: Event, Long Integer or String. * @param to The Event, index, or name at the end of the range. Can accept: Event, Long Integer or String. */ itemByRange(from: Event | number | string, to: Event | number | string): Event[]; /** * Returns the last Event in the collection. */ lastItem(): Event; /** * Returns the middle Event in the collection. */ middleItem(): Event; /** * Returns the Event whose index follows the specified Event in the collection. * @param obj The Event whose index comes before the desired Event. */ nextItem(obj: Event): Event; /** * Returns the Event with the index previous to the specified index. * @param obj The index of the Event that follows the desired Event. */ previousItem(obj: Event): Event; /** * Generates a string which, if executed, will return the Event. */ toSource(): string; } /** * Excel import preferences. */ declare class ExcelImportPreference extends Preference { /** * The cell alignment for the imported document. */ alignmentStyle: AlignmentStyleOptions; /** * The number of decimal places to include. Note: Valid only when alignment * style is decimal. */ decimalPlaces: number; /** * The import error code. (Key: 0=Success; 1=Empty Sheet; 2=Invalid sheet; * 3=Invalid range; 4=Invalid View; 5=Misc. Error) */ errorCode: number; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the ExcelImportPreference (a Application). */ readonly parent: Application; /** * If true, preserves inline graphics. */ preserveGraphics: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The range of cells to import. Note: Use a colon (:) to separate the start * and end cell names in the range. */ rangeName: string; /** * The worksheet's index. For information, see sheet name. */ sheetIndex: number; /** * The worksheet to import. */ sheetName: string; /** * If true, shows hidden cells. */ showHiddenCells: boolean; /** * The format for imported spreadsheets. */ tableFormatting: TableFormattingOptions; /** * If true, convert straight quotes and apostrophes in the imported text to * typographic quotation marks and apostrophes. */ useTypographersQuotes: boolean; /** * The stored custom or personal view(s) to import with the file. */ viewName: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ExcelImportPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * ExcelImportPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Export for web preferences. */ declare class ExportForWebPreference extends Preference { /** * If true, copies formatted images to the images subfolder. */ copyFormattedImages: boolean; /** * If true, copies optimized images to the images subfolder. */ copyOptimizedImages: boolean; /** * If true, copies original images to the images subfolder. */ copyOriginalImages: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, generates interlaced GIFs. Note: Not valid when image conversion is * JPEG. */ gifOptionsInterlaced: boolean; /** * The color palette for GIF conversion. Note: Not valid when image conversion * is JPEG. */ gifOptionsPalette: GIFOptionsPalette; /** * The file format to use for converted images. Note: Valid only when copy * optimized images and/or copy formatted images is true. */ imageConversion: ImageConversion; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The formatting method for converted JPEG images. Note: Not valid when image * conversion is GIF. */ jpegOptionsFormat: JPEGOptionsFormat; /** * The quality of converted JPEG images. Note: Not valid when image conversion * is GIF. */ jpegOptionsQuality: JPEGOptionsQuality; /** * The parent of the ExportForWebPreference (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ExportForWebPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * ExportForWebPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Export format options. */ declare enum ExportFormat { /** * Exports to EPS format. */ EPS_TYPE = 1952400720, /** * Exports to EPub format. */ EPUB = 1701868898, /** * Exports to fixed layout EPub format. */ FIXED_LAYOUT_EPUB = 1701865080, /** * Exports to XHTML format. */ HTML = 1213484364, /** * Exports to HTML5 format. */ HTML5 = 1752460646, /** * Exports to XHTML FXL format. */ HTMLFXL = 1213490808, /** * Exports to InCopy markup (ICML) format. */ INCOPY_MARKUP = 1768123756, /** * Exports to InDesign markup (IDML) format. */ INDESIGN_MARKUP = 1768189292, /** * Exports to InDesign snippet (IDMS) format. */ INDESIGN_SNIPPET = 1936617588, /** * Exports to Interactive PDF format. */ INTERACTIVE_PDF = 1952409936, /** * Exports to JPEG format. */ JPG = 1246775072, /** * Exports to PDF format. */ PDF_TYPE = 1952403524, /** * Exports to PNG format. */ PNG_FORMAT = 1699761735, /** * Exports to rich text format (RTF). */ RTF = 1381254688, /** * Exports to a tagged text file with a TXT extension. */ TAGGED_TEXT = 1416066168, /** * Exports to text (TXT) format. */ TEXT_TYPE = 1952412773, /** * Exports the document's tagged content to XML. */ XML = 1481460768, } /** * Export layer options. */ declare enum ExportLayerOptions { /** * Export all layers */ EXPORT_ALL_LAYERS = 1702388076, /** * Export visible layers */ EXPORT_VISIBLE_LAYERS = 1702393452, /** * Export visible and printable layers */ EXPORT_VISIBLE_PRINTABLE_LAYERS = 1702260844, } /** * Choices for export order of epub and html. */ declare enum ExportOrder { /** * based on article defined in article panel. */ ARTICLE_PANEL_ORDER = 1700946288, /** * based on document layout. */ LAYOUT_ORDER = 1700949113, /** * based on XML structure. */ XML_STRUCTURE_ORDER = 1700952179, } /** * The type of preset to import or export. */ declare enum ExportPresetFormat { /** * Document presets. */ DOCUMENT_PRESETS_FORMAT = 1683190892, /** * Flattener presets. */ FLATTENER_PRESETS_FORMAT = 1951626348, /** * PDF export presets. */ PDF_EXPORT_PRESETS_FORMAT = 1716745324, /** * Printer presets. */ PRINTER_PRESETS_FORMAT = 1918071916, } /** * Page export options. */ declare enum ExportRangeOrAllPages { /** * Exports all pages. */ EXPORT_ALL = 1785742657, /** * Exports the page range specified in the page string property. */ EXPORT_RANGE = 1785742674, } /** * Corner type options. */ declare enum FeatherCornerType { /** * The edges of the object fade from opaque to transparent. */ DIFFUSION = 2020623203, /** * The corners are rounded by the feather radius. */ ROUNDED = 2020623202, /** * The gradient exactly follows the outer edge of the object, including sharp * corners. */ SHARP = 2020623201, } /** * On/off options for feathering. */ declare enum FeatherMode { /** * Does not use feathering. */ NONE = 1852796517, /** * Uses standard feathering. */ STANDARD = 2020623970, } /** * Feather effect settings. */ declare class FeatherSetting extends Preference { /** * The amount to choke the feather (as a percentage of the feather width). * (Range: 0 to 100) * @remarks Range: 0 to 100 */ chokeAmount: number; /** * The corner effect applied to the feather. */ cornerType: FeatherCornerType; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The feather mode. */ mode: FeatherMode; /** * The amount (as a percentage) of noise applied to the feather. (Range: 0 to * 100) * @remarks Range: 0 to 100 */ noise: number; /** * The parent of the FeatherSetting (a TransparencySetting, * StrokeTransparencySetting, FillTransparencySetting or * ContentTransparencySetting). */ readonly parent: FillTransparencySetting | StrokeTransparencySetting | ContentTransparencySetting | TransparencySetting; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The feather width. (Range depends on the unit type. For points: 0 to 1000; * for picas: 0 to 83p4; for inches: 0 to 13.8889; for mm: 0 to 352.778; for * cm: 0 to 35.277; for ciceros: 0 to 78c2.389.) * @remarks Measurement unit — also accepts a string such as "12mm". */ width: number | string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FeatherSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the FeatherSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for specifying a feature set. */ declare enum FeatureSetOptions { /** * Uses the Japanese feature set and defaults. */ JAPANESE = 1247899758, /** * Uses the R2L feature set */ RIGHTTOLEFT = 1381265228, /** * Uses the Roman feature set and defaults. */ ROMAN = 1383034222, } /** * Represents a file in the local file system in a platform-independent manner. */ declare class File { /** * The full path name for the referenced file in URI notation. */ readonly absoluteURI: string; /** * If true, the object refers to a file system alias or shortcut. */ readonly alias: boolean; /** * The creation date of the referenced file, or null if the object does not * refer to a file on disk. */ readonly created: Date; /** * In Mac OS, the file creator as a four-character string. In Windows or UNIX, * value is "????". */ readonly creator: string; /** * The localized name of the referenced file, without the path specification. */ readonly displayName: string; /** * Gets or sets the encoding for subsequent read/write operations. */ encoding: string; /** * When true, a read attempt caused the current position to be at the end of * the file, or the file is not open. */ readonly eof: boolean; /** * A string containing a message describing the most recent file system error. */ error: string; /** * If true, this object refers to a file or file-system alias that actually * exists in the file system. */ readonly exists: boolean; /** * The name of the file system. */ static readonly fs: string; /** * The platform-specific full path name for the referenced file. */ readonly fsName: string; /** * The full path name for the referenced file in URI notation. */ readonly fullName: string; /** * When true, the file is not shown in the platform-specific file browser. */ hidden: boolean; /** * The size of the file in bytes. */ length: number; /** * How line feed characters are written in the file system. */ lineFeed: string; /** * The date of the referenced file's last modification, or null if the object * does not refer to a file on the disk. */ readonly modified: Date; /** * The file name portion of the absolute URI for the referenced file, without * the path specification. */ readonly name: string; /** * The Folder object for the folder that contains this file. */ readonly parent: Folder; /** * The path portion of the absolute URI for the referenced file, without the * file name. */ readonly path: string; /** * When true, prevents the file from being altered or deleted. */ readonly: boolean; /** * The path name for the object in URI notation, relative to the current * folder. */ readonly relativeURI: string; /** * The file type as a four-character string. */ readonly type: string; /** * Creates and returns a new File object referring to a given file system * location. * @param path The full or partial path name of the file, in platform-specific or URI format. */ constructor(path?: string); /** * Changes the path specification of the referenced file. * @param path A string containing the new path, absolute or relative to the current folder. */ changePath(path: string): boolean; /** * Closes this open file. */ close(): boolean; /** * Copies this object’s referenced file to the specified target location. * @param target A string with the URI path to the target location, or a File object that references the target location. */ copy(target: string | File): boolean; /** * Makes this file a file-system alias or shortcut to the specified file. * @param path A string containing the path of the target file. */ createAlias(path: string): void; /** * Decodes a UTF-8 encoded string as required by RFC 2396, and returns the * decoded string. * @param uri The UTF-8 encoded string to decode. */ decode(uri: string): string; /** * Encodes a string as required by RFC 2396, and returns the encoded string. * @param name The string to encode. */ encode(name: string): string; /** * Executes or opens this file using the appropriate application, as if it had * been double-clicked in a file browser. */ execute(): boolean; /** * Retrieves and returns the path for this file, relative to the specified base * path, in URI notation. * @param basePath A base path in URI notation. */ getRelativeURI(basePath: string): string; /** * Reports whether a given encoding is available. * @param name The encoding name. */ isEncodingAvailable(name: string): boolean; /** * Opens the referenced file for subsequent read/write operations. The method * resolves any aliases to find the file. * @param mode The read-write mode, a single-character string. * @param type In Mac OS, the type of a newly created file, a 4-character string. Ignored in Windows and UNIX. * @param creator In Mac OS, the creator of a newly created file, a 4-character string. Ignored in Windows and UNIX. */ open(mode: string, type?: string, creator?: string): boolean; /** * Opens a dialog so the user can select one or more files to open. * @param prompt The prompt text, displayed if the dialog allows a prompt. * @param filter A filter that limits the types of files displayed in the dialog. * @param multiSelect When true, the user can select multiple files and the return value is an array. */ openDialog(prompt: string, filter?: any, multiSelect?: boolean): File; /** * Opens the built-in platform-specific file-browsing dialog, in which the user * can select an existing file or files, and creates new File objects to * represent the selected files. * @param prompt A string containing the prompt text, if the dialog allows a prompt. * @param filter A filter that limits the types of files displayed in the dialog. * @param multiSelect When true, the user can select multiple files and the return value is an array. */ openDlg(prompt: string, filter?: any, multiSelect?: boolean): File; /** * Reads the contents of the file, starting at the current position. * @param chars An integer specifying the number of characters to read. */ read(chars?: number): string; /** * Reads a single text character from the file at the current position. */ readch(): string; /** * Reads a single line of text from the file at the current position. */ readln(): string; /** * Deletes the file associated with this object from disk immediately, without * moving it to the system trash. */ remove(): boolean; /** * Renames the associated file. * @param newName The new file name, with no path information. */ rename(newName: string): boolean; /** * Attempts to resolve the file-system alias or shortcut that this object * refers to. */ resolve(): File; /** * Opens a dialog so the user can select a file name to save to. * @param prompt The prompt text, displayed if the dialog allows a prompt. * @param filter In Windows only, a filter that limits the types of files displayed in the dialog. */ saveDialog(prompt: string, filter?: any): File; /** * Opens the built-in platform-specific file-browsing dialog, in which the user * can select an existing file location to which to save information, and * creates a new File object to represent the selected file. * @param prompt A string containing the prompt text, if the dialog allows a prompt. * @param filter In Windows only, a filter that limits the types of files displayed in the dialog. */ saveDlg(prompt: string, filter?: any): File; /** * Seeks to a given position in the file. * @param pos The new current position in the file as an offset in bytes from the start, current position, or end, depending on the mode. * @param mode The seek mode. */ seek(pos: number, mode?: number): boolean; /** * Retrieves the current position as a byte offset from the start of the file. */ tell(): number; /** * Creates and returns a serialized string representation of this object. */ toSource(): string; /** * Converts this object to a string. */ toString(): string; /** * Writes the specified text to the file at the current position. * @param text A text string to be written. */ write(text: string): boolean; /** * Writes a string to the file at the current position and appends a line-feed * sequence. * @param text A text string to be written. */ writeln(text: string): boolean; } /** * The preferences for a file name variable. */ declare class FileNameVariablePreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, includes the file extension. */ includeExtension: boolean; /** * If true, includes the entire path of the file. */ includePath: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the FileNameVariablePreference (a TextVariable). */ readonly parent: TextVariable; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The text that follows the value of the variable. (Limit: 128 characters) */ textAfter: string; /** * The text that precedes the value of the variable. (Limit: 128 characters) */ textBefore: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FileNameVariablePreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * FileNameVariablePreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Transparency settings for the fill applied to the parent object. */ declare class FillTransparencySetting extends Preference { /** * Settings related to the bevel and emboss effect. */ readonly bevelAndEmbossSettings: BevelAndEmbossSetting; /** * Blending mode settings. */ readonly blendingSettings: BlendingSetting; /** * Settings related to the directional feather effect. */ readonly directionalFeatherSettings: DirectionalFeatherSetting; /** * Settings related to the drop shadow effect. */ readonly dropShadowSettings: DropShadowSetting; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Settings related to the feather effect. */ readonly featherSettings: FeatherSetting; /** * Settings related to the gradient feather effect. */ readonly gradientFeatherSettings: GradientFeatherSetting; /** * Settings related to the inner glow effect. */ readonly innerGlowSettings: InnerGlowSetting; /** * Settings related to the inner shadow effect. */ readonly innerShadowSettings: InnerShadowSetting; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * Settings related to the outer glow effect. */ readonly outerGlowSettings: OuterGlowSetting; /** * The parent of the FillTransparencySetting (a PageItem, HtmlItem, FlexObject, * FormField, SignatureField, TextBox, RadioButton, ListBox, ComboBox, * CheckBox, MultiStateObject, Button, MediaItem, Sound, Movie, EPSText, * SplineItem, Polygon, GraphicLine, Rectangle, Oval, Graphic, SVG, * ImportedPage, PICT, WMF, PDF, EPS, Image, Group, TextFrame, * EndnoteTextFrame, PageItemDefault or ObjectStyle). */ readonly parent: Button | CheckBox | ComboBox | EPS | EPSText | EndnoteTextFrame | FlexObject | FormField | Graphic | GraphicLine | Group | HtmlItem | Image | ImportedPage | ListBox | MediaItem | Movie | MultiStateObject | Oval | PDF | PICT | PageItemDefault | Polygon | RadioButton | Rectangle | SVG | SignatureField | Sound | SplineItem | TextBox | TextFrame | WMF | ObjectStyle | PageItem; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Settings related to the satin effect */ readonly satinSettings: SatinSetting; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FillTransparencySetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * FillTransparencySetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Bevel and emboss effect settings. */ declare class FindChangeBevelAndEmbossSetting extends BevelAndEmbossSetting { /** * The altitude of the light source. (Range: 0 to 90). Can return: Real (0 - * 100) or NothingEnum enumerator. * @remarks Range: 0 to 90 */ // @ts-ignore Adobe widens the type inherited from BevelAndEmbossSetting. altitude: number | NothingEnum; /** * The angle of the light source. (Range: -180 to 180). Can return: Real (-180 * - 180) or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from BevelAndEmbossSetting. angle: number | NothingEnum; /** * If true, the bevel or emboss effect is applied. Can return: Boolean or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from BevelAndEmbossSetting. applied: boolean | NothingEnum; /** * The depth of the bevel or emboss (as a percentage). (Range: 0 to 1000). Can * return: Real (0 - 1000) or NothingEnum enumerator. * @remarks Range: 0 to 1000 */ // @ts-ignore Adobe widens the type inherited from BevelAndEmbossSetting. depth: number | NothingEnum; /** * The direction of the bevel or emboss. Can return: BevelAndEmbossDirection * enumerator or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from BevelAndEmbossSetting. direction: BevelAndEmbossDirection | NothingEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The blending mode for the highlight portion of the effect. Can return: * BlendMode enumerator or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from BevelAndEmbossSetting. highlightBlendMode: BlendMode | NothingEnum; /** * The color applied to the highlight portion of the effect, specified as a * swatch (color, gradient, tint, or mixed ink), a color library color, a hex * value, or as an array of color values. The color mode dictates the array * values: for RGB, specify three values, each in the range 0 to 255, in the * format [R,G,B]; for CMYK, specify four values, each as a percentage and each * in the range 0 to 100, in the format [C,M,Y,K]; for LAB, specify three * values in the format [L,A,B], with L in the range 0 to 100 and A and B in * the range -128 to 127; for HSB, specify three colors in the format [H,S,B], * with H in the range 0 to 360 and S and B as percentages in the range 0 to * 100. Can return: Swatch or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from BevelAndEmbossSetting. highlightColor: Swatch | NothingEnum; /** * The opacity of the highlight portion of the effect (as a percentage). * (Range: 0 to 100). Can return: Real (0 - 100) or NothingEnum enumerator. * @remarks Range: 0 to 100 */ // @ts-ignore Adobe widens the type inherited from BevelAndEmbossSetting. highlightOpacity: number | NothingEnum; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the FindChangeBevelAndEmbossSetting (a * FindChangeTransparencySetting, FindChangeStrokeTransparencySetting, * FindChangeFillTransparencySetting or FindChangeContentTransparencySetting). */ // @ts-ignore Adobe widens the type inherited from BevelAndEmbossSetting. readonly parent: FindChangeFillTransparencySetting | FindChangeStrokeTransparencySetting | FindChangeContentTransparencySetting | FindChangeTransparencySetting; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The blending mode for the shadow portion of the effect. Can return: * BlendMode enumerator or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from BevelAndEmbossSetting. shadowBlendMode: BlendMode | NothingEnum; /** * The color applied to the shadow portion of the effect, specified as a swatch * (color, gradient, tint, or mixed ink), a color library color, a hex value, * or as an array of color values. The color mode dictates the array values: * for RGB, specify three values, each in the range 0 to 255, in the format * [R,G,B]; for CMYK, specify four values, each as a percentage and each in the * range 0 to 100, in the format [C,M,Y,K]; for LAB, specify three values in * the format [L,A,B], with L in the range 0 to 100 and A and B in the range * -128 to 127; for HSB, specify three colors in the format [H,S,B], with H in * the range 0 to 360 and S and B as percentages in the range 0 to 100. Can * return: Swatch or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from BevelAndEmbossSetting. shadowColor: Swatch | NothingEnum; /** * The opacity of the shadow portion of the effect (as a percentage). (Range: 0 * to 100). Can return: Real (0 - 100) or NothingEnum enumerator. * @remarks Range: 0 to 100 */ // @ts-ignore Adobe widens the type inherited from BevelAndEmbossSetting. shadowOpacity: number | NothingEnum; /** * The size of the bevel or emboss. Can return: Unit (0 - 1000 points) or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from BevelAndEmbossSetting. size: number | NothingEnum; /** * The amount (in pixels) of softening. Can return: Unit (0 - 144 points) or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from BevelAndEmbossSetting. soften: number | NothingEnum; /** * The style of bevel or emboss. Can return: BevelAndEmbossStyle enumerator or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from BevelAndEmbossSetting. style: BevelAndEmbossStyle | NothingEnum; /** * The edging technique of the bevel or emboss. Can return: * BevelAndEmbossTechnique enumerator or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from BevelAndEmbossSetting. technique: BevelAndEmbossTechnique | NothingEnum; /** * If true, the global light source is used. Can return: Boolean or NothingEnum * enumerator. */ // @ts-ignore Adobe widens the type inherited from BevelAndEmbossSetting. useGlobalLight: boolean | NothingEnum; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ // @ts-ignore Adobe widens the type inherited from BevelAndEmbossSetting. getElements(): FindChangeBevelAndEmbossSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * FindChangeBevelAndEmbossSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Basic object blending settings. */ declare class FindChangeBlendingSetting extends BlendingSetting { /** * The blending mode for controlling how the base color interacts with the * color of the FindChangeBlendingSetting. Can return: BlendMode enumerator or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from BlendingSetting. blendMode: BlendMode | NothingEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * If true, blending is applied only to the group. If false, blending includes * all objects beneath the group. Can return: Boolean or NothingEnum * enumerator. */ // @ts-ignore Adobe widens the type inherited from BlendingSetting. isolateBlending: boolean | NothingEnum; /** * If true, the FindChangeBlendingSetting is a knockout group. Can return: * Boolean or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from BlendingSetting. knockoutGroup: boolean | NothingEnum; /** * The fill opacity of the FindChangeBlendingSetting (as a percentage). (Range: * 0 to 100). Can return: Real (0 - 100) or NothingEnum enumerator. * @remarks Range: 0 to 100 */ // @ts-ignore Adobe widens the type inherited from BlendingSetting. opacity: number | NothingEnum; /** * The parent of the FindChangeBlendingSetting (a * FindChangeTransparencySetting, FindChangeStrokeTransparencySetting, * FindChangeFillTransparencySetting or FindChangeContentTransparencySetting). */ // @ts-ignore Adobe widens the type inherited from BlendingSetting. readonly parent: FindChangeFillTransparencySetting | FindChangeStrokeTransparencySetting | FindChangeContentTransparencySetting | FindChangeTransparencySetting; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ // @ts-ignore Adobe widens the type inherited from BlendingSetting. getElements(): FindChangeBlendingSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * FindChangeBlendingSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Find/change color options. */ declare class FindChangeColorOption extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, includes footnotes in the find/change query. */ includeFootnotes: boolean; /** * If true, includes hidden layers in the find/change query. */ includeHiddenLayers: boolean; /** * If true, includes locked layers in the find query. */ includeLockedLayersForFind: boolean; /** * If true, includes locked stories in the find query. */ includeLockedStoriesForFind: boolean; /** * If true, includes master pages in the find/change query. */ includeMasterPages: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The object type. */ objectType: ObjectTypes; /** * The parent of the FindChangeColorOption (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FindChangeColorOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * FindChangeColorOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Transparency settings for the content of the parent object. */ declare class FindChangeContentTransparencySetting extends Preference { /** * Settings related to the bevel and emboss effect. */ readonly bevelAndEmbossSettings: FindChangeBevelAndEmbossSetting; /** * Blending mode settings. */ readonly blendingSettings: FindChangeBlendingSetting; /** * Settings related to the directional feather effect. */ readonly directionalFeatherSettings: FindChangeDirectionalFeatherSetting; /** * Settings related to the drop shadow effect. */ readonly dropShadowSettings: FindChangeDropShadowSetting; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Settings related to the feather effect. */ readonly featherSettings: FindChangeFeatherSetting; /** * Settings related to the gradient feather effect. */ readonly gradientFeatherSettings: FindChangeGradientFeatherSetting; /** * Settings related to the inner glow effect. */ readonly innerGlowSettings: FindChangeInnerGlowSetting; /** * Settings related to the inner shadow effect. */ readonly innerShadowSettings: FindChangeInnerShadowSetting; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * Settings related to the outer glow effect. */ readonly outerGlowSettings: FindChangeOuterGlowSetting; /** * The parent of the FindChangeContentTransparencySetting (a * FindObjectPreference or ChangeObjectPreference). */ readonly parent: ChangeObjectPreference | FindObjectPreference; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Settings related to the satin effect */ readonly satinSettings: FindChangeSatinSetting; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FindChangeContentTransparencySetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * FindChangeContentTransparencySetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Directional feather effect settings. */ declare class FindChangeDirectionalFeatherSetting extends DirectionalFeatherSetting { /** * The angle of the feather. (Range: 180 to -180). Can return: Real (-180 - * 180) or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from DirectionalFeatherSetting. angle: number | NothingEnum; /** * If true, the directional feather effect is applied. Can return: Boolean or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from DirectionalFeatherSetting. applied: boolean | NothingEnum; /** * The feather width (in pixels) on the bottom side of the object * FindChangeDirectionalFeatherSetting. (Range: .2 to 250). Can return: Unit (0 * - 1000 points) or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from DirectionalFeatherSetting. bottomWidth: number | NothingEnum; /** * The amount to choke the directional feather (as a percentage of the feather * width). (Range: 0 to 100). Can return: Real (0 - 100) or NothingEnum * enumerator. * @remarks Range: 0 to 100 */ // @ts-ignore Adobe widens the type inherited from DirectionalFeatherSetting. chokeAmount: number | NothingEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The shape-following algorithm applied to the feather. Can return: * FollowShapeModeOptions enumerator or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from DirectionalFeatherSetting. followShapeMode: FollowShapeModeOptions | NothingEnum; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The feather width (in pixels) on the left side of the * FindChangeDirectionalFeatherSetting. Can return: Unit (0 - 1000 points) or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from DirectionalFeatherSetting. leftWidth: number | NothingEnum; /** * The amount of noise (as a percentage) applied to the feather region. (Range: * 0 to 100). Can return: Real (0 - 100) or NothingEnum enumerator. * @remarks Range: 0 to 100 */ // @ts-ignore Adobe widens the type inherited from DirectionalFeatherSetting. noise: number | NothingEnum; /** * The parent of the FindChangeDirectionalFeatherSetting (a * FindChangeTransparencySetting, FindChangeStrokeTransparencySetting, * FindChangeFillTransparencySetting or FindChangeContentTransparencySetting). */ // @ts-ignore Adobe widens the type inherited from DirectionalFeatherSetting. readonly parent: FindChangeFillTransparencySetting | FindChangeStrokeTransparencySetting | FindChangeContentTransparencySetting | FindChangeTransparencySetting; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The feather width (in pixels) on the right side of the * FindChangeDirectionalFeatherSetting. (Range: .2 to 250). Can return: Unit (0 * - 1000 points) or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from DirectionalFeatherSetting. rightWidth: number | NothingEnum; /** * The feather width (in pixels) on the top side of the object * FindChangeDirectionalFeatherSetting. (Range: .2 to 250). Can return: Unit (0 * - 1000 points) or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from DirectionalFeatherSetting. topWidth: number | NothingEnum; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ // @ts-ignore Adobe widens the type inherited from DirectionalFeatherSetting. getElements(): FindChangeDirectionalFeatherSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * FindChangeDirectionalFeatherSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Drop shadow settings. */ declare class FindChangeDropShadowSetting extends DropShadowSetting { /** * The angle at which the shadow is thrown. Can return: Real (-180 - 180) or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from DropShadowSetting. angle: number | NothingEnum; /** * The blending mode for the drop shadow effect. Can return: BlendMode * enumerator or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from DropShadowSetting. blendMode: BlendMode | NothingEnum; /** * The distance between the item and its shadow. Can return: Unit (0 - 1000 * points) or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from DropShadowSetting. distance: number | NothingEnum; /** * The color applied to the drop shadow, specified as a swatch (color, * gradient, tint, or mixed ink), or as an array of color values. The color * mode dictates the array values: for RGB, specify three values, each in the * range 0 to 255, in the format [R,G,B]; for CMYK, specify four values, each * as a percentage and each in the range 0 to 100, in the format [C,M,Y,K]; for * LAB, specify three values in the format [L,A,B], with L in the range 0 to * 100 and A and B in the range -128 to 127. Can return: Swatch or NothingEnum * enumerator. */ // @ts-ignore Adobe widens the type inherited from DropShadowSetting. effectColor: Swatch | NothingEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, the drop shadow will take into account other non-shadow effects. * Can return: Boolean or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from DropShadowSetting. honorOtherEffects: boolean | NothingEnum; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * If true, the layer will knock out the drop shadow. Can return: Boolean or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from DropShadowSetting. knockedOut: boolean | NothingEnum; /** * The shadow mode. Can return: ShadowMode enumerator or NothingEnum * enumerator. */ // @ts-ignore Adobe widens the type inherited from DropShadowSetting. mode: ShadowMode | NothingEnum; /** * The amount (as a percentage) of noise applied to the shadow. (Range: 0 to * 100). Can return: Real (0 - 100) or NothingEnum enumerator. * @remarks Range: 0 to 100 */ // @ts-ignore Adobe widens the type inherited from DropShadowSetting. noise: number | NothingEnum; /** * The opacity of the drop shadow (as a percentage). (Range: 0 to 100). Can * return: Real (0 - 100) or NothingEnum enumerator. * @remarks Range: 0 to 100 */ // @ts-ignore Adobe widens the type inherited from DropShadowSetting. opacity: number | NothingEnum; /** * The parent of the FindChangeDropShadowSetting (a * FindChangeTransparencySetting, FindChangeStrokeTransparencySetting, * FindChangeFillTransparencySetting or FindChangeContentTransparencySetting). */ // @ts-ignore Adobe widens the type inherited from DropShadowSetting. readonly parent: FindChangeFillTransparencySetting | FindChangeStrokeTransparencySetting | FindChangeContentTransparencySetting | FindChangeTransparencySetting; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The radius (in pixels) of the blur applied to the drop shadow. (Range * depends on the unit type. For points: 0 to 144; for picas: 0p0 to 12p0; for * inches: 0 to 2; for mm: 0 to 50.08; for cm: 0 to 5.08; for ciceros: 0c0 to * 11c3.128.). Can return: Unit (0 - 1000 points) or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from DropShadowSetting. size: number | NothingEnum; /** * The amount (as a percentage of the blur width) to spread the footprint of * the drop shadow and reduce the radius of the blur. (Range: 0 to 100). Can * return: Real (0 - 100) or NothingEnum enumerator. * @remarks Range: 0 to 100 */ // @ts-ignore Adobe widens the type inherited from DropShadowSetting. spread: number | NothingEnum; /** * If true, uses the global light angle. Can return: Boolean or NothingEnum * enumerator. */ // @ts-ignore Adobe widens the type inherited from DropShadowSetting. useGlobalLight: boolean | NothingEnum; /** * The horizontal offset of the drop shadow. Range depends on the unit type. * For points: -1000 to 1000; for picas: -83p4 to 83p4; for inches: -13.8889 to * 13.8889; for mm: -352.778 to 352.778; for cm: -35.277 to 35.277; for * ciceros: -78c2.389 to 78c2.389. Can return: Unit (-1000 - 1000 points) or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from DropShadowSetting. xOffset: number | NothingEnum; /** * The vertical offset of the drop shadow. (Range depends on the unit type. For * points: -1000 to 1000; for picas: -83p4 to 83p4; for inches: -13.8889 to * 13.8889; for mm: -352.778 to 352.778; for cm: -35.277 to 35.277; for * ciceros: -78c2.389 to 78c2.389). Can return: Unit (-1000 - 1000 points) or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from DropShadowSetting. yOffset: number | NothingEnum; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ // @ts-ignore Adobe widens the type inherited from DropShadowSetting. getElements(): FindChangeDropShadowSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * FindChangeDropShadowSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Feather effect settings. */ declare class FindChangeFeatherSetting extends FeatherSetting { /** * The amount to choke the feather (as a percentage of the feather width). * (Range: 0 to 100). Can return: Real (0 - 100) or NothingEnum enumerator. * @remarks Range: 0 to 100 */ // @ts-ignore Adobe widens the type inherited from FeatherSetting. chokeAmount: number | NothingEnum; /** * The corner effect applied to the feather. Can return: FeatherCornerType * enumerator or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from FeatherSetting. cornerType: FeatherCornerType | NothingEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The feather mode. Can return: FeatherMode enumerator or NothingEnum * enumerator. */ // @ts-ignore Adobe widens the type inherited from FeatherSetting. mode: FeatherMode | NothingEnum; /** * The amount (as a percentage) of noise applied to the feather. (Range: 0 to * 100). Can return: Real (0 - 100) or NothingEnum enumerator. * @remarks Range: 0 to 100 */ // @ts-ignore Adobe widens the type inherited from FeatherSetting. noise: number | NothingEnum; /** * The parent of the FindChangeFeatherSetting (a FindChangeTransparencySetting, * FindChangeStrokeTransparencySetting, FindChangeFillTransparencySetting or * FindChangeContentTransparencySetting). */ // @ts-ignore Adobe widens the type inherited from FeatherSetting. readonly parent: FindChangeFillTransparencySetting | FindChangeStrokeTransparencySetting | FindChangeContentTransparencySetting | FindChangeTransparencySetting; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The feather width. (Range depends on the unit type. For points: 0 to 1000; * for picas: 0 to 83p4; for inches: 0 to 13.8889; for mm: 0 to 352.778; for * cm: 0 to 35.277; for ciceros: 0 to 78c2.389.). Can return: Unit (0 - 1000 * points) or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from FeatherSetting. width: number | NothingEnum; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ // @ts-ignore Adobe widens the type inherited from FeatherSetting. getElements(): FindChangeFeatherSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * FindChangeFeatherSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Transparency settings for the fill applied to the parent object. */ declare class FindChangeFillTransparencySetting extends Preference { /** * Settings related to the bevel and emboss effect. */ readonly bevelAndEmbossSettings: FindChangeBevelAndEmbossSetting; /** * Blending mode settings. */ readonly blendingSettings: FindChangeBlendingSetting; /** * Settings related to the directional feather effect. */ readonly directionalFeatherSettings: FindChangeDirectionalFeatherSetting; /** * Settings related to the drop shadow effect. */ readonly dropShadowSettings: FindChangeDropShadowSetting; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Settings related to the feather effect. */ readonly featherSettings: FindChangeFeatherSetting; /** * Settings related to the gradient feather effect. */ readonly gradientFeatherSettings: FindChangeGradientFeatherSetting; /** * Settings related to the inner glow effect. */ readonly innerGlowSettings: FindChangeInnerGlowSetting; /** * Settings related to the inner shadow effect. */ readonly innerShadowSettings: FindChangeInnerShadowSetting; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * Settings related to the outer glow effect. */ readonly outerGlowSettings: FindChangeOuterGlowSetting; /** * The parent of the FindChangeFillTransparencySetting (a FindObjectPreference * or ChangeObjectPreference). */ readonly parent: ChangeObjectPreference | FindObjectPreference; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Settings related to the satin effect */ readonly satinSettings: FindChangeSatinSetting; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FindChangeFillTransparencySetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * FindChangeFillTransparencySetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Find/change glyph options. */ declare class FindChangeGlyphOption extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, includes footnotes in the find/change query. */ includeFootnotes: boolean; /** * If true, includes hidden layers in the find/change query. */ includeHiddenLayers: boolean; /** * If true, includes locked layers in the find query. */ includeLockedLayersForFind: boolean; /** * If true, includes locked stories in the find query. */ includeLockedStoriesForFind: boolean; /** * If true, includes master pages in the find/change query. */ includeMasterPages: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the FindChangeGlyphOption (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, search in the backward direction. */ searchBackwards: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FindChangeGlyphOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * FindChangeGlyphOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Gradient feather effect settings. */ declare class FindChangeGradientFeatherSetting extends GradientFeatherSetting { /** * The angle of the gradient feather. Can return: Real (-180 - 180) or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from GradientFeatherSetting. angle: number | NothingEnum; /** * If true, the gradient feather effect is applied. Can return: Boolean or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from GradientFeatherSetting. applied: boolean | NothingEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The center point (for a radial gradient) or starting point (for a linear * gradient) applied to the fill, as page coordinates in the format [x, y]. Can * return: Array of 2 Units or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from GradientFeatherSetting. gradientStart: (number[][] | NothingEnum)[]; /** * The hilite angle of the radial gradient feather. Can return: Real or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from GradientFeatherSetting. hiliteAngle: number | NothingEnum; /** * The hilite length of the radial gradient feather. Can return: Unit or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from GradientFeatherSetting. hiliteLength: number | NothingEnum; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The length of the axial gradient, or radius of the radial gradient. Can * return: Unit or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from GradientFeatherSetting. length: number | NothingEnum; /** * A collection of opacity gradient stops. */ readonly opacityGradientStops: OpacityGradientStops; /** * The parent of the FindChangeGradientFeatherSetting (a * FindChangeTransparencySetting, FindChangeStrokeTransparencySetting, * FindChangeFillTransparencySetting or FindChangeContentTransparencySetting). */ // @ts-ignore Adobe widens the type inherited from GradientFeatherSetting. readonly parent: FindChangeFillTransparencySetting | FindChangeStrokeTransparencySetting | FindChangeContentTransparencySetting | FindChangeTransparencySetting; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The type of gradient. Can return: GradientType enumerator or NothingEnum * enumerator. */ // @ts-ignore Adobe widens the type inherited from GradientFeatherSetting. type: GradientType | NothingEnum; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ // @ts-ignore Adobe widens the type inherited from GradientFeatherSetting. getElements(): FindChangeGradientFeatherSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * FindChangeGradientFeatherSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Find/change grep options. */ declare class FindChangeGrepOption extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, includes footnotes in the find/change query. */ includeFootnotes: boolean; /** * If true, includes hidden layers in the find/change query. */ includeHiddenLayers: boolean; /** * If true, includes locked layers in the find query. */ includeLockedLayersForFind: boolean; /** * If true, includes locked stories in the find query. */ includeLockedStoriesForFind: boolean; /** * If true, includes master pages in the find/change query. */ includeMasterPages: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * If true, finds only text that matches the specified kana type. */ kanaSensitive: boolean; /** * The parent of the FindChangeGrepOption (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, search in the backward direction. */ searchBackwards: boolean; /** * If true, finds only text that matches the specified character width. */ widthSensitive: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FindChangeGrepOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the FindChangeGrepOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Inner glow effect settings. */ declare class FindChangeInnerGlowSetting extends InnerGlowSetting { /** * If true, the inner glow effect is applied. Can return: Boolean or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from InnerGlowSetting. applied: boolean | NothingEnum; /** * The blending mode for the inner glow effect. Can return: BlendMode * enumerator or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from InnerGlowSetting. blendMode: BlendMode | NothingEnum; /** * The color applied to the inner glow, specified as a swatch (color, gradient, * tint, or mixed ink), or as an array of color values. The color mode dictates * the array values: for RGB, specify three values, each in the range 0 to 255, * in the format [R,G,B]; for CMYK, specify four values, each as a percentage * and each in the range 0 to 100, in the format [C,M,Y,K]; for LAB, specify * three values in the format [L,A,B], with L in the range 0 to 100 and A and B * in the range -128 to 127. Can return: Swatch or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from InnerGlowSetting. effectColor: Swatch | NothingEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The amount (as a percentage) of noise applied to the inner glow. (Range: 0 * to 100). Can return: Real (0 - 100) or NothingEnum enumerator. * @remarks Range: 0 to 100 */ // @ts-ignore Adobe widens the type inherited from InnerGlowSetting. noise: number | NothingEnum; /** * The opacity of the inner glow (as a percentage). (Range: 0 to 100). Can * return: Real (0 - 100) or NothingEnum enumerator. * @remarks Range: 0 to 100 */ // @ts-ignore Adobe widens the type inherited from InnerGlowSetting. opacity: number | NothingEnum; /** * The parent of the FindChangeInnerGlowSetting (a * FindChangeTransparencySetting, FindChangeStrokeTransparencySetting, * FindChangeFillTransparencySetting or FindChangeContentTransparencySetting). */ // @ts-ignore Adobe widens the type inherited from InnerGlowSetting. readonly parent: FindChangeFillTransparencySetting | FindChangeStrokeTransparencySetting | FindChangeContentTransparencySetting | FindChangeTransparencySetting; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The size of the inner glow. Can return: Unit (0 - 1000 points) or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from InnerGlowSetting. size: number | NothingEnum; /** * The light source of the inner glow effect. Can return: InnerGlowSource * enumerator or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from InnerGlowSetting. source: InnerGlowSource | NothingEnum; /** * The amount of spread (as a percentage of the inner glow size). (Range: 0 to * 100). Can return: Real (0 - 100) or NothingEnum enumerator. * @remarks Range: 0 to 100 */ // @ts-ignore Adobe widens the type inherited from InnerGlowSetting. spread: number | NothingEnum; /** * The technique used for the inner glow. Can return: GlowTechnique enumerator * or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from InnerGlowSetting. technique: GlowTechnique | NothingEnum; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ // @ts-ignore Adobe widens the type inherited from InnerGlowSetting. getElements(): FindChangeInnerGlowSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * FindChangeInnerGlowSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Inner shadow effect settings. */ declare class FindChangeInnerShadowSetting extends InnerShadowSetting { /** * The angle at which the inner shadow is thrown. (Range: -360 to 360). Can * return: Real (-180 - 180) or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from InnerShadowSetting. angle: number | NothingEnum; /** * If true, the inner shadow effect is applied. Can return: Boolean or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from InnerShadowSetting. applied: boolean | NothingEnum; /** * The blending mode for the inner shadow effect. Can return: BlendMode * enumerator or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from InnerShadowSetting. blendMode: BlendMode | NothingEnum; /** * The amount to choke the inner shadow (as a percentage of shadow size). * (Range: 0 to 100). Can return: Real (0 - 100) or NothingEnum enumerator. * @remarks Range: 0 to 100 */ // @ts-ignore Adobe widens the type inherited from InnerShadowSetting. chokeAmount: number | NothingEnum; /** * The distance between the FindChangeInnerShadowSetting and the shadow. . Can * return: Unit (0 - 1000 points) or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from InnerShadowSetting. distance: number | NothingEnum; /** * The color applied to the inner shadow, specified as a swatch (color, * gradient, tint, or mixed ink), or as an array of color values. The color * mode dictates the array values: for RGB, specify three values, each in the * range 0 to 255, in the format [R,G,B]; for CMYK, specify four values, each * as a percentage and each in the range 0 to 100, in the format [C,M,Y,K]; for * LAB, specify three values in the format [L,A,B], with L in the range 0 to * 100 and A and B in the range -128 to 127. . Can return: Swatch or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from InnerShadowSetting. effectColor: Swatch | NothingEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The amount (as a percentage) of noise to add to the shadow. (Range: 0 to * 100). Can return: Real (0 - 100) or NothingEnum enumerator. * @remarks Range: 0 to 100 */ // @ts-ignore Adobe widens the type inherited from InnerShadowSetting. noise: number | NothingEnum; /** * The opacity (as a percentage) of the inner shadow. (Range: 0 to 100). Can * return: Real (0 - 100) or NothingEnum enumerator. * @remarks Range: 0 to 100 */ // @ts-ignore Adobe widens the type inherited from InnerShadowSetting. opacity: number | NothingEnum; /** * The parent of the FindChangeInnerShadowSetting (a * FindChangeTransparencySetting, FindChangeStrokeTransparencySetting, * FindChangeFillTransparencySetting or FindChangeContentTransparencySetting). */ // @ts-ignore Adobe widens the type inherited from InnerShadowSetting. readonly parent: FindChangeFillTransparencySetting | FindChangeStrokeTransparencySetting | FindChangeContentTransparencySetting | FindChangeTransparencySetting; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The size of the inner shadow. Can return: Unit (0 - 1000 points) or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from InnerShadowSetting. size: number | NothingEnum; /** * If true, the global light angle is used. Can return: Boolean or NothingEnum * enumerator. */ // @ts-ignore Adobe widens the type inherited from InnerShadowSetting. useGlobalLight: boolean | NothingEnum; /** * The horizontal offset of the shadow. Can return: Unit (-1000 - 1000 points) * or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from InnerShadowSetting. xOffset: number | NothingEnum; /** * The vertical offset of the shadow. Can return: Unit (-1000 - 1000 points) or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from InnerShadowSetting. yOffset: number | NothingEnum; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ // @ts-ignore Adobe widens the type inherited from InnerShadowSetting. getElements(): FindChangeInnerShadowSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * FindChangeInnerShadowSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Find/change object options. */ declare class FindChangeObjectOption extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, includes footnotes in the find/change query. */ includeFootnotes: boolean; /** * If true, includes hidden layers in the find/change query. */ includeHiddenLayers: boolean; /** * If true, includes locked layers in the find query. */ includeLockedLayersForFind: boolean; /** * If true, includes locked stories in the find query. */ includeLockedStoriesForFind: boolean; /** * If true, includes master pages in the find/change query. */ includeMasterPages: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The object type. */ objectType: ObjectTypes; /** * The parent of the FindChangeObjectOption (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FindChangeObjectOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * FindChangeObjectOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Outer glow effect settings. */ declare class FindChangeOuterGlowSetting extends OuterGlowSetting { /** * If true, the outer glow effect is applied. Can return: Boolean or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from OuterGlowSetting. applied: boolean | NothingEnum; /** * The blending mode for the outer glow effect. Can return: BlendMode * enumerator or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from OuterGlowSetting. blendMode: BlendMode | NothingEnum; /** * The color applied to the outer glow, specified as a swatch (color, gradient, * tint, or mixed ink), or an array of color values. The color mode dictates * the array values: for RGB, specify three values, each in the range 0 to 255, * in the format [R,G,B]; for CMYK, specify four values, each as a percentage * and each in the range 0 to 100, in the format [C,M,Y,K]; for LAB, specify * three values in the format [L,A,B], with L in the range 0 to 100 and A and B * in the range -128 to 127. Can return: Swatch or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from OuterGlowSetting. effectColor: Swatch | NothingEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The amount (as a percentage) of noise applied to the outer glow. (Range: 0 * to 100). Can return: Real (0 - 100) or NothingEnum enumerator. * @remarks Range: 0 to 100 */ // @ts-ignore Adobe widens the type inherited from OuterGlowSetting. noise: number | NothingEnum; /** * The opacity of the outer glow (as a percentage). (Range: 0 to 100). Can * return: Real (0 - 100) or NothingEnum enumerator. * @remarks Range: 0 to 100 */ // @ts-ignore Adobe widens the type inherited from OuterGlowSetting. opacity: number | NothingEnum; /** * The parent of the FindChangeOuterGlowSetting (a * FindChangeTransparencySetting, FindChangeStrokeTransparencySetting, * FindChangeFillTransparencySetting or FindChangeContentTransparencySetting). */ // @ts-ignore Adobe widens the type inherited from OuterGlowSetting. readonly parent: FindChangeFillTransparencySetting | FindChangeStrokeTransparencySetting | FindChangeContentTransparencySetting | FindChangeTransparencySetting; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The size of the outer glow. Can return: Unit (0 - 1000 points) or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from OuterGlowSetting. size: number | NothingEnum; /** * The amount of spread (as a percentage of the outer glow size). (Range: 0 to * 100). Can return: Real (0 - 100) or NothingEnum enumerator. * @remarks Range: 0 to 100 */ // @ts-ignore Adobe widens the type inherited from OuterGlowSetting. spread: number | NothingEnum; /** * The technique applied to the outer glow. Can return: GlowTechnique * enumerator or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from OuterGlowSetting. technique: GlowTechnique | NothingEnum; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ // @ts-ignore Adobe widens the type inherited from OuterGlowSetting. getElements(): FindChangeOuterGlowSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * FindChangeOuterGlowSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Satin effect settings. */ declare class FindChangeSatinSetting extends SatinSetting { /** * The light angle of the satin effect. (Range: -360 to 360). Can return: Real * (-180 - 180) or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from SatinSetting. angle: number | NothingEnum; /** * If true, applies the satin effect. Can return: Boolean or NothingEnum * enumerator. */ // @ts-ignore Adobe widens the type inherited from SatinSetting. applied: boolean | NothingEnum; /** * The blending mode for the satin effect. Can return: BlendMode enumerator or * NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from SatinSetting. blendMode: BlendMode | NothingEnum; /** * The distance (in pixels) from the FindChangeSatinSetting to the satin * effect. Can return: Unit (0 - 1000 points) or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from SatinSetting. distance: number | NothingEnum; /** * The color applied to the satin effect, specified as a swatch (color, * gradient, tint, or mixed ink), a color library color, a hex value, or as an * array of color values. The color mode dictates the array values: for RGB, * specify three values, each in the range 0 to 255, in the format [R,G,B]; for * CMYK, specify four values, each as a percentage and each in the range 0 to * 100, in the format [C,M,Y,K]; for LAB, specify three values in the format * [L,A,B], with L in the range 0 to 100 and A and B in the range -128 to 127; * for HSB, specify three colors in the format [H,S,B], with H in the range 0 * to 360 and S and B as percentages in the range 0 to 100. Can return: Swatch * or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from SatinSetting. effectColor: Swatch | NothingEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, inverts the satin effect. Can return: Boolean or NothingEnum * enumerator. */ // @ts-ignore Adobe widens the type inherited from SatinSetting. invertEffect: boolean | NothingEnum; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The opacity of the satin effect (as a percentage). (Range: 0 to 100). Can * return: Real (0 - 100) or NothingEnum enumerator. * @remarks Range: 0 to 100 */ // @ts-ignore Adobe widens the type inherited from SatinSetting. opacity: number | NothingEnum; /** * The parent of the FindChangeSatinSetting (a FindChangeTransparencySetting, * FindChangeStrokeTransparencySetting, FindChangeFillTransparencySetting or * FindChangeContentTransparencySetting). */ // @ts-ignore Adobe widens the type inherited from SatinSetting. readonly parent: FindChangeFillTransparencySetting | FindChangeStrokeTransparencySetting | FindChangeContentTransparencySetting | FindChangeTransparencySetting; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The width (in pixels) of the satin effect. Can return: Unit (0 - 1000 * points) or NothingEnum enumerator. */ // @ts-ignore Adobe widens the type inherited from SatinSetting. size: number | NothingEnum; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ // @ts-ignore Adobe widens the type inherited from SatinSetting. getElements(): FindChangeSatinSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * FindChangeSatinSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Transparency settings for the stroke of the parent object. */ declare class FindChangeStrokeTransparencySetting extends Preference { /** * Settings related to the bevel and emboss effect. */ readonly bevelAndEmbossSettings: FindChangeBevelAndEmbossSetting; /** * Blending mode settings. */ readonly blendingSettings: FindChangeBlendingSetting; /** * Settings related to the directional feather effect. */ readonly directionalFeatherSettings: FindChangeDirectionalFeatherSetting; /** * Settings related to the drop shadow effect. */ readonly dropShadowSettings: FindChangeDropShadowSetting; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Settings related to the feather effect. */ readonly featherSettings: FindChangeFeatherSetting; /** * Settings related to the gradient feather effect. */ readonly gradientFeatherSettings: FindChangeGradientFeatherSetting; /** * Settings related to the inner glow effect. */ readonly innerGlowSettings: FindChangeInnerGlowSetting; /** * Settings related to the inner shadow effect. */ readonly innerShadowSettings: FindChangeInnerShadowSetting; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * Settings related to the outer glow effect. */ readonly outerGlowSettings: FindChangeOuterGlowSetting; /** * The parent of the FindChangeStrokeTransparencySetting (a * FindObjectPreference or ChangeObjectPreference). */ readonly parent: ChangeObjectPreference | FindObjectPreference; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Settings related to the satin effect */ readonly satinSettings: FindChangeSatinSetting; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FindChangeStrokeTransparencySetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * FindChangeStrokeTransparencySetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Find/change text options. */ declare class FindChangeTextOption extends Preference { /** * If true, finds strings whose use of case matches the find text string. If * false, finds strings that match the find text string regardless of case. */ caseSensitive: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, ignore diacs in the find/change query. */ ignoreDiacritics: boolean; /** * If true, ignore kashidas in the find/change query. */ ignoreKashidas: boolean; /** * If true, includes footnotes in the find/change query. */ includeFootnotes: boolean; /** * If true, includes hidden layers in the find/change query. */ includeHiddenLayers: boolean; /** * If true, includes locked layers in the find query. */ includeLockedLayersForFind: boolean; /** * If true, includes locked stories in the find query. */ includeLockedStoriesForFind: boolean; /** * If true, includes master pages in the find/change query. */ includeMasterPages: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * If true, finds only text that matches the specified kana type. */ kanaSensitive: boolean; /** * The parent of the FindChangeTextOption (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, search in the backward direction. */ searchBackwards: boolean; /** * If true, finds only the complete find text string. If false, also finds * strings that contain the find text string. */ wholeWord: boolean; /** * If true, finds only text that matches the specified character width. */ widthSensitive: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FindChangeTextOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the FindChangeTextOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Find/change transliterate character type options. */ declare enum FindChangeTransliterateCharacterTypes { /** * Arabic Indic(hindi) digits. */ ARABIC_INDIC_DIGITS = 1095328873, /** * Farsi digits. */ FARSI_DIGITS = 1684629089, /** * Full-width hiragana. */ FULL_WIDTH_HIRAGANA = 1179023176, /** * Full-width katakana. */ FULL_WIDTH_KATAKANA = 1179023179, /** * Full-width Roman symbols. */ FULL_WIDTH_ROMAN_SYMBOLS = 1179023186, /** * Half-width katakana. */ HALF_WIDTH_KATAKANA = 1179154251, /** * Half-width Roman symbols. */ HALF_WIDTH_ROMAN_SYMBOLS = 1179154258, /** * Western Arabic digits (0, 1, 2, 3, ...). */ WESTERN_ARABIC_DIGITS = 1463903337, } /** * Find/change transliterate options. */ declare class FindChangeTransliterateOption extends Preference { /** * If true, finds strings whose use of case matches the find text string. If * false, finds strings that match the find text string regardless of case. */ caseSensitive: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, includes footnotes in the find/change query. */ includeFootnotes: boolean; /** * If true, includes hidden layers in the find/change query. */ includeHiddenLayers: boolean; /** * If true, includes locked layers in the find query. */ includeLockedLayersForFind: boolean; /** * If true, includes locked stories in the find query. */ includeLockedStoriesForFind: boolean; /** * If true, includes master pages in the find/change query. */ includeMasterPages: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * If true, finds only text that matches the specified kana type. */ kanaSensitive: boolean; /** * The parent of the FindChangeTransliterateOption (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, search in the backward direction. */ searchBackwards: boolean; /** * If true, finds only the complete find text string. If false, also finds * strings that contain the find text string. */ wholeWord: boolean; /** * If true, finds only text that matches the specified character width. */ widthSensitive: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FindChangeTransliterateOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * FindChangeTransliterateOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Transparency settings. */ declare class FindChangeTransparencySetting extends Preference { /** * Settings related to the bevel and emboss effect. */ readonly bevelAndEmbossSettings: FindChangeBevelAndEmbossSetting; /** * Blending mode settings. */ readonly blendingSettings: FindChangeBlendingSetting; /** * Settings related to the directional feather effect. */ readonly directionalFeatherSettings: FindChangeDirectionalFeatherSetting; /** * Settings related to the drop shadow effect. */ readonly dropShadowSettings: FindChangeDropShadowSetting; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Settings related to the feather effect. */ readonly featherSettings: FindChangeFeatherSetting; /** * Settings related to the gradient feather effect. */ readonly gradientFeatherSettings: FindChangeGradientFeatherSetting; /** * Settings related to the inner glow effect. */ readonly innerGlowSettings: FindChangeInnerGlowSetting; /** * Settings related to the inner shadow effect. */ readonly innerShadowSettings: FindChangeInnerShadowSetting; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * Settings related to the outer glow effect. */ readonly outerGlowSettings: FindChangeOuterGlowSetting; /** * The parent of the FindChangeTransparencySetting (a FindObjectPreference or * ChangeObjectPreference). */ readonly parent: ChangeObjectPreference | FindObjectPreference; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Settings related to the satin effect */ readonly satinSettings: FindChangeSatinSetting; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FindChangeTransparencySetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * FindChangeTransparencySetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Find color preferences. */ declare class FindColorPreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The color to find. Can return: Swatch or NothingEnum enumerator. */ findWhat: Swatch | NothingEnum; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the FindColorPreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Tint to find. Can return: Real (0 - 100) or NothingEnum enumerator. */ tint: number | NothingEnum; /** * Lower limit of tint to find. Can return: Real (0 - 100) or NothingEnum * enumerator. */ tintLowerLimit: number | NothingEnum; /** * Upper limit of tint to find. Can return: Real (0 - 100) or NothingEnum * enumerator. */ tintUpperLimit: number | NothingEnum; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FindColorPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the FindColorPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Find glyph preferences. */ declare class FindGlyphPreference extends Preference { /** * The font applied to the FindGlyphPreference, specified as either a font * object or the name of font family. Can return: Font, String or NothingEnum * enumerator. */ appliedFont: Font | string | NothingEnum; /** * Value of Design Axes. Can return: Array of Reals or NothingEnum enumerator. */ designAxes: (number[] | NothingEnum)[]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The name of the font style. Can return: String or NothingEnum enumerator. */ fontStyle: string | NothingEnum; /** * The GID/CID of the glyph. Can return: Long Integer or NothingEnum * enumerator. */ glyphID: number | NothingEnum; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the FindGlyphPreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The Registry Ordered font group. Can return: Array of 2 Strings or * NothingEnum enumerator. */ rosFontGroup: (string[][] | NothingEnum)[]; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FindGlyphPreference[]; /** * If true, Nth design axis of variable font is hidden. * @param nthAxisIndex Index of design axis. */ isNthDesignAxisHidden(nthAxisIndex: number): boolean; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Set Nth design axis of a variable font. * @param nthAxisIndex Index of design axis. * @param nthAxisValue Value of nth design axis. */ setNthDesignAxis(nthAxisIndex: number, nthAxisValue: number): void; /** * Generates a string which, if executed, will return the FindGlyphPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Find grep preferences. */ declare class FindGrepPreference extends Preference { /** * If true, words unassociated with a hyphenation dictionary can break to the * next line on any character. Can return: Boolean or NothingEnum enumerator. */ allowArbitraryHyphenation: boolean | NothingEnum; /** * The character style to search for or change to. Can return: String or * NothingEnum enumerator. Can also accept: CharacterStyle. */ appliedCharacterStyle: CharacterStyle | string | NothingEnum; /** * The conditions to search for or change to. Specify the "nothing" enum for * "Any" or an empty list for "[Unconditional]". Can return: Array of Strings * or NothingEnum enumerator. Can also accept: Array of Conditions. */ appliedConditions: (Conditions | string[] | NothingEnum)[]; /** * The font applied to the FindGrepPreference, specified as either a font * object or the name of font family. Can return: Font, String or NothingEnum * enumerator. */ appliedFont: Font | string | NothingEnum; /** * The language to search for or change to. Can return: String or NothingEnum * enumerator. Can also accept: Language or LanguageWithVendors. */ appliedLanguage: Language | string | LanguageWithVendors | NothingEnum; /** * The list to be part of. Can return: NumberingList, String or NothingEnum * enumerator. */ appliedNumberingList: NumberingList | string | NothingEnum; /** * The paragraph style to search for or change to. Can return: String or * NothingEnum enumerator. Can also accept: ParagraphStyle. */ appliedParagraphStyle: ParagraphStyle | string | NothingEnum; /** * The percent of the type size to use for auto leading. (Range: 0 to 500). Can * return: Real or NothingEnum enumerator. * @remarks Range: 0 to 500 */ autoLeading: number | NothingEnum; /** * The number of half-width characters at or below which the characters * automatically run horizontally in vertical text. Can return: Short Integer * or NothingEnum enumerator. */ autoTcy: number | NothingEnum; /** * If true, auto tcy includes Roman characters. Can return: Boolean or * NothingEnum enumerator. */ autoTcyIncludeRoman: boolean | NothingEnum; /** * If true or set to an enumeration value, balances ragged lines. Note: Not * valid with a single-line text composer. Can return: Boolean, * BalanceLinesStyle enumerator or NothingEnum enumerator. */ balanceRaggedLines: BalanceLinesStyle | boolean | NothingEnum; /** * The baseline shift applied to the text. Can return: Unit or NothingEnum * enumerator. */ baselineShift: number | NothingEnum; /** * Bullet character. Can return: Bullet or NothingEnum enumerator. */ readonly bulletChar: Bullet | NothingEnum; /** * List type for bullets and numbering. Can return: ListType enumerator or * NothingEnum enumerator. */ bulletsAndNumberingListType: ListType | NothingEnum; /** * The character style to be used for the text after string. Can return: * CharacterStyle, String or NothingEnum enumerator. */ bulletsCharacterStyle: CharacterStyle | string | NothingEnum; /** * The text after string expression for bullets. Can return: String or * NothingEnum enumerator. */ bulletsTextAfter: string | NothingEnum; /** * If true, adds the double period (..), ellipse (...), and double hyphen (--) * to the selected kinsoku set. Note: Valid only when a kinsoku set is in * effect. Can return: Boolean or NothingEnum enumerator. */ bunriKinshi: boolean | NothingEnum; /** * The capitalization scheme. Can return: Capitalization enumerator or * NothingEnum enumerator. */ capitalization: Capitalization | NothingEnum; /** * The alignment of small characters to the largest character in the line. Can * return: CharacterAlignment enumerator or NothingEnum enumerator. */ characterAlignment: CharacterAlignment | NothingEnum; /** * The direction of the character. Can return: CharacterDirectionOptions * enumerator or NothingEnum enumerator. */ characterDirection: CharacterDirectionOptions | NothingEnum; /** * The rotation angle (in degrees) of individual characters. Note: The rotation * is counterclockwise. Can return: Real or NothingEnum enumerator. */ characterRotation: number | NothingEnum; /** * If true, uses grid tracking to track non-Roman characters in CJK grids. Can * return: Boolean or NothingEnum enumerator. */ cjkGridTracking: boolean | NothingEnum; /** * The text composer to use to compose the text. Can return: String or * NothingEnum enumerator. */ composer: string | NothingEnum; /** * Value of Design Axes. Can return: Array of Reals or NothingEnum enumerator. */ designAxes: (number[] | NothingEnum)[]; /** * Position of diacriticical characters. Can return: DiacriticPositionOptions * enumerator or NothingEnum enumerator. */ diacriticPosition: DiacriticPositionOptions | NothingEnum; /** * The digits type. Can return: DigitsTypeOptions enumerator or NothingEnum * enumerator. */ digitsType: DigitsTypeOptions | NothingEnum; /** * The number of characters to drop cap. Can return: Short Integer (0 - 150) or * NothingEnum enumerator. */ dropCapCharacters: number | NothingEnum; /** * The number of lines to drop cap. Can return: Short Integer (0 - 25) or * NothingEnum enumerator. */ dropCapLines: number | NothingEnum; /** * Details about the drop cap based on the glyph outlines. 1 = left side * bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid. * Can return: Long Integer or NothingEnum enumerator. */ dropcapDetail: number | NothingEnum; /** * The stroke join type applied to the characters of the text. Can return: * OutlineJoin enumerator or NothingEnum enumerator. */ endJoin: OutlineJoin | NothingEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink), applied as a fill color, * to search for or change to. Can return: String or NothingEnum enumerator. * Can also accept: Swatch. */ fillColor: string | Swatch | NothingEnum; /** * The tint (as a percentage) of the fill color of the FindGrepPreference. (To * specify a tint percentage, use a number in the range of 0 to 100; to use the * inherited or overridden value, use -1.). Can return: Real or NothingEnum * enumerator. * @remarks Range: 0 to 100 */ fillTint: number | NothingEnum; /** * The FindGrepPreference to find. Can return: String or NothingEnum * enumerator. */ findWhat: string | NothingEnum; /** * The amount to indent the first line. Can return: Unit or NothingEnum * enumerator. */ firstLineIndent: number | NothingEnum; /** * The name of the font style. Can return: String or NothingEnum enumerator. */ fontStyle: string | NothingEnum; /** * The glyph variant to substitute for standard glyphs. Can return: * AlternateGlyphForms enumerator or NothingEnum enumerator. */ glyphForm: AlternateGlyphForms | NothingEnum; /** * The angle of a linear gradient applied to the fill of the text. (Range: -180 * to 180). Can return: Real or NothingEnum enumerator. */ gradientFillAngle: number | NothingEnum; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the text. Can return: Real or NothingEnum enumerator. */ gradientFillLength: number | NothingEnum; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the text, in the format [x, y]. Can return: Array of 2 Units or * NothingEnum enumerator. */ gradientFillStart: (number[][] | NothingEnum)[]; /** * The angle of a linear gradient applied to the stroke of the text. (Range: * -180 to 180). Can return: Real or NothingEnum enumerator. */ gradientStrokeAngle: number | NothingEnum; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the text. Can return: Real or NothingEnum enumerator. */ gradientStrokeLength: number | NothingEnum; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the text, in the format [x, y]. Can return: Array of 2 Units or * NothingEnum enumerator. */ gradientStrokeStart: (number[][] | NothingEnum)[]; /** * The alignment to the frame grid or baseline grid. Can return: GridAlignment * enumerator or NothingEnum enumerator. */ gridAlignment: GridAlignment | NothingEnum; /** * The manual gyoudori setting. Can return: Short Integer or NothingEnum * enumerator. */ gridGyoudori: number | NothingEnum; /** * The horizontal scaling applied to the FindGrepPreference. Can return: Real * or NothingEnum enumerator. */ horizontalScale: number | NothingEnum; /** * If true, allows the last word in a text column to be hyphenated. Can return: * Boolean or NothingEnum enumerator. */ hyphenateAcrossColumns: boolean | NothingEnum; /** * If true, allows hyphenation in the last word in a paragraph. Note: Valid * only when hyphenation is true. Can return: Boolean or NothingEnum * enumerator. */ hyphenateLastWord: boolean | NothingEnum; /** * If true, ignores optical edge alignment for the paragraph. Can return: * Boolean or NothingEnum enumerator. */ ignoreEdgeAlignment: boolean | NothingEnum; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The number of grid squares in which to arrange the text. . Can return: Short * Integer or NothingEnum enumerator. */ jidori: number | NothingEnum; /** * The paragraph alignment. Can return: Justification enumerator or NothingEnum * enumerator. */ justification: Justification | NothingEnum; /** * Use of Kashidas for justification. Can return: KashidasOptions enumerator or * NothingEnum enumerator. */ kashidas: KashidasOptions | NothingEnum; /** * If true, keeps all lines of the paragraph together. If false, allows * paragraphs to break across pages or columns. Can return: Boolean or * NothingEnum enumerator. */ keepAllLinesTogether: boolean | NothingEnum; /** * The minimum number of lines to keep together in a paragraph before allowing * a page break. Can return: Short Integer (1 - 50) or NothingEnum enumerator. */ keepFirstLines: number | NothingEnum; /** * The minimum number of lines to keep together in a paragraph after a page * break. Can return: Short Integer (1 - 50) or NothingEnum enumerator. */ keepLastLines: number | NothingEnum; /** * If true, keeps a specified number of lines together when the paragraph * breaks across columns or text frames. Can return: Boolean or NothingEnum * enumerator. */ keepLinesTogether: boolean | NothingEnum; /** * If true, forces the rule above the paragraph to remain in the frame bounds. * Note: Valid only when rule above is true. Can return: Boolean or NothingEnum * enumerator. */ keepRuleAboveInFrame: boolean | NothingEnum; /** * The minimum number of lines to keep with the next paragraph. Can return: * Short Integer (0 - 5) or NothingEnum enumerator. */ keepWithNext: number | NothingEnum; /** * If the first line in the paragraph should be kept with the last line of * previous paragraph. Can return: Boolean or NothingEnum enumerator. */ keepWithPrevious: boolean | NothingEnum; /** * The alignment of kenten characters relative to the parent characters. . Can * return: KentenAlignment enumerator or NothingEnum enumerator. */ kentenAlignment: KentenAlignment | NothingEnum; /** * The character set used for the custom kenten character. Note: Valid only * when kenten kind is custom. . Can return: KentenCharacterSet enumerator or * NothingEnum enumerator. */ kentenCharacterSet: KentenCharacterSet | NothingEnum; /** * The character used for kenten. Note: Valid only when kenten kind is custom. * Can return: String or NothingEnum enumerator. */ kentenCustomCharacter: string | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of * kenten characters. Can return: Swatch, String or NothingEnum enumerator. */ kentenFillColor: string | Swatch | NothingEnum; /** * The font to use for kenten characters. Can return: Font, String or * NothingEnum enumerator. */ kentenFont: Font | string | NothingEnum; /** * The size (in points) of kenten characters. Can return: Real or NothingEnum * enumerator. */ kentenFontSize: number | NothingEnum; /** * The font style of kenten characters. Can return: String or NothingEnum * enumerator. */ kentenFontStyle: string | NothingEnum; /** * The style of kenten characters. Can return: KentenCharacter enumerator or * NothingEnum enumerator. */ kentenKind: KentenCharacter | NothingEnum; /** * The method of overprinting the kenten fill. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ kentenOverprintFill: AdornmentOverprint | NothingEnum; /** * The method of overprinting the kenten stroke. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ kentenOverprintStroke: AdornmentOverprint | NothingEnum; /** * The distance between kenten characters and their parent characters. Can * return: Real or NothingEnum enumerator. */ kentenPlacement: number | NothingEnum; /** * The kenten position relative to the parent character. Can return: * RubyKentenPosition enumerator or NothingEnum enumerator. */ kentenPosition: RubyKentenPosition | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * kenten characters. Can return: Swatch, String or NothingEnum enumerator. */ kentenStrokeColor: string | Swatch | NothingEnum; /** * The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100). * Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ kentenStrokeTint: number | NothingEnum; /** * The fill tint (as a percentage) of kenten characters. (Range: 0 to 100). Can * return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ kentenTint: number | NothingEnum; /** * The stroke weight (in points) of kenten characters. Can return: Real or * NothingEnum enumerator. */ kentenWeight: number | NothingEnum; /** * The horizontal size of kenten characters as a percent of the original size. * Can return: Real or NothingEnum enumerator. */ kentenXScale: number | NothingEnum; /** * The vertical size of kenten charachers as a percent of the original size. . * Can return: Real or NothingEnum enumerator. */ kentenYScale: number | NothingEnum; /** * The type of pair kerning. Can return: String or NothingEnum enumerator. */ kerningMethod: string | NothingEnum; /** * The amount of space to add or remove between characters, specified in * thousands of an em. . Can return: Real or NothingEnum enumerator. */ kerningValue: number | NothingEnum; /** * The keyboard direction of the character. Can return: * CharacterDirectionOptions enumerator or NothingEnum enumerator. */ keyboardDirection: CharacterDirectionOptions | NothingEnum; /** * The type of hanging punctuation to allow. Note: Valid only when a kinsoku * set is in effect. Can return: KinsokuHangTypes enumerator or NothingEnum * enumerator. */ kinsokuHangType: KinsokuHangTypes | NothingEnum; /** * The kinsoku set that determines legitimate line breaks. Can return: * KinsokuTable, KinsokuSet enumerator, String or NothingEnum enumerator. */ kinsokuSet: KinsokuSet | KinsokuTable | string | NothingEnum; /** * The type of kinsoku processing for preventing kinsoku characters from * beginning or ending a line. Note: Valid only when a kinsoku set is defined. * Can return: KinsokuType enumerator or NothingEnum enumerator. */ kinsokuType: KinsokuType | NothingEnum; /** * The amount to indent the last line in the paragraph. Can return: Unit or * NothingEnum enumerator. */ lastLineIndent: number | NothingEnum; /** * The leading applied to the text. Can return: Unit, Leading enumerator or * NothingEnum enumerator. */ leading: Leading | number | NothingEnum; /** * The amount of space before each character. Can return: Real or NothingEnum * enumerator. */ leadingAki: number | NothingEnum; /** * The point from which leading is measured from line to line. Can return: * LeadingModel enumerator or NothingEnum enumerator. */ leadingModel: LeadingModel | NothingEnum; /** * The width of the left indent. Can return: Unit or NothingEnum enumerator. */ leftIndent: number | NothingEnum; /** * If true, replaces specific character combinations (e.g., fl, fi) with * ligature characters. Can return: Boolean or NothingEnum enumerator. */ ligatures: boolean | NothingEnum; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. Can return: Real (0 - * 1000) or NothingEnum enumerator. */ miterLimit: number | NothingEnum; /** * The mojikumi table. For information, see mojikumi table defaults. Can * return: MojikumiTable, String, MojikumiTableDefaults enumerator or * NothingEnum enumerator. */ mojikumi: MojikumiTable | MojikumiTableDefaults | string | NothingEnum; /** * If true, keeps the text on the same line. . Can return: Boolean or * NothingEnum enumerator. */ noBreak: boolean | NothingEnum; /** * If true, apply the numbering restart policy. Can return: Boolean or * NothingEnum enumerator. */ numberingApplyRestartPolicy: boolean | NothingEnum; /** * The character style to be used for the number string. Can return: * CharacterStyle, String or NothingEnum enumerator. */ numberingCharacterStyle: CharacterStyle | string | NothingEnum; /** * Continue the numbering at this level. Can return: Boolean or NothingEnum * enumerator. */ numberingContinue: boolean | NothingEnum; /** * The number string expression for numbering. Can return: String or * NothingEnum enumerator. */ numberingExpression: string | NothingEnum; /** * Numbering format options. Can return: NumberingStyle enumerator, String or * NothingEnum enumerator. */ numberingFormat: NumberingStyle | string | NothingEnum; /** * The level of the paragraph. Can return: Long Integer or NothingEnum * enumerator. */ numberingLevel: number | NothingEnum; /** * Numbering restart policies. Can return: NumberingRestartPolicy or * NothingEnum enumerator. */ readonly numberingRestartPolicies: NumberingRestartPolicy | NothingEnum; /** * Determines starting number in a numbered list. Can return: Long Integer or * NothingEnum enumerator. */ numberingStartAt: number | NothingEnum; /** * If true, uses contextual alternate forms in OpenType fonts. Can return: * Boolean or NothingEnum enumerator. */ otfContextualAlternate: boolean | NothingEnum; /** * If true, uses discretionary ligatures in OpenType fonts. Can return: Boolean * or NothingEnum enumerator. */ otfDiscretionaryLigature: boolean | NothingEnum; /** * The figure style in OpenType fonts. Can return: OTFFigureStyle enumerator or * NothingEnum enumerator. */ otfFigureStyle: OTFFigureStyle | NothingEnum; /** * If true, uses fractions in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfFraction: boolean | NothingEnum; /** * If true, switches hiragana fonts, which have different glyphs for horizontal * and vertical. . Can return: Boolean or NothingEnum enumerator. */ otfHVKana: boolean | NothingEnum; /** * If true, use historical forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfHistorical: boolean | NothingEnum; /** * If true, use alternate justification forms in OpenType fonts. Can return: * Boolean or NothingEnum enumerator. */ otfJustificationAlternate: boolean | NothingEnum; /** * If true, uses localized forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfLocale: boolean | NothingEnum; /** * If true, uses mark positioning in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfMark: boolean | NothingEnum; /** * If true, uses ordinals in OpenType fonts. Can return: Boolean or NothingEnum * enumerator. */ otfOrdinal: boolean | NothingEnum; /** * If true, use overlapping swash forms in OpenType fonts. Can return: Boolean * or NothingEnum enumerator. */ otfOverlapSwash: boolean | NothingEnum; /** * If true, kerns according to proportional CJK metrics in OpenType fonts. Can * return: Boolean or NothingEnum enumerator. */ otfProportionalMetrics: boolean | NothingEnum; /** * If true, applies italics to half-width alphanumerics. . Can return: Boolean * or NothingEnum enumerator. */ otfRomanItalics: boolean | NothingEnum; /** * If true, use a slashed zeroes in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfSlashedZero: boolean | NothingEnum; /** * If true, use stretched alternate forms in OpenType fonts. Can return: * Boolean or NothingEnum enumerator. */ otfStretchedAlternate: boolean | NothingEnum; /** * If true, use stylistic alternate forms in OpenType fonts. Can return: * Boolean or NothingEnum enumerator. */ otfStylisticAlternate: boolean | NothingEnum; /** * The stylistic sets to use in OpenType fonts. Can return: Long Integer or * NothingEnum enumerator. */ otfStylisticSets: number | NothingEnum; /** * If true, uses swash forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfSwash: boolean | NothingEnum; /** * If true, uses titling forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfTitling: boolean | NothingEnum; /** * If true, the fill color of the characters will overprint. Can return: * Boolean or NothingEnum enumerator. */ overprintFill: boolean | NothingEnum; /** * If true, the stroke of the characters will overprint. Can return: Boolean or * NothingEnum enumerator. */ overprintStroke: boolean | NothingEnum; /** * Paragraph direction. Can return: ParagraphDirectionOptions enumerator or * NothingEnum enumerator. */ paragraphDirection: ParagraphDirectionOptions | NothingEnum; /** * If true, the gyoudori mode applies to the entire paragraph. If false, the * gyoudori mode applies to each line in the paragraph. Can return: Boolean or * NothingEnum enumerator. */ paragraphGyoudori: boolean | NothingEnum; /** * Paragraph justification. Can return: ParagraphJustificationOptions * enumerator or NothingEnum enumerator. */ paragraphJustification: ParagraphJustificationOptions | NothingEnum; /** * Paragraph kashida width. 0 is none, 1 is short, 2 is medium, 3 is long. Can * return: Real or NothingEnum enumerator. */ paragraphKashidaWidth: number | NothingEnum; /** * The parent of the FindGrepPreference (a Application). */ readonly parent: Application; /** * The text size. Can return: Unit or NothingEnum enumerator. */ pointSize: number | NothingEnum; /** * The text position relative to the baseline. Can return: Position enumerator * or NothingEnum enumerator. */ position: Position | NothingEnum; /** * The OpenType positional form. Can return: PositionalForms enumerator or * NothingEnum enumerator. */ positionalForm: PositionalForms | NothingEnum; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, disallows line breaks in numbers. If false, lines can break between * digits in multi-digit numbers. Can return: Boolean or NothingEnum * enumerator. */ rensuuji: boolean | NothingEnum; /** * The width of the right indent. Can return: Unit or NothingEnum enumerator. */ rightIndent: number | NothingEnum; /** * If true, rotates Roman characters in vertical text. Can return: Boolean or * NothingEnum enumerator. */ rotateSingleByteCharacters: boolean | NothingEnum; /** * The ruby alignment. Can return: RubyAlignments enumerator or NothingEnum * enumerator. */ rubyAlignment: RubyAlignments | NothingEnum; /** * If true, auto aligns ruby. Can return: Boolean or NothingEnum enumerator. */ rubyAutoAlign: boolean | NothingEnum; /** * If true, automatically scales ruby to the specified percent of parent text * size. For information on specifying a percent, see ruby parent scaling * percent. . Can return: Boolean or NothingEnum enumerator. */ rubyAutoScaling: boolean | NothingEnum; /** * If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to * fit one em. Can return: Boolean or NothingEnum enumerator. */ rubyAutoTcyAutoScale: boolean | NothingEnum; /** * The number of digits included in auto tcy (tate-chuu-yoko) in ruby. Can * return: Short Integer or NothingEnum enumerator. */ rubyAutoTcyDigits: number | NothingEnum; /** * If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. Can * return: Boolean or NothingEnum enumerator. */ rubyAutoTcyIncludeRoman: boolean | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby * characters. Can return: Swatch, String or NothingEnum enumerator. */ rubyFill: string | Swatch | NothingEnum; /** * The font applied to ruby characters. Can return: Font, String or NothingEnum * enumerator. */ rubyFont: Font | string | NothingEnum; /** * The size (in points) of ruby characters. Can return: Real or NothingEnum * enumerator. */ rubyFontSize: number | NothingEnum; /** * The font style of ruby characters. Can return: String or NothingEnum * enumerator. */ rubyFontStyle: string | NothingEnum; /** * If true, uses OpenType Pro fonts for ruby. Can return: Boolean or * NothingEnum enumerator. */ rubyOpenTypePro: boolean | NothingEnum; /** * If true, constrains ruby overhang to the specified amount. For information * on specifying an amount, see ruby parent overhang amount. . Can return: * Boolean or NothingEnum enumerator. */ rubyOverhang: boolean | NothingEnum; /** * The method of overprinting the ruby fill. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ rubyOverprintFill: AdornmentOverprint | NothingEnum; /** * The method of overprinting the ruby stroke. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ rubyOverprintStroke: AdornmentOverprint | NothingEnum; /** * The amount by which ruby characters can overhang the parent text. Can * return: RubyOverhang enumerator or NothingEnum enumerator. */ rubyParentOverhangAmount: RubyOverhang | NothingEnum; /** * The amount (as a percentage) to scale the parent text size to determine the * ruby text size. Can return: Real or NothingEnum enumerator. */ rubyParentScalingPercent: number | NothingEnum; /** * The ruby spacing relative to the parent text. . Can return: * RubyParentSpacing enumerator or NothingEnum enumerator. */ rubyParentSpacing: RubyParentSpacing | NothingEnum; /** * The position of ruby characters relative to the parent text. Can return: * RubyKentenPosition enumerator or NothingEnum enumerator. */ rubyPosition: RubyKentenPosition | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * ruby characters. Can return: Swatch, String or NothingEnum enumerator. */ rubyStroke: string | Swatch | NothingEnum; /** * The stroke tint (as a percentage) of ruby characters. Can return: Real or * NothingEnum enumerator. */ rubyStrokeTint: number | NothingEnum; /** * The tint (as a percentage) of the ruby fill color. (Range: 0 to 100). Can * return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ rubyTint: number | NothingEnum; /** * The ruby type. Can return: RubyTypes enumerator or NothingEnum enumerator. */ rubyType: RubyTypes | NothingEnum; /** * The stroke weight (in points) of ruby characters. Can return: Real or * NothingEnum enumerator. */ rubyWeight: number | NothingEnum; /** * The amount of horizontal space between ruby and parent characters. Can * return: Real or NothingEnum enumerator. */ rubyXOffset: number | NothingEnum; /** * The horizontal size of ruby characters, specified as a percent of the * original size. Can return: Real or NothingEnum enumerator. */ rubyXScale: number | NothingEnum; /** * The amount of vertical space between ruby and parent characters. Can return: * Real or NothingEnum enumerator. */ rubyYOffset: number | NothingEnum; /** * The vertical size of ruby characters, specified as a percent of the original * size. Can return: Real or NothingEnum enumerator. */ rubyYScale: number | NothingEnum; /** * The space between paragraphs using same style. Can return: Unit, Spacing * enumerator or NothingEnum enumerator. */ sameParaStyleSpacing: Spacing | number | NothingEnum; /** * If true, the line changes size when characters are scaled. . Can return: * Boolean or NothingEnum enumerator. */ scaleAffectsLineHeight: boolean | NothingEnum; /** * If true, applies shatai rotation. Can return: Boolean or NothingEnum * enumerator. */ shataiAdjustRotation: boolean | NothingEnum; /** * If true, adjusts shatai tsume. Can return: Boolean or NothingEnum * enumerator. */ shataiAdjustTsume: boolean | NothingEnum; /** * The shatai lens angle (in degrees). Can return: Real or NothingEnum * enumerator. */ shataiDegreeAngle: number | NothingEnum; /** * The amount (as a percentage) of shatai obliquing to apply. Can return: Real * or NothingEnum enumerator. */ shataiMagnification: number | NothingEnum; /** * The alignment to use for lines that contain a single word. Can return: * SingleWordJustification enumerator or NothingEnum enumerator. */ singleWordJustification: SingleWordJustification | NothingEnum; /** * The skew angle of the FindGrepPreference. Can return: Real or NothingEnum * enumerator. */ skew: number | NothingEnum; /** * The height of the paragraph space below. Can return: Unit or NothingEnum * enumerator. */ spaceAfter: number | NothingEnum; /** * The height of the paragraph space above. Can return: Unit or NothingEnum * enumerator. */ spaceBefore: number | NothingEnum; /** * The minimum space after a span or a split column. Can return: Unit or * NothingEnum enumerator. */ spanColumnMinSpaceAfter: number | NothingEnum; /** * The minimum space before a span or a split column. Can return: Unit or * NothingEnum enumerator. */ spanColumnMinSpaceBefore: number | NothingEnum; /** * Whether a paragraph should be a single column, span columns or split * columns. Can return: SpanColumnTypeOptions enumerator or NothingEnum * enumerator. */ spanColumnType: SpanColumnTypeOptions | NothingEnum; /** * The number of columns a paragraph spans or the number of split columns. Can * return: Short Integer (1 - 40), SpanColumnCountOptions enumerator or * NothingEnum enumerator. */ spanSplitColumnCount: number | SpanColumnCountOptions | NothingEnum; /** * The inside gutter if the paragraph splits columns. Can return: Unit or * NothingEnum enumerator. */ splitColumnInsideGutter: number | NothingEnum; /** * The outside gutter if the paragraph splits columns. Can return: Unit or * NothingEnum enumerator. */ splitColumnOutsideGutter: number | NothingEnum; /** * The location at which to start the paragraph. Can return: StartParagraph * enumerator or NothingEnum enumerator. */ startParagraph: StartParagraph | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the * strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator. */ strikeThroughColor: string | Swatch | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator. */ strikeThroughGapColor: string | Swatch | NothingEnum; /** * If true, the gap color of the strikethrough stroke will overprint. Note: * Valid when strike through type is not solid. Can return: Boolean or * NothingEnum enumerator. */ strikeThroughGapOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 * to 100) Note: Valid when strike through type is not solid. Can return: Real * or NothingEnum enumerator. * @remarks Range: 0 to 100 */ strikeThroughGapTint: number | NothingEnum; /** * The amount by which to offset the strikethrough stroke from the text * baseline. Can return: Unit or NothingEnum enumerator. */ strikeThroughOffset: number | NothingEnum; /** * If true, the strikethrough stroke will overprint. Can return: Boolean or * NothingEnum enumerator. */ strikeThroughOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100). * Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ strikeThroughTint: number | NothingEnum; /** * The stroke type of the strikethrough stroke. Can return: StrokeStyle, String * or NothingEnum enumerator. */ strikeThroughType: string | StrokeStyle | NothingEnum; /** * The stroke weight of the strikethrough stroke. Can return: Unit or * NothingEnum enumerator. */ strikeThroughWeight: number | NothingEnum; /** * If true, draws a strikethrough line through the text. Can return: Boolean or * NothingEnum enumerator. */ strikeThru: boolean | NothingEnum; /** * The stroke alignment applied to the text. Can return: TextStrokeAlign * enumerator or NothingEnum enumerator. */ strokeAlignment: TextStrokeAlign | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink), applied as a stroke color, * to search for or change to. Can return: String or NothingEnum enumerator. * Can also accept: Swatch. */ strokeColor: string | Swatch | NothingEnum; /** * The tint (as a percentage) of the stroke color of the FindGrepPreference. * (To specify a tint percentage, use a number in the range of 0 to 100; to use * the inherited or overridden value, use -1.). Can return: Real or NothingEnum * enumerator. * @remarks Range: 0 to 100 */ strokeTint: number | NothingEnum; /** * The stroke weight applied to the characters of the text. Can return: Unit or * NothingEnum enumerator. */ strokeWeight: number | NothingEnum; /** * If true, makes the character horizontal in vertical text. Can return: * Boolean or NothingEnum enumerator. */ tatechuyoko: boolean | NothingEnum; /** * The horizontal offset for horizontal characters in vertical text. Can * return: Real or NothingEnum enumerator. */ tatechuyokoXOffset: number | NothingEnum; /** * The vertical offset for horizontal characters in vertical text. Can return: * Real or NothingEnum enumerator. */ tatechuyokoYOffset: number | NothingEnum; /** * The amount by which to loosen or tighten a block of text, specified in * thousands of an em. Can return: Real or NothingEnum enumerator. */ tracking: number | NothingEnum; /** * The amount of space after each character. Can return: Real or NothingEnum * enumerator. */ trailingAki: number | NothingEnum; /** * If true, ideographic spaces will not wrap to the next line like text * characters. Can return: Boolean or NothingEnum enumerator. */ treatIdeographicSpaceAsSpace: boolean | NothingEnum; /** * The amount of horizontal character compression. Can return: Real or * NothingEnum enumerator. */ tsume: number | NothingEnum; /** * If true, underlines the text. Can return: Boolean or NothingEnum enumerator. */ underline: boolean | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the underline * stroke. . Can return: Swatch, String or NothingEnum enumerator. */ underlineColor: string | Swatch | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * underline stroke. Note: Valid when underline type is not solid. Can return: * Swatch, String or NothingEnum enumerator. */ underlineGapColor: string | Swatch | NothingEnum; /** * If true, the gap color of the underline stroke will overprint. Can return: * Boolean or NothingEnum enumerator. */ underlineGapOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the gap color of the underline stroke. (Range: * 0 to 100) Note: Valid when underline type is not solid. Can return: Real or * NothingEnum enumerator. * @remarks Range: 0 to 100 */ underlineGapTint: number | NothingEnum; /** * The amount by which to offset the underline from the text baseline. Can * return: Unit or NothingEnum enumerator. */ underlineOffset: number | NothingEnum; /** * If true, the underline stroke color will overprint. Can return: Boolean or * NothingEnum enumerator. */ underlineOverprint: boolean | NothingEnum; /** * The underline stroke tint (as a percentage). (Range: 0 to 100). Can return: * Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ underlineTint: number | NothingEnum; /** * The stroke type of the underline stroke. Can return: StrokeStyle, String or * NothingEnum enumerator. */ underlineType: string | StrokeStyle | NothingEnum; /** * The stroke weight of the underline stroke. Can return: Unit or NothingEnum * enumerator. */ underlineWeight: number | NothingEnum; /** * The vertical scaling applied to the FindGrepPreference. Can return: Real or * NothingEnum enumerator. */ verticalScale: number | NothingEnum; /** * If true, turns on warichu. Can return: Boolean or NothingEnum enumerator. */ warichu: boolean | NothingEnum; /** * The warichu alignment. Can return: WarichuAlignment enumerator or * NothingEnum enumerator. */ warichuAlignment: WarichuAlignment | NothingEnum; /** * The minimum number of characters allowed after a line break. . Can return: * Short Integer or NothingEnum enumerator. */ warichuCharsAfterBreak: number | NothingEnum; /** * The minimum number of characters allowed before a line break. Can return: * Short Integer or NothingEnum enumerator. */ warichuCharsBeforeBreak: number | NothingEnum; /** * The gap between lines of warichu characters. Can return: Real or NothingEnum * enumerator. */ warichuLineSpacing: number | NothingEnum; /** * The number of lines of warichu within a single normal line. Can return: * Short Integer or NothingEnum enumerator. */ warichuLines: number | NothingEnum; /** * The amount (as a percentage) to scale parent text size to determine warichu * size. Can return: Real or NothingEnum enumerator. */ warichuSize: number | NothingEnum; /** * The x (horizontal) offset for diacritic adjustment. Can return: Real or * NothingEnum enumerator. */ xOffsetDiacritic: number | NothingEnum; /** * The y (vertical) offset for diacritic adjustment. Can return: Real or * NothingEnum enumerator. */ yOffsetDiacritic: number | NothingEnum; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FindGrepPreference[]; /** * If true, Nth design axis of variable font is hidden. * @param nthAxisIndex Index of design axis. */ isNthDesignAxisHidden(nthAxisIndex: number): boolean; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Set Nth design axis of a variable font. * @param nthAxisIndex Index of design axis. * @param nthAxisValue Value of nth design axis. */ setNthDesignAxis(nthAxisIndex: number, nthAxisValue: number): void; /** * Generates a string which, if executed, will return the FindGrepPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Find object preferences. */ declare class FindObjectPreference extends Preference { /** * The metadata property to use as source of actual text. Can return: Ordered * array containing namespacePrefix:String, propertyPath:String or NothingEnum * enumerator. */ actualMetadataProperty: any[] | string | NothingEnum; /** * The source type of actual text. Can return: SourceType enumerator or * NothingEnum enumerator. */ actualTextSourceType: SourceType | NothingEnum; /** * The metadata property to use as source of alternate text. Can return: * Ordered array containing namespacePrefix:String, propertyPath:String or * NothingEnum enumerator. */ altMetadataProperty: any[] | string | NothingEnum; /** * The source type of alternate text. Can return: SourceType enumerator or * NothingEnum enumerator. */ altTextSourceType: SourceType | NothingEnum; /** * The point in the anchored object to position. Can return: AnchorPoint * enumerator or NothingEnum enumerator. */ anchorPoint: AnchorPoint | NothingEnum; /** * The space above an above-line anchored object. Can return: Unit or * NothingEnum enumerator. */ anchorSpaceAbove: number | NothingEnum; /** * The horizontal (x) offset of the anchored object. Can return: Unit or * NothingEnum enumerator. */ anchorXoffset: number | NothingEnum; /** * The vertical (y) offset of the anchored object. Corresponds to the space * after property for above line positioning. Can return: Unit or NothingEnum * enumerator. */ anchorYoffset: number | NothingEnum; /** * The position of the anchored object relative to the anchor. Can return: * AnchorPosition enumerator or NothingEnum enumerator. */ anchoredPosition: AnchorPosition | NothingEnum; /** * The applied object style(s). Can return: String or NothingEnum enumerator. * Can also accept: ObjectStyle. */ appliedObjectStyles: ObjectStyle | string | NothingEnum; /** * The tag type of page item. Can return: TagType enumerator or NothingEnum * enumerator. */ applyTagType: TagType | NothingEnum; /** * If true, text wraps on the master spread apply to that spread only, and not * to any pages the master spread has been applied to. Can return: Boolean or * NothingEnum enumerator. */ applyToMasterPageOnly: boolean | NothingEnum; /** * The arrowhead alignment applied to the FindObjectPreference. Can return: * ArrowHeadAlignmentEnum enumerator or NothingEnum enumerator. */ arrowHeadAlignment: ArrowHeadAlignmentEnum | NothingEnum; /** * The reference point for auto sizing of text frame. Reference point is * automatically adjusted to the suitable value depending on the auto-sizing * type value. As an example, top left reference point becomes top center for * height only dimension. Can return: AutoSizingReferenceEnum enumerator or * NothingEnum enumerator. */ autoSizingReferencePoint: AutoSizingReferenceEnum | NothingEnum; /** * Auto-sizing type of text frame. Based on type, reference value is * automatically adjusted. For example, for height only type, top-left * reference point becomes top-center. Recommended to change auto-sizing type, * after setting other auto-sizing attributes. Can return: AutoSizingTypeEnum * enumerator or NothingEnum enumerator. */ autoSizingType: AutoSizingTypeEnum | NothingEnum; /** * The grid line color, specified either as an array of three doubles, each in * the range 0 to 255 and representing R, G, and B values, or as a UI color. * Can return: Array of 3 Reals (0 - 255) or UIColors enumerator or NothingEnum * enumerator. */ baselineFrameGridColor: (number[][] | NothingEnum | UIColors)[]; /** * The distance between grid lines. Can return: Unit (1 - 8640 points) or * NothingEnum enumerator. */ baselineFrameGridIncrement: number | NothingEnum; /** * The location (top of page, top margin, top of frame, or frame inset) on * which to base the custom baseline grid. Can return: * BaselineFrameGridRelativeOption enumerator or NothingEnum enumerator. */ baselineFrameGridRelativeOption: BaselineFrameGridRelativeOption | NothingEnum; /** * The amount in measurement units to crop the bottom edge of a graphic. Can * return: Unit or NothingEnum enumerator. */ bottomCrop: number | NothingEnum; /** * The shape to apply to the bottom left corner of rectangular shapes. Can * return: CornerOptions enumerator or NothingEnum enumerator. */ bottomLeftCornerOption: CornerOptions | NothingEnum; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes. Can return: Unit or NothingEnum * enumerator. */ bottomLeftCornerRadius: number | NothingEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. Can * return: CornerOptions enumerator or NothingEnum enumerator. */ bottomRightCornerOption: CornerOptions | NothingEnum; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes. Can return: Unit or NothingEnum * enumerator. */ bottomRightCornerRadius: number | NothingEnum; /** * Transparency settings for the content of the FindObjectPreference. Can * return: FindChangeContentTransparencySetting or NothingEnum enumerator. */ readonly contentTransparencySettings: FindChangeContentTransparencySetting | NothingEnum; /** * The contour type. Can return: ContourOptionsTypes enumerator or NothingEnum * enumerator. */ contourType: ContourOptionsTypes | NothingEnum; /** * The custom actual text entered by the user. Can return: String or * NothingEnum enumerator. */ customActualText: string | NothingEnum; /** * The custom alternate text entered by the user. Can return: String or * NothingEnum enumerator. */ customAltText: string | NothingEnum; /** * The end shape of an open path. Can return: EndCap enumerator or NothingEnum * enumerator. */ endCap: EndCap | NothingEnum; /** * The corner join applied to the FindObjectPreference. Can return: EndJoin * enumerator or NothingEnum enumerator. */ endJoin: EndJoin | NothingEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * FindObjectPreference. . Can return: Swatch or NothingEnum enumerator. Can * also accept: String. */ fillColor: string | Swatch | NothingEnum; /** * The percent of tint to use in the FindObjectPreference's fill color. (To * specify a tint percent, use a number in the range of 0 to 100; to use the * inherited or overridden value, use -1.). Can return: Real or NothingEnum * enumerator. * @remarks Range: 0 to 100 */ fillTint: number | NothingEnum; /** * Transparency settings for the fill applied to the FindObjectPreference. Can * return: FindChangeFillTransparencySetting or NothingEnum enumerator. */ readonly fillTransparencySettings: FindChangeFillTransparencySetting | NothingEnum; /** * The distance between the baseline of the text and the top inset of the text * frame or cell. Can return: FirstBaseline enumerator or NothingEnum * enumerator. */ firstBaselineOffset: FirstBaseline | NothingEnum; /** * The point with which to align the image empty when fitting in a frame. For * information, see frame fitting options. Can return: AnchorPoint enumerator * or NothingEnum enumerator. */ fittingAlignment: AnchorPoint | NothingEnum; /** * The frame fitting option to apply to placed or pasted content if the frame * is empty. Can be applied to a frame, object style, or document or to the * application. Can return: EmptyFrameFittingOptions enumerator or NothingEnum * enumerator. */ fittingOnEmptyFrame: EmptyFrameFittingOptions | NothingEnum; /** * If true, enable overrides to document footnote options. Can return: Boolean * or NothingEnum enumerator. */ footnotesEnableOverrides: boolean | NothingEnum; /** * Minimum Spacing Before First Footnote. Can return: Unit (0 - 8640 points) or * NothingEnum enumerator. */ footnotesMinimumSpacing: number | NothingEnum; /** * Space between footnotes. Can return: Unit (0 - 8640 points) or NothingEnum * enumerator. */ footnotesSpaceBetween: number | NothingEnum; /** * If true, enable straddling footnotes. Can return: Boolean or NothingEnum * enumerator. */ footnotesSpanAcrossColumns: boolean | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. Can * return: Swatch or NothingEnum enumerator. */ gapColor: Swatch | NothingEnum; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.). Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ gapTint: number | NothingEnum; /** * If true, generates interlaced GIFs. Note: Not valid when image conversion is * JPEG. Can return: Boolean or NothingEnum enumerator. */ gifOptionsInterlaced: boolean | NothingEnum; /** * The color palette for GIF conversion. Note: Not valid when image conversion * is JPEG. . Can return: GIFOptionsPalette enumerator or NothingEnum * enumerator. */ gifOptionsPalette: GIFOptionsPalette | NothingEnum; /** * The angle of a linear gradient applied to the fill of the * FindObjectPreference. (Range: -180 to 180). Can return: Real or NothingEnum * enumerator. */ gradientFillAngle: number | NothingEnum; /** * The angle of a linear gradient applied to the stroke of the * FindObjectPreference. (Range: -180 to 180). Can return: Real or NothingEnum * enumerator. */ gradientStrokeAngle: number | NothingEnum; /** * The horizontal reference point on the page. Valid only when anchored * position is custom. Can return: AnchoredRelativeTo enumerator or NothingEnum * enumerator. */ horizontalReferencePoint: AnchoredRelativeTo | NothingEnum; /** * If true, ignores text wrap settings for drawn or placed objects in the text * frame. . Can return: Boolean or NothingEnum enumerator. */ ignoreWrap: boolean | NothingEnum; /** * Alignment applied to images. Can return: ImageAlignmentType enumerator or * NothingEnum enumerator. */ imageAlignment: ImageAlignmentType | NothingEnum; /** * Allows user to select the image format for conversion. Can return: * ImageFormat enumerator or NothingEnum enumerator. */ imageConversionType: ImageFormat | NothingEnum; /** * The export resolution. Can return: ImageResolution enumerator or NothingEnum * enumerator. */ imageExportResolution: ImageResolution | NothingEnum; /** * Image page break settings to be used with objects. Can return: * ImagePageBreakType enumerator or NothingEnum enumerator. */ imagePageBreak: ImagePageBreakType | NothingEnum; /** * Space After applied to images. Can return: Real (0 - 8640) or NothingEnum * enumerator. */ imageSpaceAfter: number | NothingEnum; /** * Space Before applied to images. Can return: Real (0 - 8640) or NothingEnum * enumerator. */ imageSpaceBefore: number | NothingEnum; /** * If true, creates interior clipping paths within the surrounding clipping * path. Note: Valid only when clipping type is alpha channel or detect edges. * . Can return: Boolean or NothingEnum enumerator. */ includeInsideEdges: boolean | NothingEnum; /** * The amount to offset text from the edges of the text frame, specified either * as a single value applied uniformly to all sides of the text frame or as an * array of 4 values in the format [top inset, left inset, bottom inset, right * inset]. Can return: Unit (0 - 8640 points), Array of 4 Units (0 - 8640 * points) or NothingEnum enumerator. */ insetSpacing: (number[][] | number | NothingEnum)[]; /** * If true, inverts the text wrap. Can return: Boolean or NothingEnum * enumerator. */ inverse: boolean | NothingEnum; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The formatting method for converted JPEG images. Note: Not valid when image * conversion is GIF. Can return: JPEGOptionsFormat enumerator or NothingEnum * enumerator. */ jpegOptionsFormat: JPEGOptionsFormat | NothingEnum; /** * The quality of converted JPEG images. Note: Not valid when image conversion * is GIF. . Can return: JPEGOptionsQuality enumerator or NothingEnum * enumerator. */ jpegOptionsQuality: JPEGOptionsQuality | NothingEnum; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000). Can return: Real or NothingEnum enumerator. * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number | NothingEnum; /** * The amount in measurement units to crop the left edge of a graphic. Can * return: Unit or NothingEnum enumerator. */ leftCrop: number | NothingEnum; /** * The arrowhead applied to the start of the path. . Can return: ArrowHead * enumerator or NothingEnum enumerator. */ leftLineEnd: ArrowHead | NothingEnum; /** * If true, prevents manual positioning of the anchored object. Can return: * Boolean or NothingEnum enumerator. */ lockPosition: boolean | NothingEnum; /** * The minimum distance between the baseline of the text and the top inset of * the text frame or cell. Can return: Unit (0 - 8640 points) or NothingEnum * enumerator. */ minimumFirstBaselineOffset: number | NothingEnum; /** * The minimum height for auto-sizing of the text frame. Can return: Unit or * NothingEnum enumerator. */ minimumHeightForAutoSizing: number | NothingEnum; /** * The minimum width for auto-sizing of the text frame. Can return: Unit or * NothingEnum enumerator. */ minimumWidthForAutoSizing: number | NothingEnum; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. Can return: Real (1 - * 500) or NothingEnum enumerator. */ miterLimit: number | NothingEnum; /** * If true, the FindObjectPreference does not print. Can return: Boolean or * NothingEnum enumerator. */ nonprinting: boolean | NothingEnum; /** * If true, adjust the position of characters at the edges of the frame to * provide a better appearance. Can return: Boolean or NothingEnum enumerator. */ opticalMarginAlignment: boolean | NothingEnum; /** * The point size used as the basis for calculating optical margin alignment. * (Range: 0.1 to 1296). Can return: Unit (0.1 - 1296 points) or NothingEnum * enumerator. */ opticalMarginSize: number | NothingEnum; /** * If true, the FindObjectPreference's fill color overprints any underlying * objects. If false, the fill color knocks out the underlying colors. Can * return: Boolean or NothingEnum enumerator. */ overprintFill: boolean | NothingEnum; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. Can return: Boolean or NothingEnum * enumerator. */ overprintGap: boolean | NothingEnum; /** * If true, the FindObjectPreference's stroke color overprints any underlying * objects. If false, the stroke color knocks out the underlying colors. Can * return: Boolean or NothingEnum enumerator. */ overprintStroke: boolean | NothingEnum; /** * The parent of the FindObjectPreference (a Application). */ readonly parent: Application; /** * If true, pins the position of the anchored object within the text frame top * and bottom. Can return: Boolean or NothingEnum enumerator. */ pinPosition: boolean | NothingEnum; /** * The point in the referenced object relative to which to position the * anchored object. Notes: Valid only when anchored position is custom. Can * return: AnchorPoint enumerator or NothingEnum enumerator. */ positionReferencePoint: AnchorPoint | NothingEnum; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * Preserve Appearance from Layout. Can return: * PreserveAppearanceFromLayoutEnum enumerator or NothingEnum enumerator. */ preserveAppearanceFromLayout: PreserveAppearanceFromLayoutEnum | NothingEnum; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000). Can return: Real or NothingEnum enumerator. * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number | NothingEnum; /** * The amount in measurement units to crop the right edge of a graphic. Can * return: Unit or NothingEnum enumerator. */ rightCrop: number | NothingEnum; /** * The arrowhead applied to the end of the path. Can return: ArrowHead * enumerator or NothingEnum enumerator. */ rightLineEnd: ArrowHead | NothingEnum; /** * If true, the position of the anchored object is relative to the binding * spine of the page or spread. Can return: Boolean or NothingEnum enumerator. */ spineRelative: boolean | NothingEnum; /** * The amount to offset the baseline grid. Can return: Unit (0 - 8640 points) * or NothingEnum enumerator. */ startingOffsetForBaselineFrameGrid: number | NothingEnum; /** * The direction of the story. Can return: StoryDirectionOptions enumerator or * NothingEnum enumerator. */ storyDirection: StoryDirectionOptions | NothingEnum; /** * The stroke alignment applied to the FindObjectPreference. Can return: * StrokeAlignment enumerator or NothingEnum enumerator. */ strokeAlignment: StrokeAlignment | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the FindObjectPreference. Can return: Swatch or NothingEnum enumerator. Can * also accept: String. */ strokeColor: string | Swatch | NothingEnum; /** * The corner adjustment applied to the FindObjectPreference. Can return: * StrokeCornerAdjustment enumerator or NothingEnum enumerator. */ strokeCornerAdjustment: StrokeCornerAdjustment | NothingEnum; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. Can return: Array of Units or NothingEnum enumerator. */ strokeDashAndGap: (number[] | NothingEnum)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.). Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ strokeTint: number | NothingEnum; /** * Transparency settings for the stroke. Can return: * FindChangeStrokeTransparencySetting or NothingEnum enumerator. */ readonly strokeTransparencySettings: FindChangeStrokeTransparencySetting | NothingEnum; /** * The name of the stroke style to apply. Can return: StrokeStyle or * NothingEnum enumerator. Can also accept: String. */ strokeType: string | StrokeStyle | NothingEnum; /** * The weight (in points) to apply to the FindObjectPreference's stroke. Can * return: Unit or NothingEnum enumerator. */ strokeWeight: number | NothingEnum; /** * The number of columns in the text frame. Note: Depending on the value of use * fixed column width, the number of columns can change automatically when the * text frame size changes. Can return: Long Integer (1 - 40) or NothingEnum * enumerator. */ textColumnCount: number | NothingEnum; /** * The column width of the columns in the text frame. Can return: Unit (0 - * 8640 points) or NothingEnum enumerator. */ textColumnFixedWidth: number | NothingEnum; /** * The space between columns in the text frame. Can return: Unit (0 - 8640 * points) or NothingEnum enumerator. */ textColumnGutter: number | NothingEnum; /** * The text wrap mode. . Can return: TextWrapModes enumerator or NothingEnum * enumerator. */ textWrapMode: TextWrapModes | NothingEnum; /** * The minimum space between text and the edges of the wrapped object. Specify * four values in the format [top, left, bottom, right]. . Can return: Ordered * array containing top:Unit, left:Unit, bottom:Unit, right:Unit or NothingEnum * enumerator. */ textWrapOffset: any[] | number | NothingEnum; /** * Text wrap side options. Can return: TextWrapSideOptions enumerator or * NothingEnum enumerator. */ textWrapSide: TextWrapSideOptions | NothingEnum; /** * The amount in measurement units to crop the top edge of a graphic. Can * return: Unit or NothingEnum enumerator. */ topCrop: number | NothingEnum; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. Can return: * CornerOptions enumerator or NothingEnum enumerator. */ topLeftCornerOption: CornerOptions | NothingEnum; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes. Can * return: Unit or NothingEnum enumerator. */ topLeftCornerRadius: number | NothingEnum; /** * The shape to apply to the top right corner of rectangular shapes. Can * return: CornerOptions enumerator or NothingEnum enumerator. */ topRightCornerOption: CornerOptions | NothingEnum; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes. Can return: Unit or NothingEnum * enumerator. */ topRightCornerRadius: number | NothingEnum; /** * Transparency settings. Can return: FindChangeTransparencySetting or * NothingEnum enumerator. */ readonly transparencySettings: FindChangeTransparencySetting | NothingEnum; /** * If true, uses a custom baseline frame grid. Can return: Boolean or * NothingEnum enumerator. */ useCustomBaselineFrameGrid: boolean | NothingEnum; /** * If true, maintains column width when the text frame is resized. If false, * causes columns to resize when the text frame is resized. Note: When true, * resizing the frame can change the number of columns in the frame. Can * return: Boolean or NothingEnum enumerator. */ useFixedColumnWidth: boolean | NothingEnum; /** * If true, image page break settings will be used in objects. Can return: * Boolean or NothingEnum enumerator. */ useImagePageBreak: boolean | NothingEnum; /** * If true, minimum height value is used during the auto-sizing of text frame. * . Can return: Boolean or NothingEnum enumerator. */ useMinimumHeightForAutoSizing: boolean | NothingEnum; /** * If true, minimum width value is used during the auto-sizing of text frame. . * Can return: Boolean or NothingEnum enumerator. */ useMinimumWidthForAutoSizing: boolean | NothingEnum; /** * If true, line-breaks are not introduced after auto sizing. . Can return: * Boolean or NothingEnum enumerator. */ useNoLineBreaksForAutoSizing: boolean | NothingEnum; /** * If true, the text wrap path has been explicitly modified by the user. Can * return: Boolean or NothingEnum enumerator. */ readonly userModifiedWrap: boolean | NothingEnum; /** * The vertical alignment of the text content. . Can return: * VerticalJustification enumerator or NothingEnum enumerator. */ verticalJustification: VerticalJustification | NothingEnum; /** * The vertical reference point on the page. Valid when anchored position is * custom. Can return: VerticallyRelativeTo enumerator or NothingEnum * enumerator. */ verticalReferencePoint: VerticallyRelativeTo | NothingEnum; /** * The maximum amount of vertical space between two paragraphs. Note: Valid * only when vertical justification is justified; the specified amount is * applied in addition to the space before or space after values defined for * the paragraph. Can return: Unit (0 - 8640 points) or NothingEnum enumerator. */ verticalThreshold: number | NothingEnum; /** * Provides the actual text for the object */ actualText(): string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Provides the alternate text for the object */ altText(): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FindObjectPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the FindObjectPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Find text preferences. */ declare class FindTextPreference extends Preference { /** * If true, words unassociated with a hyphenation dictionary can break to the * next line on any character. Can return: Boolean or NothingEnum enumerator. */ allowArbitraryHyphenation: boolean | NothingEnum; /** * The character style to search for or change to. Can return: String or * NothingEnum enumerator. Can also accept: CharacterStyle. */ appliedCharacterStyle: CharacterStyle | string | NothingEnum; /** * The conditions to search for or change to. Specify the "nothing" enum for * "Any" or an empty list for "[Unconditional]". Can return: Array of Strings * or NothingEnum enumerator. Can also accept: Array of Conditions. */ appliedConditions: (Conditions | string[] | NothingEnum)[]; /** * The font applied to the FindTextPreference, specified as either a font * object or the name of font family. Can return: Font, String or NothingEnum * enumerator. */ appliedFont: Font | string | NothingEnum; /** * The language to search for or change to. Can return: String or NothingEnum * enumerator. Can also accept: Language or LanguageWithVendors. */ appliedLanguage: Language | string | LanguageWithVendors | NothingEnum; /** * The list to be part of. Can return: NumberingList, String or NothingEnum * enumerator. */ appliedNumberingList: NumberingList | string | NothingEnum; /** * The paragraph style to search for or change to. Can return: String or * NothingEnum enumerator. Can also accept: ParagraphStyle. */ appliedParagraphStyle: ParagraphStyle | string | NothingEnum; /** * The percent of the type size to use for auto leading. (Range: 0 to 500). Can * return: Real or NothingEnum enumerator. * @remarks Range: 0 to 500 */ autoLeading: number | NothingEnum; /** * The number of half-width characters at or below which the characters * automatically run horizontally in vertical text. Can return: Short Integer * or NothingEnum enumerator. */ autoTcy: number | NothingEnum; /** * If true, auto tcy includes Roman characters. Can return: Boolean or * NothingEnum enumerator. */ autoTcyIncludeRoman: boolean | NothingEnum; /** * If true or set to an enumeration value, balances ragged lines. Note: Not * valid with a single-line text composer. Can return: Boolean, * BalanceLinesStyle enumerator or NothingEnum enumerator. */ balanceRaggedLines: BalanceLinesStyle | boolean | NothingEnum; /** * The baseline shift applied to the text. Can return: Unit or NothingEnum * enumerator. */ baselineShift: number | NothingEnum; /** * Bullet character. Can return: Bullet or NothingEnum enumerator. */ readonly bulletChar: Bullet | NothingEnum; /** * List type for bullets and numbering. Can return: ListType enumerator or * NothingEnum enumerator. */ bulletsAndNumberingListType: ListType | NothingEnum; /** * The character style to be used for the text after string. Can return: * CharacterStyle, String or NothingEnum enumerator. */ bulletsCharacterStyle: CharacterStyle | string | NothingEnum; /** * The text after string expression for bullets. Can return: String or * NothingEnum enumerator. */ bulletsTextAfter: string | NothingEnum; /** * If true, adds the double period (..), ellipse (...), and double hyphen (--) * to the selected kinsoku set. Note: Valid only when a kinsoku set is in * effect. Can return: Boolean or NothingEnum enumerator. */ bunriKinshi: boolean | NothingEnum; /** * The capitalization scheme. Can return: Capitalization enumerator or * NothingEnum enumerator. */ capitalization: Capitalization | NothingEnum; /** * The alignment of small characters to the largest character in the line. Can * return: CharacterAlignment enumerator or NothingEnum enumerator. */ characterAlignment: CharacterAlignment | NothingEnum; /** * The direction of the character. Can return: CharacterDirectionOptions * enumerator or NothingEnum enumerator. */ characterDirection: CharacterDirectionOptions | NothingEnum; /** * The rotation angle (in degrees) of individual characters. Note: The rotation * is counterclockwise. Can return: Real or NothingEnum enumerator. */ characterRotation: number | NothingEnum; /** * If true, uses grid tracking to track non-Roman characters in CJK grids. Can * return: Boolean or NothingEnum enumerator. */ cjkGridTracking: boolean | NothingEnum; /** * The text composer to use to compose the text. Can return: String or * NothingEnum enumerator. */ composer: string | NothingEnum; /** * Value of Design Axes. Can return: Array of Reals or NothingEnum enumerator. */ designAxes: (number[] | NothingEnum)[]; /** * Position of diacriticical characters. Can return: DiacriticPositionOptions * enumerator or NothingEnum enumerator. */ diacriticPosition: DiacriticPositionOptions | NothingEnum; /** * The digits type. Can return: DigitsTypeOptions enumerator or NothingEnum * enumerator. */ digitsType: DigitsTypeOptions | NothingEnum; /** * The number of characters to drop cap. Can return: Short Integer (0 - 150) or * NothingEnum enumerator. */ dropCapCharacters: number | NothingEnum; /** * The number of lines to drop cap. Can return: Short Integer (0 - 25) or * NothingEnum enumerator. */ dropCapLines: number | NothingEnum; /** * Details about the drop cap based on the glyph outlines. 1 = left side * bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid. * Can return: Long Integer or NothingEnum enumerator. */ dropcapDetail: number | NothingEnum; /** * The stroke join type applied to the characters of the text. Can return: * OutlineJoin enumerator or NothingEnum enumerator. */ endJoin: OutlineJoin | NothingEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink), applied as a fill color, * to search for or change to. Can return: String or NothingEnum enumerator. * Can also accept: Swatch. */ fillColor: string | Swatch | NothingEnum; /** * The tint (as a percentage) of the fill color of the FindTextPreference. (To * specify a tint percentage, use a number in the range of 0 to 100; to use the * inherited or overridden value, use -1.). Can return: Real or NothingEnum * enumerator. * @remarks Range: 0 to 100 */ fillTint: number | NothingEnum; /** * The FindTextPreference to find. Can return: String or NothingEnum * enumerator. */ findWhat: string | NothingEnum; /** * The amount to indent the first line. Can return: Unit or NothingEnum * enumerator. */ firstLineIndent: number | NothingEnum; /** * The name of the font style. Can return: String or NothingEnum enumerator. */ fontStyle: string | NothingEnum; /** * The glyph variant to substitute for standard glyphs. Can return: * AlternateGlyphForms enumerator or NothingEnum enumerator. */ glyphForm: AlternateGlyphForms | NothingEnum; /** * The angle of a linear gradient applied to the fill of the text. (Range: -180 * to 180). Can return: Real or NothingEnum enumerator. */ gradientFillAngle: number | NothingEnum; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the text. Can return: Real or NothingEnum enumerator. */ gradientFillLength: number | NothingEnum; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the text, in the format [x, y]. Can return: Array of 2 Units or * NothingEnum enumerator. */ gradientFillStart: (number[][] | NothingEnum)[]; /** * The angle of a linear gradient applied to the stroke of the text. (Range: * -180 to 180). Can return: Real or NothingEnum enumerator. */ gradientStrokeAngle: number | NothingEnum; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the text. Can return: Real or NothingEnum enumerator. */ gradientStrokeLength: number | NothingEnum; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the text, in the format [x, y]. Can return: Array of 2 Units or * NothingEnum enumerator. */ gradientStrokeStart: (number[][] | NothingEnum)[]; /** * The alignment to the frame grid or baseline grid. Can return: GridAlignment * enumerator or NothingEnum enumerator. */ gridAlignment: GridAlignment | NothingEnum; /** * The manual gyoudori setting. Can return: Short Integer or NothingEnum * enumerator. */ gridGyoudori: number | NothingEnum; /** * The horizontal scaling applied to the FindTextPreference. Can return: Real * or NothingEnum enumerator. */ horizontalScale: number | NothingEnum; /** * If true, allows the last word in a text column to be hyphenated. Can return: * Boolean or NothingEnum enumerator. */ hyphenateAcrossColumns: boolean | NothingEnum; /** * If true, allows hyphenation in the last word in a paragraph. Note: Valid * only when hyphenation is true. Can return: Boolean or NothingEnum * enumerator. */ hyphenateLastWord: boolean | NothingEnum; /** * If true, ignores optical edge alignment for the paragraph. Can return: * Boolean or NothingEnum enumerator. */ ignoreEdgeAlignment: boolean | NothingEnum; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The number of grid squares in which to arrange the text. . Can return: Short * Integer or NothingEnum enumerator. */ jidori: number | NothingEnum; /** * The paragraph alignment. Can return: Justification enumerator or NothingEnum * enumerator. */ justification: Justification | NothingEnum; /** * Use of Kashidas for justification. Can return: KashidasOptions enumerator or * NothingEnum enumerator. */ kashidas: KashidasOptions | NothingEnum; /** * If true, keeps all lines of the paragraph together. If false, allows * paragraphs to break across pages or columns. Can return: Boolean or * NothingEnum enumerator. */ keepAllLinesTogether: boolean | NothingEnum; /** * The minimum number of lines to keep together in a paragraph before allowing * a page break. Can return: Short Integer (1 - 50) or NothingEnum enumerator. */ keepFirstLines: number | NothingEnum; /** * The minimum number of lines to keep together in a paragraph after a page * break. Can return: Short Integer (1 - 50) or NothingEnum enumerator. */ keepLastLines: number | NothingEnum; /** * If true, keeps a specified number of lines together when the paragraph * breaks across columns or text frames. Can return: Boolean or NothingEnum * enumerator. */ keepLinesTogether: boolean | NothingEnum; /** * If true, forces the rule above the paragraph to remain in the frame bounds. * Note: Valid only when rule above is true. Can return: Boolean or NothingEnum * enumerator. */ keepRuleAboveInFrame: boolean | NothingEnum; /** * The minimum number of lines to keep with the next paragraph. Can return: * Short Integer (0 - 5) or NothingEnum enumerator. */ keepWithNext: number | NothingEnum; /** * If the first line in the paragraph should be kept with the last line of * previous paragraph. Can return: Boolean or NothingEnum enumerator. */ keepWithPrevious: boolean | NothingEnum; /** * The alignment of kenten characters relative to the parent characters. . Can * return: KentenAlignment enumerator or NothingEnum enumerator. */ kentenAlignment: KentenAlignment | NothingEnum; /** * The character set used for the custom kenten character. Note: Valid only * when kenten kind is custom. . Can return: KentenCharacterSet enumerator or * NothingEnum enumerator. */ kentenCharacterSet: KentenCharacterSet | NothingEnum; /** * The character used for kenten. Note: Valid only when kenten kind is custom. * Can return: String or NothingEnum enumerator. */ kentenCustomCharacter: string | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of * kenten characters. Can return: Swatch, String or NothingEnum enumerator. */ kentenFillColor: string | Swatch | NothingEnum; /** * The font to use for kenten characters. Can return: Font, String or * NothingEnum enumerator. */ kentenFont: Font | string | NothingEnum; /** * The size (in points) of kenten characters. Can return: Real or NothingEnum * enumerator. */ kentenFontSize: number | NothingEnum; /** * The font style of kenten characters. Can return: String or NothingEnum * enumerator. */ kentenFontStyle: string | NothingEnum; /** * The style of kenten characters. Can return: KentenCharacter enumerator or * NothingEnum enumerator. */ kentenKind: KentenCharacter | NothingEnum; /** * The method of overprinting the kenten fill. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ kentenOverprintFill: AdornmentOverprint | NothingEnum; /** * The method of overprinting the kenten stroke. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ kentenOverprintStroke: AdornmentOverprint | NothingEnum; /** * The distance between kenten characters and their parent characters. Can * return: Real or NothingEnum enumerator. */ kentenPlacement: number | NothingEnum; /** * The kenten position relative to the parent character. Can return: * RubyKentenPosition enumerator or NothingEnum enumerator. */ kentenPosition: RubyKentenPosition | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * kenten characters. Can return: Swatch, String or NothingEnum enumerator. */ kentenStrokeColor: string | Swatch | NothingEnum; /** * The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100). * Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ kentenStrokeTint: number | NothingEnum; /** * The fill tint (as a percentage) of kenten characters. (Range: 0 to 100). Can * return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ kentenTint: number | NothingEnum; /** * The stroke weight (in points) of kenten characters. Can return: Real or * NothingEnum enumerator. */ kentenWeight: number | NothingEnum; /** * The horizontal size of kenten characters as a percent of the original size. * Can return: Real or NothingEnum enumerator. */ kentenXScale: number | NothingEnum; /** * The vertical size of kenten charachers as a percent of the original size. . * Can return: Real or NothingEnum enumerator. */ kentenYScale: number | NothingEnum; /** * The type of pair kerning. Can return: String or NothingEnum enumerator. */ kerningMethod: string | NothingEnum; /** * The amount of space to add or remove between characters, specified in * thousands of an em. . Can return: Real or NothingEnum enumerator. */ kerningValue: number | NothingEnum; /** * The keyboard direction of the character. Can return: * CharacterDirectionOptions enumerator or NothingEnum enumerator. */ keyboardDirection: CharacterDirectionOptions | NothingEnum; /** * The type of hanging punctuation to allow. Note: Valid only when a kinsoku * set is in effect. Can return: KinsokuHangTypes enumerator or NothingEnum * enumerator. */ kinsokuHangType: KinsokuHangTypes | NothingEnum; /** * The kinsoku set that determines legitimate line breaks. Can return: * KinsokuTable, KinsokuSet enumerator, String or NothingEnum enumerator. */ kinsokuSet: KinsokuSet | KinsokuTable | string | NothingEnum; /** * The type of kinsoku processing for preventing kinsoku characters from * beginning or ending a line. Note: Valid only when a kinsoku set is defined. * Can return: KinsokuType enumerator or NothingEnum enumerator. */ kinsokuType: KinsokuType | NothingEnum; /** * The amount to indent the last line in the paragraph. Can return: Unit or * NothingEnum enumerator. */ lastLineIndent: number | NothingEnum; /** * The leading applied to the text. Can return: Unit, Leading enumerator or * NothingEnum enumerator. */ leading: Leading | number | NothingEnum; /** * The amount of space before each character. Can return: Real or NothingEnum * enumerator. */ leadingAki: number | NothingEnum; /** * The point from which leading is measured from line to line. Can return: * LeadingModel enumerator or NothingEnum enumerator. */ leadingModel: LeadingModel | NothingEnum; /** * The width of the left indent. Can return: Unit or NothingEnum enumerator. */ leftIndent: number | NothingEnum; /** * If true, replaces specific character combinations (e.g., fl, fi) with * ligature characters. Can return: Boolean or NothingEnum enumerator. */ ligatures: boolean | NothingEnum; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. Can return: Real (0 - * 1000) or NothingEnum enumerator. */ miterLimit: number | NothingEnum; /** * The mojikumi table. For information, see mojikumi table defaults. Can * return: MojikumiTable, String, MojikumiTableDefaults enumerator or * NothingEnum enumerator. */ mojikumi: MojikumiTable | MojikumiTableDefaults | string | NothingEnum; /** * If true, keeps the text on the same line. . Can return: Boolean or * NothingEnum enumerator. */ noBreak: boolean | NothingEnum; /** * If true, apply the numbering restart policy. Can return: Boolean or * NothingEnum enumerator. */ numberingApplyRestartPolicy: boolean | NothingEnum; /** * The character style to be used for the number string. Can return: * CharacterStyle, String or NothingEnum enumerator. */ numberingCharacterStyle: CharacterStyle | string | NothingEnum; /** * Continue the numbering at this level. Can return: Boolean or NothingEnum * enumerator. */ numberingContinue: boolean | NothingEnum; /** * The number string expression for numbering. Can return: String or * NothingEnum enumerator. */ numberingExpression: string | NothingEnum; /** * Numbering format options. Can return: NumberingStyle enumerator, String or * NothingEnum enumerator. */ numberingFormat: NumberingStyle | string | NothingEnum; /** * The level of the paragraph. Can return: Long Integer or NothingEnum * enumerator. */ numberingLevel: number | NothingEnum; /** * Numbering restart policies. Can return: NumberingRestartPolicy or * NothingEnum enumerator. */ readonly numberingRestartPolicies: NumberingRestartPolicy | NothingEnum; /** * Determines starting number in a numbered list. Can return: Long Integer or * NothingEnum enumerator. */ numberingStartAt: number | NothingEnum; /** * If true, uses contextual alternate forms in OpenType fonts. Can return: * Boolean or NothingEnum enumerator. */ otfContextualAlternate: boolean | NothingEnum; /** * If true, uses discretionary ligatures in OpenType fonts. Can return: Boolean * or NothingEnum enumerator. */ otfDiscretionaryLigature: boolean | NothingEnum; /** * The figure style in OpenType fonts. Can return: OTFFigureStyle enumerator or * NothingEnum enumerator. */ otfFigureStyle: OTFFigureStyle | NothingEnum; /** * If true, uses fractions in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfFraction: boolean | NothingEnum; /** * If true, switches hiragana fonts, which have different glyphs for horizontal * and vertical. . Can return: Boolean or NothingEnum enumerator. */ otfHVKana: boolean | NothingEnum; /** * If true, use historical forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfHistorical: boolean | NothingEnum; /** * If true, use alternate justification forms in OpenType fonts. Can return: * Boolean or NothingEnum enumerator. */ otfJustificationAlternate: boolean | NothingEnum; /** * If true, uses localized forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfLocale: boolean | NothingEnum; /** * If true, uses mark positioning in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfMark: boolean | NothingEnum; /** * If true, uses ordinals in OpenType fonts. Can return: Boolean or NothingEnum * enumerator. */ otfOrdinal: boolean | NothingEnum; /** * If true, use overlapping swash forms in OpenType fonts. Can return: Boolean * or NothingEnum enumerator. */ otfOverlapSwash: boolean | NothingEnum; /** * If true, kerns according to proportional CJK metrics in OpenType fonts. Can * return: Boolean or NothingEnum enumerator. */ otfProportionalMetrics: boolean | NothingEnum; /** * If true, applies italics to half-width alphanumerics. . Can return: Boolean * or NothingEnum enumerator. */ otfRomanItalics: boolean | NothingEnum; /** * If true, use a slashed zeroes in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfSlashedZero: boolean | NothingEnum; /** * If true, use stretched alternate forms in OpenType fonts. Can return: * Boolean or NothingEnum enumerator. */ otfStretchedAlternate: boolean | NothingEnum; /** * If true, use stylistic alternate forms in OpenType fonts. Can return: * Boolean or NothingEnum enumerator. */ otfStylisticAlternate: boolean | NothingEnum; /** * The stylistic sets to use in OpenType fonts. Can return: Long Integer or * NothingEnum enumerator. */ otfStylisticSets: number | NothingEnum; /** * If true, uses swash forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfSwash: boolean | NothingEnum; /** * If true, uses titling forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfTitling: boolean | NothingEnum; /** * If true, the fill color of the characters will overprint. Can return: * Boolean or NothingEnum enumerator. */ overprintFill: boolean | NothingEnum; /** * If true, the stroke of the characters will overprint. Can return: Boolean or * NothingEnum enumerator. */ overprintStroke: boolean | NothingEnum; /** * Paragraph direction. Can return: ParagraphDirectionOptions enumerator or * NothingEnum enumerator. */ paragraphDirection: ParagraphDirectionOptions | NothingEnum; /** * If true, the gyoudori mode applies to the entire paragraph. If false, the * gyoudori mode applies to each line in the paragraph. Can return: Boolean or * NothingEnum enumerator. */ paragraphGyoudori: boolean | NothingEnum; /** * Paragraph justification. Can return: ParagraphJustificationOptions * enumerator or NothingEnum enumerator. */ paragraphJustification: ParagraphJustificationOptions | NothingEnum; /** * Paragraph kashida width. 0 is none, 1 is short, 2 is medium, 3 is long. Can * return: Real or NothingEnum enumerator. */ paragraphKashidaWidth: number | NothingEnum; /** * The parent of the FindTextPreference (a Application). */ readonly parent: Application; /** * The text size. Can return: Unit or NothingEnum enumerator. */ pointSize: number | NothingEnum; /** * The text position relative to the baseline. Can return: Position enumerator * or NothingEnum enumerator. */ position: Position | NothingEnum; /** * The OpenType positional form. Can return: PositionalForms enumerator or * NothingEnum enumerator. */ positionalForm: PositionalForms | NothingEnum; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, disallows line breaks in numbers. If false, lines can break between * digits in multi-digit numbers. Can return: Boolean or NothingEnum * enumerator. */ rensuuji: boolean | NothingEnum; /** * The width of the right indent. Can return: Unit or NothingEnum enumerator. */ rightIndent: number | NothingEnum; /** * If true, rotates Roman characters in vertical text. Can return: Boolean or * NothingEnum enumerator. */ rotateSingleByteCharacters: boolean | NothingEnum; /** * The ruby alignment. Can return: RubyAlignments enumerator or NothingEnum * enumerator. */ rubyAlignment: RubyAlignments | NothingEnum; /** * If true, auto aligns ruby. Can return: Boolean or NothingEnum enumerator. */ rubyAutoAlign: boolean | NothingEnum; /** * If true, automatically scales ruby to the specified percent of parent text * size. For information on specifying a percent, see ruby parent scaling * percent. . Can return: Boolean or NothingEnum enumerator. */ rubyAutoScaling: boolean | NothingEnum; /** * If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to * fit one em. Can return: Boolean or NothingEnum enumerator. */ rubyAutoTcyAutoScale: boolean | NothingEnum; /** * The number of digits included in auto tcy (tate-chuu-yoko) in ruby. Can * return: Short Integer or NothingEnum enumerator. */ rubyAutoTcyDigits: number | NothingEnum; /** * If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. Can * return: Boolean or NothingEnum enumerator. */ rubyAutoTcyIncludeRoman: boolean | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby * characters. Can return: Swatch, String or NothingEnum enumerator. */ rubyFill: string | Swatch | NothingEnum; /** * The font applied to ruby characters. Can return: Font, String or NothingEnum * enumerator. */ rubyFont: Font | string | NothingEnum; /** * The size (in points) of ruby characters. Can return: Real or NothingEnum * enumerator. */ rubyFontSize: number | NothingEnum; /** * The font style of ruby characters. Can return: String or NothingEnum * enumerator. */ rubyFontStyle: string | NothingEnum; /** * If true, uses OpenType Pro fonts for ruby. Can return: Boolean or * NothingEnum enumerator. */ rubyOpenTypePro: boolean | NothingEnum; /** * If true, constrains ruby overhang to the specified amount. For information * on specifying an amount, see ruby parent overhang amount. . Can return: * Boolean or NothingEnum enumerator. */ rubyOverhang: boolean | NothingEnum; /** * The method of overprinting the ruby fill. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ rubyOverprintFill: AdornmentOverprint | NothingEnum; /** * The method of overprinting the ruby stroke. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ rubyOverprintStroke: AdornmentOverprint | NothingEnum; /** * The amount by which ruby characters can overhang the parent text. Can * return: RubyOverhang enumerator or NothingEnum enumerator. */ rubyParentOverhangAmount: RubyOverhang | NothingEnum; /** * The amount (as a percentage) to scale the parent text size to determine the * ruby text size. Can return: Real or NothingEnum enumerator. */ rubyParentScalingPercent: number | NothingEnum; /** * The ruby spacing relative to the parent text. . Can return: * RubyParentSpacing enumerator or NothingEnum enumerator. */ rubyParentSpacing: RubyParentSpacing | NothingEnum; /** * The position of ruby characters relative to the parent text. Can return: * RubyKentenPosition enumerator or NothingEnum enumerator. */ rubyPosition: RubyKentenPosition | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * ruby characters. Can return: Swatch, String or NothingEnum enumerator. */ rubyStroke: string | Swatch | NothingEnum; /** * The stroke tint (as a percentage) of ruby characters. Can return: Real or * NothingEnum enumerator. */ rubyStrokeTint: number | NothingEnum; /** * The tint (as a percentage) of the ruby fill color. (Range: 0 to 100). Can * return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ rubyTint: number | NothingEnum; /** * The ruby type. Can return: RubyTypes enumerator or NothingEnum enumerator. */ rubyType: RubyTypes | NothingEnum; /** * The stroke weight (in points) of ruby characters. Can return: Real or * NothingEnum enumerator. */ rubyWeight: number | NothingEnum; /** * The amount of horizontal space between ruby and parent characters. Can * return: Real or NothingEnum enumerator. */ rubyXOffset: number | NothingEnum; /** * The horizontal size of ruby characters, specified as a percent of the * original size. Can return: Real or NothingEnum enumerator. */ rubyXScale: number | NothingEnum; /** * The amount of vertical space between ruby and parent characters. Can return: * Real or NothingEnum enumerator. */ rubyYOffset: number | NothingEnum; /** * The vertical size of ruby characters, specified as a percent of the original * size. Can return: Real or NothingEnum enumerator. */ rubyYScale: number | NothingEnum; /** * The space between paragraphs using same style. Can return: Unit, Spacing * enumerator or NothingEnum enumerator. */ sameParaStyleSpacing: Spacing | number | NothingEnum; /** * If true, the line changes size when characters are scaled. . Can return: * Boolean or NothingEnum enumerator. */ scaleAffectsLineHeight: boolean | NothingEnum; /** * If true, applies shatai rotation. Can return: Boolean or NothingEnum * enumerator. */ shataiAdjustRotation: boolean | NothingEnum; /** * If true, adjusts shatai tsume. Can return: Boolean or NothingEnum * enumerator. */ shataiAdjustTsume: boolean | NothingEnum; /** * The shatai lens angle (in degrees). Can return: Real or NothingEnum * enumerator. */ shataiDegreeAngle: number | NothingEnum; /** * The amount (as a percentage) of shatai obliquing to apply. Can return: Real * or NothingEnum enumerator. */ shataiMagnification: number | NothingEnum; /** * The alignment to use for lines that contain a single word. Can return: * SingleWordJustification enumerator or NothingEnum enumerator. */ singleWordJustification: SingleWordJustification | NothingEnum; /** * The skew angle of the FindTextPreference. Can return: Real or NothingEnum * enumerator. */ skew: number | NothingEnum; /** * The height of the paragraph space below. Can return: Unit or NothingEnum * enumerator. */ spaceAfter: number | NothingEnum; /** * The height of the paragraph space above. Can return: Unit or NothingEnum * enumerator. */ spaceBefore: number | NothingEnum; /** * The minimum space after a span or a split column. Can return: Unit or * NothingEnum enumerator. */ spanColumnMinSpaceAfter: number | NothingEnum; /** * The minimum space before a span or a split column. Can return: Unit or * NothingEnum enumerator. */ spanColumnMinSpaceBefore: number | NothingEnum; /** * Whether a paragraph should be a single column, span columns or split * columns. Can return: SpanColumnTypeOptions enumerator or NothingEnum * enumerator. */ spanColumnType: SpanColumnTypeOptions | NothingEnum; /** * The number of columns a paragraph spans or the number of split columns. Can * return: Short Integer (1 - 40), SpanColumnCountOptions enumerator or * NothingEnum enumerator. */ spanSplitColumnCount: number | SpanColumnCountOptions | NothingEnum; /** * The inside gutter if the paragraph splits columns. Can return: Unit or * NothingEnum enumerator. */ splitColumnInsideGutter: number | NothingEnum; /** * The outside gutter if the paragraph splits columns. Can return: Unit or * NothingEnum enumerator. */ splitColumnOutsideGutter: number | NothingEnum; /** * The location at which to start the paragraph. Can return: StartParagraph * enumerator or NothingEnum enumerator. */ startParagraph: StartParagraph | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the * strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator. */ strikeThroughColor: string | Swatch | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator. */ strikeThroughGapColor: string | Swatch | NothingEnum; /** * If true, the gap color of the strikethrough stroke will overprint. Note: * Valid when strike through type is not solid. Can return: Boolean or * NothingEnum enumerator. */ strikeThroughGapOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 * to 100) Note: Valid when strike through type is not solid. Can return: Real * or NothingEnum enumerator. * @remarks Range: 0 to 100 */ strikeThroughGapTint: number | NothingEnum; /** * The amount by which to offset the strikethrough stroke from the text * baseline. Can return: Unit or NothingEnum enumerator. */ strikeThroughOffset: number | NothingEnum; /** * If true, the strikethrough stroke will overprint. Can return: Boolean or * NothingEnum enumerator. */ strikeThroughOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100). * Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ strikeThroughTint: number | NothingEnum; /** * The stroke type of the strikethrough stroke. Can return: StrokeStyle, String * or NothingEnum enumerator. */ strikeThroughType: string | StrokeStyle | NothingEnum; /** * The stroke weight of the strikethrough stroke. Can return: Unit or * NothingEnum enumerator. */ strikeThroughWeight: number | NothingEnum; /** * If true, draws a strikethrough line through the text. Can return: Boolean or * NothingEnum enumerator. */ strikeThru: boolean | NothingEnum; /** * The stroke alignment applied to the text. Can return: TextStrokeAlign * enumerator or NothingEnum enumerator. */ strokeAlignment: TextStrokeAlign | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink), applied as a stroke color, * to search for or change to. Can return: String or NothingEnum enumerator. * Can also accept: Swatch. */ strokeColor: string | Swatch | NothingEnum; /** * The tint (as a percentage) of the stroke color of the FindTextPreference. * (To specify a tint percentage, use a number in the range of 0 to 100; to use * the inherited or overridden value, use -1.). Can return: Real or NothingEnum * enumerator. * @remarks Range: 0 to 100 */ strokeTint: number | NothingEnum; /** * The stroke weight applied to the characters of the text. Can return: Unit or * NothingEnum enumerator. */ strokeWeight: number | NothingEnum; /** * If true, makes the character horizontal in vertical text. Can return: * Boolean or NothingEnum enumerator. */ tatechuyoko: boolean | NothingEnum; /** * The horizontal offset for horizontal characters in vertical text. Can * return: Real or NothingEnum enumerator. */ tatechuyokoXOffset: number | NothingEnum; /** * The vertical offset for horizontal characters in vertical text. Can return: * Real or NothingEnum enumerator. */ tatechuyokoYOffset: number | NothingEnum; /** * The amount by which to loosen or tighten a block of text, specified in * thousands of an em. Can return: Real or NothingEnum enumerator. */ tracking: number | NothingEnum; /** * The amount of space after each character. Can return: Real or NothingEnum * enumerator. */ trailingAki: number | NothingEnum; /** * If true, ideographic spaces will not wrap to the next line like text * characters. Can return: Boolean or NothingEnum enumerator. */ treatIdeographicSpaceAsSpace: boolean | NothingEnum; /** * The amount of horizontal character compression. Can return: Real or * NothingEnum enumerator. */ tsume: number | NothingEnum; /** * If true, underlines the text. Can return: Boolean or NothingEnum enumerator. */ underline: boolean | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the underline * stroke. . Can return: Swatch, String or NothingEnum enumerator. */ underlineColor: string | Swatch | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * underline stroke. Note: Valid when underline type is not solid. Can return: * Swatch, String or NothingEnum enumerator. */ underlineGapColor: string | Swatch | NothingEnum; /** * If true, the gap color of the underline stroke will overprint. Can return: * Boolean or NothingEnum enumerator. */ underlineGapOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the gap color of the underline stroke. (Range: * 0 to 100) Note: Valid when underline type is not solid. Can return: Real or * NothingEnum enumerator. * @remarks Range: 0 to 100 */ underlineGapTint: number | NothingEnum; /** * The amount by which to offset the underline from the text baseline. Can * return: Unit or NothingEnum enumerator. */ underlineOffset: number | NothingEnum; /** * If true, the underline stroke color will overprint. Can return: Boolean or * NothingEnum enumerator. */ underlineOverprint: boolean | NothingEnum; /** * The underline stroke tint (as a percentage). (Range: 0 to 100). Can return: * Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ underlineTint: number | NothingEnum; /** * The stroke type of the underline stroke. Can return: StrokeStyle, String or * NothingEnum enumerator. */ underlineType: string | StrokeStyle | NothingEnum; /** * The stroke weight of the underline stroke. Can return: Unit or NothingEnum * enumerator. */ underlineWeight: number | NothingEnum; /** * The vertical scaling applied to the FindTextPreference. Can return: Real or * NothingEnum enumerator. */ verticalScale: number | NothingEnum; /** * If true, turns on warichu. Can return: Boolean or NothingEnum enumerator. */ warichu: boolean | NothingEnum; /** * The warichu alignment. Can return: WarichuAlignment enumerator or * NothingEnum enumerator. */ warichuAlignment: WarichuAlignment | NothingEnum; /** * The minimum number of characters allowed after a line break. . Can return: * Short Integer or NothingEnum enumerator. */ warichuCharsAfterBreak: number | NothingEnum; /** * The minimum number of characters allowed before a line break. Can return: * Short Integer or NothingEnum enumerator. */ warichuCharsBeforeBreak: number | NothingEnum; /** * The gap between lines of warichu characters. Can return: Real or NothingEnum * enumerator. */ warichuLineSpacing: number | NothingEnum; /** * The number of lines of warichu within a single normal line. Can return: * Short Integer or NothingEnum enumerator. */ warichuLines: number | NothingEnum; /** * The amount (as a percentage) to scale parent text size to determine warichu * size. Can return: Real or NothingEnum enumerator. */ warichuSize: number | NothingEnum; /** * The x (horizontal) offset for diacritic adjustment. Can return: Real or * NothingEnum enumerator. */ xOffsetDiacritic: number | NothingEnum; /** * The y (vertical) offset for diacritic adjustment. Can return: Real or * NothingEnum enumerator. */ yOffsetDiacritic: number | NothingEnum; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FindTextPreference[]; /** * If true, Nth design axis of variable font is hidden. * @param nthAxisIndex Index of design axis. */ isNthDesignAxisHidden(nthAxisIndex: number): boolean; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Set Nth design axis of a variable font. * @param nthAxisIndex Index of design axis. * @param nthAxisValue Value of nth design axis. */ setNthDesignAxis(nthAxisIndex: number, nthAxisValue: number): void; /** * Generates a string which, if executed, will return the FindTextPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Find transliterate preferences. */ declare class FindTransliteratePreference extends Preference { /** * If true, words unassociated with a hyphenation dictionary can break to the * next line on any character. Can return: Boolean or NothingEnum enumerator. */ allowArbitraryHyphenation: boolean | NothingEnum; /** * The character style to search for or change to. Can return: String or * NothingEnum enumerator. Can also accept: CharacterStyle. */ appliedCharacterStyle: CharacterStyle | string | NothingEnum; /** * The font applied to the FindTransliteratePreference, specified as either a * font object or the name of font family. Can return: Font, String or * NothingEnum enumerator. */ appliedFont: Font | string | NothingEnum; /** * The language to search for or change to. Can return: String or NothingEnum * enumerator. Can also accept: Language or LanguageWithVendors. */ appliedLanguage: Language | string | LanguageWithVendors | NothingEnum; /** * The list to be part of. Can return: NumberingList, String or NothingEnum * enumerator. */ appliedNumberingList: NumberingList | string | NothingEnum; /** * The paragraph style to search for or change to. Can return: String or * NothingEnum enumerator. Can also accept: ParagraphStyle. */ appliedParagraphStyle: ParagraphStyle | string | NothingEnum; /** * The percent of the type size to use for auto leading. (Range: 0 to 500). Can * return: Real or NothingEnum enumerator. * @remarks Range: 0 to 500 */ autoLeading: number | NothingEnum; /** * The number of half-width characters at or below which the characters * automatically run horizontally in vertical text. Can return: Short Integer * or NothingEnum enumerator. */ autoTcy: number | NothingEnum; /** * If true, auto tcy includes Roman characters. Can return: Boolean or * NothingEnum enumerator. */ autoTcyIncludeRoman: boolean | NothingEnum; /** * If true or set to an enumeration value, balances ragged lines. Note: Not * valid with a single-line text composer. Can return: Boolean, * BalanceLinesStyle enumerator or NothingEnum enumerator. */ balanceRaggedLines: BalanceLinesStyle | boolean | NothingEnum; /** * The baseline shift applied to the text. Can return: Unit or NothingEnum * enumerator. */ baselineShift: number | NothingEnum; /** * Bullet character. Can return: Bullet or NothingEnum enumerator. */ readonly bulletChar: Bullet | NothingEnum; /** * The alignment of the bullet character. Can return: ListAlignment enumerator * or NothingEnum enumerator. */ bulletsAlignment: ListAlignment | NothingEnum; /** * List type for bullets and numbering. Can return: ListType enumerator or * NothingEnum enumerator. */ bulletsAndNumberingListType: ListType | NothingEnum; /** * The character style to be used for the text after string. Can return: * CharacterStyle, String or NothingEnum enumerator. */ bulletsCharacterStyle: CharacterStyle | string | NothingEnum; /** * The text after string expression for bullets. Can return: String or * NothingEnum enumerator. */ bulletsTextAfter: string | NothingEnum; /** * If true, adds the double period (..), ellipse (...), and double hyphen (--) * to the selected kinsoku set. Note: Valid only when a kinsoku set is in * effect. Can return: Boolean or NothingEnum enumerator. */ bunriKinshi: boolean | NothingEnum; /** * The capitalization scheme. Can return: Capitalization enumerator or * NothingEnum enumerator. */ capitalization: Capitalization | NothingEnum; /** * The alignment of small characters to the largest character in the line. Can * return: CharacterAlignment enumerator or NothingEnum enumerator. */ characterAlignment: CharacterAlignment | NothingEnum; /** * The rotation angle (in degrees) of individual characters. Note: The rotation * is counterclockwise. Can return: Real or NothingEnum enumerator. */ characterRotation: number | NothingEnum; /** * If true, uses grid tracking to track non-Roman characters in CJK grids. Can * return: Boolean or NothingEnum enumerator. */ cjkGridTracking: boolean | NothingEnum; /** * The text composer to use to compose the text. Can return: String or * NothingEnum enumerator. */ composer: string | NothingEnum; /** * Value of Design Axes. Can return: Array of Reals or NothingEnum enumerator. */ designAxes: (number[] | NothingEnum)[]; /** * The number of characters to drop cap. Can return: Short Integer (0 - 150) or * NothingEnum enumerator. */ dropCapCharacters: number | NothingEnum; /** * The number of lines to drop cap. Can return: Short Integer (0 - 25) or * NothingEnum enumerator. */ dropCapLines: number | NothingEnum; /** * Details about the drop cap based on the glyph outlines. 1 = left side * bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid. * Can return: Long Integer or NothingEnum enumerator. */ dropcapDetail: number | NothingEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink), applied as a fill color, * to search for or change to. Can return: String or NothingEnum enumerator. * Can also accept: Swatch. */ fillColor: string | Swatch | NothingEnum; /** * The tint (as a percentage) of the fill color of the * FindTransliteratePreference. (To specify a tint percentage, use a number in * the range of 0 to 100; to use the inherited or overridden value, use -1.). * Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ fillTint: number | NothingEnum; /** * The character type to find. Can return: * FindChangeTransliterateCharacterTypes enumerator or NothingEnum enumerator. */ findCharacterType: FindChangeTransliterateCharacterTypes | NothingEnum; /** * The amount to indent the first line. Can return: Unit or NothingEnum * enumerator. */ firstLineIndent: number | NothingEnum; /** * The name of the font style. Can return: String or NothingEnum enumerator. */ fontStyle: string | NothingEnum; /** * The glyph variant to substitute for standard glyphs. Can return: * AlternateGlyphForms enumerator or NothingEnum enumerator. */ glyphForm: AlternateGlyphForms | NothingEnum; /** * The angle of a linear gradient applied to the fill of the text. (Range: -180 * to 180). Can return: Real or NothingEnum enumerator. */ gradientFillAngle: number | NothingEnum; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the text. Can return: Real or NothingEnum enumerator. */ gradientFillLength: number | NothingEnum; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the text, in the format [x, y]. Can return: Array of 2 Units or * NothingEnum enumerator. */ gradientFillStart: (number[][] | NothingEnum)[]; /** * The angle of a linear gradient applied to the stroke of the text. (Range: * -180 to 180). Can return: Real or NothingEnum enumerator. */ gradientStrokeAngle: number | NothingEnum; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the text. Can return: Real or NothingEnum enumerator. */ gradientStrokeLength: number | NothingEnum; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the text, in the format [x, y]. Can return: Array of 2 Units or * NothingEnum enumerator. */ gradientStrokeStart: (number[][] | NothingEnum)[]; /** * The alignment to the frame grid or baseline grid. Can return: GridAlignment * enumerator or NothingEnum enumerator. */ gridAlignment: GridAlignment | NothingEnum; /** * The manual gyoudori setting. Can return: Short Integer or NothingEnum * enumerator. */ gridGyoudori: number | NothingEnum; /** * The horizontal scaling applied to the FindTransliteratePreference. Can * return: Real or NothingEnum enumerator. */ horizontalScale: number | NothingEnum; /** * If true, allows the last word in a text column to be hyphenated. Can return: * Boolean or NothingEnum enumerator. */ hyphenateAcrossColumns: boolean | NothingEnum; /** * If true, allows hyphenation in the last word in a paragraph. Note: Valid * only when hyphenation is true. Can return: Boolean or NothingEnum * enumerator. */ hyphenateLastWord: boolean | NothingEnum; /** * If true, ignores optical edge alignment for the paragraph. Can return: * Boolean or NothingEnum enumerator. */ ignoreEdgeAlignment: boolean | NothingEnum; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The number of grid squares in which to arrange the text. . Can return: Short * Integer or NothingEnum enumerator. */ jidori: number | NothingEnum; /** * The paragraph alignment. Can return: Justification enumerator or NothingEnum * enumerator. */ justification: Justification | NothingEnum; /** * If true, keeps all lines of the paragraph together. If false, allows * paragraphs to break across pages or columns. Can return: Boolean or * NothingEnum enumerator. */ keepAllLinesTogether: boolean | NothingEnum; /** * The minimum number of lines to keep together in a paragraph before allowing * a page break. Can return: Short Integer (1 - 50) or NothingEnum enumerator. */ keepFirstLines: number | NothingEnum; /** * The minimum number of lines to keep together in a paragraph after a page * break. Can return: Short Integer (1 - 50) or NothingEnum enumerator. */ keepLastLines: number | NothingEnum; /** * If true, keeps a specified number of lines together when the paragraph * breaks across columns or text frames. Can return: Boolean or NothingEnum * enumerator. */ keepLinesTogether: boolean | NothingEnum; /** * If true, forces the rule above the paragraph to remain in the frame bounds. * Note: Valid only when rule above is true. Can return: Boolean or NothingEnum * enumerator. */ keepRuleAboveInFrame: boolean | NothingEnum; /** * The minimum number of lines to keep with the next paragraph. Can return: * Short Integer (0 - 5) or NothingEnum enumerator. */ keepWithNext: number | NothingEnum; /** * The alignment of kenten characters relative to the parent characters. . Can * return: KentenAlignment enumerator or NothingEnum enumerator. */ kentenAlignment: KentenAlignment | NothingEnum; /** * The character set used for the custom kenten character. Note: Valid only * when kenten kind is custom. . Can return: KentenCharacterSet enumerator or * NothingEnum enumerator. */ kentenCharacterSet: KentenCharacterSet | NothingEnum; /** * The character used for kenten. Note: Valid only when kenten kind is custom. * Can return: String or NothingEnum enumerator. */ kentenCustomCharacter: string | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of * kenten characters. Can return: Swatch, String or NothingEnum enumerator. */ kentenFillColor: string | Swatch | NothingEnum; /** * The font to use for kenten characters. Can return: Font, String or * NothingEnum enumerator. */ kentenFont: Font | string | NothingEnum; /** * The size (in points) of kenten characters. Can return: Real or NothingEnum * enumerator. */ kentenFontSize: number | NothingEnum; /** * The font style of kenten characters. Can return: String or NothingEnum * enumerator. */ kentenFontStyle: string | NothingEnum; /** * The style of kenten characters. Can return: KentenCharacter enumerator or * NothingEnum enumerator. */ kentenKind: KentenCharacter | NothingEnum; /** * The method of overprinting the kenten fill. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ kentenOverprintFill: AdornmentOverprint | NothingEnum; /** * The method of overprinting the kenten stroke. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ kentenOverprintStroke: AdornmentOverprint | NothingEnum; /** * The distance between kenten characters and their parent characters. Can * return: Real or NothingEnum enumerator. */ kentenPlacement: number | NothingEnum; /** * The kenten position relative to the parent character. Can return: * RubyKentenPosition enumerator or NothingEnum enumerator. */ kentenPosition: RubyKentenPosition | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * kenten characters. Can return: Swatch, String or NothingEnum enumerator. */ kentenStrokeColor: string | Swatch | NothingEnum; /** * The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100). * Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ kentenStrokeTint: number | NothingEnum; /** * The fill tint (as a percentage) of kenten characters. (Range: 0 to 100). Can * return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ kentenTint: number | NothingEnum; /** * The stroke weight (in points) of kenten characters. Can return: Real or * NothingEnum enumerator. */ kentenWeight: number | NothingEnum; /** * The horizontal size of kenten characters as a percent of the original size. * Can return: Real or NothingEnum enumerator. */ kentenXScale: number | NothingEnum; /** * The vertical size of kenten charachers as a percent of the original size. . * Can return: Real or NothingEnum enumerator. */ kentenYScale: number | NothingEnum; /** * The type of pair kerning. Can return: String or NothingEnum enumerator. */ kerningMethod: string | NothingEnum; /** * The amount of space to add or remove between characters, specified in * thousands of an em. . Can return: Real or NothingEnum enumerator. */ kerningValue: number | NothingEnum; /** * The type of hanging punctuation to allow. Note: Valid only when a kinsoku * set is in effect. Can return: KinsokuHangTypes enumerator or NothingEnum * enumerator. */ kinsokuHangType: KinsokuHangTypes | NothingEnum; /** * The kinsoku set that determines legitimate line breaks. Can return: * KinsokuTable, KinsokuSet enumerator, String or NothingEnum enumerator. */ kinsokuSet: KinsokuSet | KinsokuTable | string | NothingEnum; /** * The type of kinsoku processing for preventing kinsoku characters from * beginning or ending a line. Note: Valid only when a kinsoku set is defined. * Can return: KinsokuType enumerator or NothingEnum enumerator. */ kinsokuType: KinsokuType | NothingEnum; /** * The amount to indent the last line in the paragraph. Can return: Unit or * NothingEnum enumerator. */ lastLineIndent: number | NothingEnum; /** * The leading applied to the text. Can return: Unit, Leading enumerator or * NothingEnum enumerator. */ leading: Leading | number | NothingEnum; /** * The amount of space before each character. Can return: Real or NothingEnum * enumerator. */ leadingAki: number | NothingEnum; /** * The point from which leading is measured from line to line. Can return: * LeadingModel enumerator or NothingEnum enumerator. */ leadingModel: LeadingModel | NothingEnum; /** * The width of the left indent. Can return: Unit or NothingEnum enumerator. */ leftIndent: number | NothingEnum; /** * If true, replaces specific character combinations (e.g., fl, fi) with * ligature characters. Can return: Boolean or NothingEnum enumerator. */ ligatures: boolean | NothingEnum; /** * The mojikumi table. For information, see mojikumi table defaults. Can * return: MojikumiTable, String, MojikumiTableDefaults enumerator or * NothingEnum enumerator. */ mojikumi: MojikumiTable | MojikumiTableDefaults | string | NothingEnum; /** * If true, keeps the text on the same line. . Can return: Boolean or * NothingEnum enumerator. */ noBreak: boolean | NothingEnum; /** * The alignment of the number. Can return: ListAlignment enumerator or * NothingEnum enumerator. */ numberingAlignment: ListAlignment | NothingEnum; /** * If true, apply the numbering restart policy. Can return: Boolean or * NothingEnum enumerator. */ numberingApplyRestartPolicy: boolean | NothingEnum; /** * The character style to be used for the number string. Can return: * CharacterStyle, String or NothingEnum enumerator. */ numberingCharacterStyle: CharacterStyle | string | NothingEnum; /** * Continue the numbering at this level. Can return: Boolean or NothingEnum * enumerator. */ numberingContinue: boolean | NothingEnum; /** * The number string expression for numbering. Can return: String or * NothingEnum enumerator. */ numberingExpression: string | NothingEnum; /** * Numbering format options. Can return: NumberingStyle enumerator, String or * NothingEnum enumerator. */ numberingFormat: NumberingStyle | string | NothingEnum; /** * The level of the paragraph. Can return: Long Integer or NothingEnum * enumerator. */ numberingLevel: number | NothingEnum; /** * Determines starting number in a numbered list. Can return: Long Integer or * NothingEnum enumerator. */ numberingStartAt: number | NothingEnum; /** * If true, uses contextual alternate forms in OpenType fonts. Can return: * Boolean or NothingEnum enumerator. */ otfContextualAlternate: boolean | NothingEnum; /** * If true, uses discretionary ligatures in OpenType fonts. Can return: Boolean * or NothingEnum enumerator. */ otfDiscretionaryLigature: boolean | NothingEnum; /** * The figure style in OpenType fonts. Can return: OTFFigureStyle enumerator or * NothingEnum enumerator. */ otfFigureStyle: OTFFigureStyle | NothingEnum; /** * If true, uses fractions in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfFraction: boolean | NothingEnum; /** * If true, switches hiragana fonts, which have different glyphs for horizontal * and vertical. . Can return: Boolean or NothingEnum enumerator. */ otfHVKana: boolean | NothingEnum; /** * If true, use historical forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfHistorical: boolean | NothingEnum; /** * If true, uses localized forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfLocale: boolean | NothingEnum; /** * If true, uses mark positioning in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfMark: boolean | NothingEnum; /** * If true, uses ordinals in OpenType fonts. Can return: Boolean or NothingEnum * enumerator. */ otfOrdinal: boolean | NothingEnum; /** * If true, kerns according to proportional CJK metrics in OpenType fonts. Can * return: Boolean or NothingEnum enumerator. */ otfProportionalMetrics: boolean | NothingEnum; /** * If true, applies italics to half-width alphanumerics. . Can return: Boolean * or NothingEnum enumerator. */ otfRomanItalics: boolean | NothingEnum; /** * If true, use a slashed zeroes in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfSlashedZero: boolean | NothingEnum; /** * The stylistic sets to use in OpenType fonts. Can return: Long Integer or * NothingEnum enumerator. */ otfStylisticSets: number | NothingEnum; /** * If true, uses swash forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfSwash: boolean | NothingEnum; /** * If true, uses titling forms in OpenType fonts. Can return: Boolean or * NothingEnum enumerator. */ otfTitling: boolean | NothingEnum; /** * If true, the fill color of the characters will overprint. Can return: * Boolean or NothingEnum enumerator. */ overprintFill: boolean | NothingEnum; /** * If true, the stroke of the characters will overprint. Can return: Boolean or * NothingEnum enumerator. */ overprintStroke: boolean | NothingEnum; /** * If true, the gyoudori mode applies to the entire paragraph. If false, the * gyoudori mode applies to each line in the paragraph. Can return: Boolean or * NothingEnum enumerator. */ paragraphGyoudori: boolean | NothingEnum; /** * The parent of the FindTransliteratePreference (a Application). */ readonly parent: Application; /** * The text size. Can return: Unit or NothingEnum enumerator. */ pointSize: number | NothingEnum; /** * The text position relative to the baseline. Can return: Position enumerator * or NothingEnum enumerator. */ position: Position | NothingEnum; /** * The OpenType positional form. Can return: PositionalForms enumerator or * NothingEnum enumerator. */ positionalForm: PositionalForms | NothingEnum; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, disallows line breaks in numbers. If false, lines can break between * digits in multi-digit numbers. Can return: Boolean or NothingEnum * enumerator. */ rensuuji: boolean | NothingEnum; /** * The width of the right indent. Can return: Unit or NothingEnum enumerator. */ rightIndent: number | NothingEnum; /** * If true, rotates Roman characters in vertical text. Can return: Boolean or * NothingEnum enumerator. */ rotateSingleByteCharacters: boolean | NothingEnum; /** * The ruby alignment. Can return: RubyAlignments enumerator or NothingEnum * enumerator. */ rubyAlignment: RubyAlignments | NothingEnum; /** * If true, auto aligns ruby. Can return: Boolean or NothingEnum enumerator. */ rubyAutoAlign: boolean | NothingEnum; /** * If true, automatically scales ruby to the specified percent of parent text * size. For information on specifying a percent, see ruby parent scaling * percent. . Can return: Boolean or NothingEnum enumerator. */ rubyAutoScaling: boolean | NothingEnum; /** * If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to * fit one em. Can return: Boolean or NothingEnum enumerator. */ rubyAutoTcyAutoScale: boolean | NothingEnum; /** * The number of digits included in auto tcy (tate-chuu-yoko) in ruby. Can * return: Short Integer or NothingEnum enumerator. */ rubyAutoTcyDigits: number | NothingEnum; /** * If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. Can * return: Boolean or NothingEnum enumerator. */ rubyAutoTcyIncludeRoman: boolean | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby * characters. Can return: Swatch, String or NothingEnum enumerator. */ rubyFill: string | Swatch | NothingEnum; /** * The font applied to ruby characters. Can return: Font, String or NothingEnum * enumerator. */ rubyFont: Font | string | NothingEnum; /** * The size (in points) of ruby characters. Can return: Real or NothingEnum * enumerator. */ rubyFontSize: number | NothingEnum; /** * The font style of ruby characters. Can return: String or NothingEnum * enumerator. */ rubyFontStyle: string | NothingEnum; /** * If true, uses OpenType Pro fonts for ruby. Can return: Boolean or * NothingEnum enumerator. */ rubyOpenTypePro: boolean | NothingEnum; /** * If true, constrains ruby overhang to the specified amount. For information * on specifying an amount, see ruby parent overhang amount. . Can return: * Boolean or NothingEnum enumerator. */ rubyOverhang: boolean | NothingEnum; /** * The method of overprinting the ruby fill. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ rubyOverprintFill: AdornmentOverprint | NothingEnum; /** * The method of overprinting the ruby stroke. Can return: AdornmentOverprint * enumerator or NothingEnum enumerator. */ rubyOverprintStroke: AdornmentOverprint | NothingEnum; /** * The amount by which ruby characters can overhang the parent text. Can * return: RubyOverhang enumerator or NothingEnum enumerator. */ rubyParentOverhangAmount: RubyOverhang | NothingEnum; /** * The amount (as a percentage) to scale the parent text size to determine the * ruby text size. Can return: Real or NothingEnum enumerator. */ rubyParentScalingPercent: number | NothingEnum; /** * The ruby spacing relative to the parent text. . Can return: * RubyParentSpacing enumerator or NothingEnum enumerator. */ rubyParentSpacing: RubyParentSpacing | NothingEnum; /** * The position of ruby characters relative to the parent text. Can return: * RubyKentenPosition enumerator or NothingEnum enumerator. */ rubyPosition: RubyKentenPosition | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * ruby characters. Can return: Swatch, String or NothingEnum enumerator. */ rubyStroke: string | Swatch | NothingEnum; /** * The stroke tint (as a percentage) of ruby characters. Can return: Real or * NothingEnum enumerator. */ rubyStrokeTint: number | NothingEnum; /** * The tint (as a percentage) of the ruby fill color. (Range: 0 to 100). Can * return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ rubyTint: number | NothingEnum; /** * The ruby type. Can return: RubyTypes enumerator or NothingEnum enumerator. */ rubyType: RubyTypes | NothingEnum; /** * The stroke weight (in points) of ruby characters. Can return: Real or * NothingEnum enumerator. */ rubyWeight: number | NothingEnum; /** * The amount of horizontal space between ruby and parent characters. Can * return: Real or NothingEnum enumerator. */ rubyXOffset: number | NothingEnum; /** * The horizontal size of ruby characters, specified as a percent of the * original size. Can return: Real or NothingEnum enumerator. */ rubyXScale: number | NothingEnum; /** * The amount of vertical space between ruby and parent characters. Can return: * Real or NothingEnum enumerator. */ rubyYOffset: number | NothingEnum; /** * The vertical size of ruby characters, specified as a percent of the original * size. Can return: Real or NothingEnum enumerator. */ rubyYScale: number | NothingEnum; /** * The space between paragraphs using same style. Can return: Unit, Spacing * enumerator or NothingEnum enumerator. */ sameParaStyleSpacing: Spacing | number | NothingEnum; /** * If true, the line changes size when characters are scaled. . Can return: * Boolean or NothingEnum enumerator. */ scaleAffectsLineHeight: boolean | NothingEnum; /** * If true, applies shatai rotation. Can return: Boolean or NothingEnum * enumerator. */ shataiAdjustRotation: boolean | NothingEnum; /** * If true, adjusts shatai tsume. Can return: Boolean or NothingEnum * enumerator. */ shataiAdjustTsume: boolean | NothingEnum; /** * The shatai lens angle (in degrees). Can return: Real or NothingEnum * enumerator. */ shataiDegreeAngle: number | NothingEnum; /** * The amount (as a percentage) of shatai obliquing to apply. Can return: Real * or NothingEnum enumerator. */ shataiMagnification: number | NothingEnum; /** * The alignment to use for lines that contain a single word. Can return: * SingleWordJustification enumerator or NothingEnum enumerator. */ singleWordJustification: SingleWordJustification | NothingEnum; /** * The skew angle of the FindTransliteratePreference. Can return: Real or * NothingEnum enumerator. */ skew: number | NothingEnum; /** * The height of the paragraph space below. Can return: Unit or NothingEnum * enumerator. */ spaceAfter: number | NothingEnum; /** * The height of the paragraph space above. Can return: Unit or NothingEnum * enumerator. */ spaceBefore: number | NothingEnum; /** * The location at which to start the paragraph. Can return: StartParagraph * enumerator or NothingEnum enumerator. */ startParagraph: StartParagraph | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the * strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator. */ strikeThroughColor: string | Swatch | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * strikethrough stroke. Can return: Swatch, String or NothingEnum enumerator. */ strikeThroughGapColor: string | Swatch | NothingEnum; /** * If true, the gap color of the strikethrough stroke will overprint. Note: * Valid when strike through type is not solid. Can return: Boolean or * NothingEnum enumerator. */ strikeThroughGapOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 * to 100) Note: Valid when strike through type is not solid. Can return: Real * or NothingEnum enumerator. * @remarks Range: 0 to 100 */ strikeThroughGapTint: number | NothingEnum; /** * The amount by which to offset the strikethrough stroke from the text * baseline. Can return: Unit or NothingEnum enumerator. */ strikeThroughOffset: number | NothingEnum; /** * If true, the strikethrough stroke will overprint. Can return: Boolean or * NothingEnum enumerator. */ strikeThroughOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100). * Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ strikeThroughTint: number | NothingEnum; /** * The stroke type of the strikethrough stroke. Can return: StrokeStyle, String * or NothingEnum enumerator. */ strikeThroughType: string | StrokeStyle | NothingEnum; /** * The stroke weight of the strikethrough stroke. Can return: Unit or * NothingEnum enumerator. */ strikeThroughWeight: number | NothingEnum; /** * If true, draws a strikethrough line through the text. Can return: Boolean or * NothingEnum enumerator. */ strikeThru: boolean | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink), applied as a stroke color, * to search for or change to. Can return: String or NothingEnum enumerator. * Can also accept: Swatch. */ strokeColor: string | Swatch | NothingEnum; /** * The tint (as a percentage) of the stroke color of the * FindTransliteratePreference. (To specify a tint percentage, use a number in * the range of 0 to 100; to use the inherited or overridden value, use -1.). * Can return: Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ strokeTint: number | NothingEnum; /** * The stroke weight applied to the characters of the text. Can return: Unit or * NothingEnum enumerator. */ strokeWeight: number | NothingEnum; /** * If true, makes the character horizontal in vertical text. Can return: * Boolean or NothingEnum enumerator. */ tatechuyoko: boolean | NothingEnum; /** * The horizontal offset for horizontal characters in vertical text. Can * return: Real or NothingEnum enumerator. */ tatechuyokoXOffset: number | NothingEnum; /** * The vertical offset for horizontal characters in vertical text. Can return: * Real or NothingEnum enumerator. */ tatechuyokoYOffset: number | NothingEnum; /** * The amount by which to loosen or tighten a block of text, specified in * thousands of an em. Can return: Real or NothingEnum enumerator. */ tracking: number | NothingEnum; /** * The amount of space after each character. Can return: Real or NothingEnum * enumerator. */ trailingAki: number | NothingEnum; /** * If true, ideographic spaces will not wrap to the next line like text * characters. Can return: Boolean or NothingEnum enumerator. */ treatIdeographicSpaceAsSpace: boolean | NothingEnum; /** * The amount of horizontal character compression. Can return: Real or * NothingEnum enumerator. */ tsume: number | NothingEnum; /** * If true, underlines the text. Can return: Boolean or NothingEnum enumerator. */ underline: boolean | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the underline * stroke. . Can return: Swatch, String or NothingEnum enumerator. */ underlineColor: string | Swatch | NothingEnum; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * underline stroke. Note: Valid when underline type is not solid. Can return: * Swatch, String or NothingEnum enumerator. */ underlineGapColor: string | Swatch | NothingEnum; /** * If true, the gap color of the underline stroke will overprint. Can return: * Boolean or NothingEnum enumerator. */ underlineGapOverprint: boolean | NothingEnum; /** * The tint (as a percentage) of the gap color of the underline stroke. (Range: * 0 to 100) Note: Valid when underline type is not solid. Can return: Real or * NothingEnum enumerator. * @remarks Range: 0 to 100 */ underlineGapTint: number | NothingEnum; /** * The amount by which to offset the underline from the text baseline. Can * return: Unit or NothingEnum enumerator. */ underlineOffset: number | NothingEnum; /** * If true, the underline stroke color will overprint. Can return: Boolean or * NothingEnum enumerator. */ underlineOverprint: boolean | NothingEnum; /** * The underline stroke tint (as a percentage). (Range: 0 to 100). Can return: * Real or NothingEnum enumerator. * @remarks Range: 0 to 100 */ underlineTint: number | NothingEnum; /** * The stroke type of the underline stroke. Can return: StrokeStyle, String or * NothingEnum enumerator. */ underlineType: string | StrokeStyle | NothingEnum; /** * The stroke weight of the underline stroke. Can return: Unit or NothingEnum * enumerator. */ underlineWeight: number | NothingEnum; /** * The vertical scaling applied to the FindTransliteratePreference. Can return: * Real or NothingEnum enumerator. */ verticalScale: number | NothingEnum; /** * If true, turns on warichu. Can return: Boolean or NothingEnum enumerator. */ warichu: boolean | NothingEnum; /** * The warichu alignment. Can return: WarichuAlignment enumerator or * NothingEnum enumerator. */ warichuAlignment: WarichuAlignment | NothingEnum; /** * The minimum number of characters allowed after a line break. . Can return: * Short Integer or NothingEnum enumerator. */ warichuCharsAfterBreak: number | NothingEnum; /** * The minimum number of characters allowed before a line break. Can return: * Short Integer or NothingEnum enumerator. */ warichuCharsBeforeBreak: number | NothingEnum; /** * The gap between lines of warichu characters. Can return: Real or NothingEnum * enumerator. */ warichuLineSpacing: number | NothingEnum; /** * The number of lines of warichu within a single normal line. Can return: * Short Integer or NothingEnum enumerator. */ warichuLines: number | NothingEnum; /** * The amount (as a percentage) to scale parent text size to determine warichu * size. Can return: Real or NothingEnum enumerator. */ warichuSize: number | NothingEnum; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FindTransliteratePreference[]; /** * If true, Nth design axis of variable font is hidden. * @param nthAxisIndex Index of design axis. */ isNthDesignAxisHidden(nthAxisIndex: number): boolean; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Set Nth design axis of a variable font. * @param nthAxisIndex Index of design axis. * @param nthAxisValue Value of nth design axis. */ setNthDesignAxis(nthAxisIndex: number, nthAxisValue: number): void; /** * Generates a string which, if executed, will return the * FindTransliteratePreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Starting point options for the first baseline of text. */ declare enum FirstBaseline { /** * The tallest character in the font falls below the top inset of the object. */ ASCENT_OFFSET = 1296135023, /** * The tops of upper case letters touch the top inset of the object. */ CAP_HEIGHT = 1296255087, /** * The text em box height is the distance between the baseline of the text and * the top inset of the object. */ EMBOX_HEIGHT = 1296386159, /** * Uses the value specified for minimum first baseline offset as the distance * between the baseline of the text and the top inset of the object. */ FIXED_HEIGHT = 1313228911, /** * The text leading value defines the distance between the baseline of the text * and the top inset of the object. */ LEADING_OFFSET = 1296852079, /** * The tops of lower case letters touch the top inset of the object. */ X_HEIGHT = 1299728495, } /** * Options for fitting to dimension. */ declare enum FitDimension { /** * Fit to 1024x768 dimension. */ FIT1024X768 = 1718906726, /** * Fit to 1240x620 dimension. */ FIT1240X620 = 1718908023, /** * Fit to 1280x800 dimension. */ FIT1280X800 = 1718906725, /** * Fit to 600x300 dimension. */ FIT600X300 = 1718907764, /** * Fit to 640x480 dimension. */ FIT640X480 = 1718907753, /** * Fit to 760x420 dimension. */ FIT760X420 = 1718907750, /** * Fit to 800x600 dimension. */ FIT800X600 = 1718904179, /** * Fit to 984x588 dimension. */ FIT984X588 = 1718906470, } /** * Fit method settings. */ declare enum FitMethodSettings { /** * Fit to given scale percentage. */ FIT_GIVEN_SCALE_PERCENTAGE = 1684304739, /** * Fit to given width and height. */ FIT_GIVEN_WIDTH_AND_HEIGHT = 1684305768, /** * Fit to predefined settings. */ FIT_PREDEFINED_SETTINGS = 1684301427, } /** * Options for fitting content to a frame. */ declare enum FitOptions { /** * Applies the current frame fitting options to the frame and content. Before * using this, do confirm that the expected Frame Fitting Options are applied * on the frame. For example, the act of placing an image in a frame set to * 'Fit Content Proportionally' can change the crop settings in the Frame * Fitting Options, which would then get applied for any subsequent image * placement when this API is called. */ APPLY_FRAME_FITTING_OPTIONS = 1634100847, /** * Centers content in the frame; preserves the frame size as well as content * size and proportions. Note: If the content is larger than the frame, content * around the edges is obscured. */ CENTER_CONTENT = 1667591779, /** * Selects best crop region of the content for the frame based on Adobe Sensei. * Note: Preserves frame size but might scale the content size. */ CONTENT_AWARE_FIT = 1667327593, /** * Resizes content to fit the frame. Note: Content that is a different size * than the frame appears stretched or squeezed. */ CONTENT_TO_FRAME = 1668575078, /** * Resizes content to fill the frame while perserving the proportions of the * content. If the content and frame have different proportions, some of the * content is obscured by the bounding box of the frame. */ FILL_PROPORTIONALLY = 1718185072, /** * Resizes the frame so it fits the content. */ FRAME_TO_CONTENT = 1718906723, /** * Resizes content to fit the frame while preserving content proportions. If * the content and frame have different proportions, some empty space appears * in the frame. */ PROPORTIONALLY = 1668247152, } /** * Options for fitting content to a frame. */ declare enum Fitting { /** * Selects best crop region of the content for the frame based on Adobe Sensei. * Note: Preserves frame size but might scale the content size. If this fitting * is set, centerImage property is turned-off. */ CONTENT_AWARE_FITTING = 1684882241, /** * Resizes content to fill the frame while preserving content proportions. If * the content and frame have different proportions, some content is obscured * by the bounding box of the frame. */ FILL_PROPORTIONAL = 1684883056, /** * Resizes content to fit the frame. Note: Content that is a different size * than the frame appears stretched or squeezed. */ FIT_CONTENT_TO_FRAME = 1684883043, /** * Resizes the frame to fit the content. */ FIT_FRAME_TO_CONTENT = 1684883046, /** * Apply the frame fitting based on existing setting applied on the orginal * frame. */ HONOUR_EXISTING_STYLE = 1684883539, /** * Preserves the original sizes of the frame and the content. Note: Content * that is larger than the frame is obscured around the edges. */ PRESERVE_SIZES = 1684885619, /** * Resizes content to fit the frame while preserving content proportions. If * the content and frame have different proportions, some empty space occurs in * the frame. */ PROPORTIONAL = 1684885618, } /** * Rasterization options. */ declare enum FlattenerLevel { /** * Keeps as much artwork as possible vector data. */ HIGH = 1701726313, /** * Rasterizes all artwork. */ LOW = 1701727351, /** * Rasterizes a medium amount of artwork. */ MEDIUM = 1701727588, /** * Rasterizes more than a medium amount of artwork. */ MEDIUM_HIGH = 1718373704, /** * Rasterizes almost all artwork. */ MEDIUM_LOW = 1718373708, } /** * Transparency flattener preferences. */ declare class FlattenerPreference extends Preference { /** * If true, ensures that the boundaries between vector and rasterized artwork * fall along object paths. */ clipComplexRegions: boolean; /** * If true, converts all strokes to outlines and ensures that stroke widths * remain constant during flattening. Note: Can cause thin strokes to appear * slightly thicker than their original width. Affects all strokes, not only * strokes involved in the transparency. */ convertAllStrokesToOutlines: boolean; /** * If true, converts all text to outlines and discards all type glyph * information on spreads with transparency; ensures that the width of text * strokes remains constant during flattening. Note: Can cause small fonts to * appear slightly thicker when viewed in Acrobat or printed on low-quality * desktop printers, but does not affect type quality when printed on * high-resolution printers or imagesetters. */ convertAllTextToOutlines: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The resolution for gradients rasterized as a result of flattening and for * drop shadow and feathers when printed or exported. (Range: 0 to 1200) Note: * Resolutions higher than 300 ppi increase file size and printing time but * generally do not improve the image quality. * @remarks Range: 0 to 1200 */ gradientAndMeshResolution: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The resolution for vector objects rasterized as a result of flattening. * (Range: 1 to 9600) For information, see raster vector balance. * @remarks Range: 1 to 9600 */ lineArtAndTextResolution: number; /** * The parent of the FlattenerPreference (a Spread). */ readonly parent: Spread; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The amount of vector artwork to rasterize during flattening, specified as an * enumerator or as a percentage in the range 0 to 100. Can return: * FlattenerLevel enumerator or Real (0 - 100). */ rasterVectorBalance: FlattenerLevel | number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FlattenerPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the FlattenerPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A preset that contains transparency flattener properties. */ declare class FlattenerPreset { /** * If true, ensures that the boundaries between vector and rasterized artwork * fall along object paths. */ clipComplexRegions: boolean; /** * If true, converts all strokes to outlines and ensures that stroke widths * remain constant during flattening. Note: Can cause thin strokes to appear * slightly thicker than their original width. Affects all strokes, not only * strokes involved in the transparency. */ convertAllStrokesToOutlines: boolean; /** * If true, converts all text to outlines and discards all type glyph * information on spreads with transparency; ensures that the width of text * strokes remains constant during flattening. Note: Can cause small fonts to * appear slightly thicker when viewed in Acrobat or printed on low-quality * desktop printers, but does not affect type quality when printed on * high-resolution printers or imagesetters. */ convertAllTextToOutlines: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The resolution for gradients rasterized as a result of flattening and for * drop shadow and feathers when printed or exported. (Range: 0 to 1200) Note: * Resolutions higher than 300 ppi increase file size and printing time but * generally do not improve the image quality. * @remarks Range: 0 to 1200 */ gradientAndMeshResolution: number; /** * The unique ID of the FlattenerPreset. */ readonly id: number; /** * The index of the FlattenerPreset within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The resolution for vector objects rasterized as a result of flattening. * (Range: 1 to 9600) For information, see raster vector balance. * @remarks Range: 1 to 9600 */ lineArtAndTextResolution: number; /** * The name of the FlattenerPreset. */ name: string; /** * The parent of the FlattenerPreset (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The amount of vector artwork to rasterize during flattening, specified as an * enumerator or as a percentage in the range 0 to 100. Can return: * FlattenerLevel enumerator or Real (0 - 100). */ rasterVectorBalance: FlattenerLevel | number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the FlattenerPreset. */ duplicate(): FlattenerPreset; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FlattenerPreset[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the FlattenerPreset. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the FlattenerPreset. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of transparency flattener presets. */ declare class FlattenerPresets { /** Returns the FlattenerPreset with the specified index or name. */ [index: number]: FlattenerPreset; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new FlattenerPreset. * @param withProperties Initial values for properties of the new FlattenerPreset (Optional) */ add(withProperties?: Object): FlattenerPreset; /** * Returns any FlattenerPreset in the collection. */ anyItem(): FlattenerPreset; /** * Displays the number of elements in the FlattenerPreset. */ count(): number; /** * Returns every FlattenerPreset in the collection. */ everyItem(): FlattenerPreset; /** * Returns the first FlattenerPreset in the collection. */ firstItem(): FlattenerPreset; /** * Returns the FlattenerPreset with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): FlattenerPreset; /** * Returns the FlattenerPreset with the specified ID. * @param id The ID. */ itemByID(id: number): FlattenerPreset; /** * Returns the FlattenerPreset with the specified name. * @param name The name. */ itemByName(name: string): FlattenerPreset; /** * Returns the FlattenerPresets within the specified range. * @param from The FlattenerPreset, index, or name at the beginning of the range. Can accept: FlattenerPreset, Long Integer or String. * @param to The FlattenerPreset, index, or name at the end of the range. Can accept: FlattenerPreset, Long Integer or String. */ itemByRange(from: FlattenerPreset | number | string, to: FlattenerPreset | number | string): FlattenerPreset[]; /** * Returns the last FlattenerPreset in the collection. */ lastItem(): FlattenerPreset; /** * Returns the middle FlattenerPreset in the collection. */ middleItem(): FlattenerPreset; /** * Returns the FlattenerPreset whose index follows the specified * FlattenerPreset in the collection. * @param obj The FlattenerPreset whose index comes before the desired FlattenerPreset. */ nextItem(obj: FlattenerPreset): FlattenerPreset; /** * Returns the FlattenerPreset with the index previous to the specified index. * @param obj The index of the FlattenerPreset that follows the desired FlattenerPreset. */ previousItem(obj: FlattenerPreset): FlattenerPreset; /** * Generates a string which, if executed, will return the FlattenerPreset. */ toSource(): string; } /** * Whether the flex container clips its content */ declare enum FlexClipsContent { /** * Clip content */ CLIP = 1715684204, /** * Do not clip content */ DONT_CLIP = 1715684451, } /** * The direction of the flex container */ declare enum FlexDirection { /** * Column direction */ FLEX_COLUMN = 1715749740, /** * Column reverse direction */ FLEX_COLUMN_REVERSE = 1715749746, /** * Row direction */ FLEX_ROW = 1715753591, /** * Row reverse direction */ FLEX_ROW_REVERSE = 1715753586, } /** * Auto Enum attribute to be used for properties accepting Auto. */ declare enum FlexEnum { /** * Flex Auto */ FLEX_AUTO = 1716994420, } /** * Options for applying flex layout attributes to flex object. */ declare class FlexLayoutAttributeOption extends Preference { /** * Aligns a flex container's lines within when there is extra space in the * cross-axis. Can return: FlexPosition enumerator or FlexEnum enumerator. */ alignContent: FlexPosition | FlexEnum; /** * Defines the default behavior for how flex items are laid out along the cross * axis. Can return: FlexPosition enumerator or FlexEnum enumerator. */ alignItems: FlexPosition | FlexEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The direction of the flex container */ flexDirection: FlexDirection; /** * The column gap between flex items * @remarks Measurement unit — also accepts a string such as "12mm". */ flexGapColumn: number | string; /** * The row gap between flex items * @remarks Measurement unit — also accepts a string such as "12mm". */ flexGapRow: number | string; /** * The height behavior of the flex container. Can return: FlexWidthHeightMode * enumerator or FlexEnum enumerator. */ flexHeightMode: FlexWidthHeightMode | FlexEnum; /** * The bottom padding of the flex container * @remarks Measurement unit — also accepts a string such as "12mm". */ flexPaddingBottom: number | string; /** * The left padding of the flex container * @remarks Measurement unit — also accepts a string such as "12mm". */ flexPaddingLeft: number | string; /** * The right padding of the flex container * @remarks Measurement unit — also accepts a string such as "12mm". */ flexPaddingRight: number | string; /** * The top padding of the flex container * @remarks Measurement unit — also accepts a string such as "12mm". */ flexPaddingTop: number | string; /** * The width behavior of the flex container. Can return: FlexWidthHeightMode * enumerator or FlexEnum enumerator. */ flexWidthMode: FlexWidthHeightMode | FlexEnum; /** * Whether flex items are forced onto one line or can wrap onto multiple lines */ flexWrap: FlexWrap; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * Defines how the browser distributes space between and around content items * along the main-axis. Can return: FlexPosition enumerator or FlexSpacing * enumerator. */ justifyContent: FlexPosition | FlexSpacing; /** * The parent of the FlexLayoutAttributeOption (a ObjectStyle). */ readonly parent: ObjectStyle; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FlexLayoutAttributeOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * FlexLayoutAttributeOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A flex object. */ declare class FlexObject extends PageItem { /** * Indicates whether the FlexObject has been flipped independently of its * parent object and, if yes, the direction in which the FlexObject was * flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the FlexObject relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the FlexObject relative to its containing object. * (Range: -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the FlexObject relative to its containing object. * (Range: -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the FlexObject relative to its containing object. */ absoluteVerticalScale: number; /** * Aligns a flex container's lines within when there is extra space in the * cross-axis. Can return: FlexPosition enumerator or FlexEnum enumerator. */ alignContent: FlexPosition | FlexEnum; /** * Defines the default behavior for how flex items are laid out along the cross * axis. Can return: FlexPosition enumerator or FlexEnum enumerator. */ alignItems: FlexPosition | FlexEnum; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the FlexObject. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the FlexObject. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * Anchored object settings. */ readonly anchoredObjectSettings: AnchoredObjectSetting; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the FlexObject. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the FlexObject. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the FlexObject. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * A collection of buttons. */ readonly buttons: Buttons; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * Transparency settings for the content of the FlexObject. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the FlexObject. */ endJoin: EndJoin; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * FlexObject. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the FlexObject's fill color. (To specify a * tint percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the FlexObject. */ readonly fillTransparencySettings: FillTransparencySetting; /** * The direction of the flex container */ flexDirection: FlexDirection; /** * The column gap between flex items * @remarks Measurement unit — also accepts a string such as "12mm". */ flexGapColumn: number | string; /** * The row gap between flex items * @remarks Measurement unit — also accepts a string such as "12mm". */ flexGapRow: number | string; /** * The height behavior of the flex container. Can return: FlexWidthHeightMode * enumerator or FlexEnum enumerator. */ flexHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The bottom padding of the flex container * @remarks Measurement unit — also accepts a string such as "12mm". */ flexPaddingBottom: number | string; /** * The left padding of the flex container * @remarks Measurement unit — also accepts a string such as "12mm". */ flexPaddingLeft: number | string; /** * The right padding of the flex container * @remarks Measurement unit — also accepts a string such as "12mm". */ flexPaddingRight: number | string; /** * The top padding of the flex container * @remarks Measurement unit — also accepts a string such as "12mm". */ flexPaddingTop: number | string; /** * The width behavior of the flex container. Can return: FlexWidthHeightMode * enumerator or FlexEnum enumerator. */ flexWidthMode: FlexWidthHeightMode | FlexEnum; /** * Whether flex items are forced onto one line or can wrap onto multiple lines */ flexWrap: FlexWrap; /** * The direction in which to flip the printed image. */ flip: Flip; /** * A collection of form fields. */ readonly formFields: FormFields; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the FlexObject excluding the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the FlexObject. * (Range: -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the FlexObject. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the FlexObject, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the FlexObject. * (Range: -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the FlexObject. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the FlexObject, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * A collection of groups. */ readonly groups: Groups; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the FlexObject. */ horizontalScale: number; /** * The unique ID of the FlexObject. */ readonly id: number; /** * The index of the FlexObject within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the FlexObject is on. */ itemLayer: Layer; /** * Defines how the browser distributes space between and around content items * along the main-axis. Can return: FlexPosition enumerator or FlexSpacing * enumerator. */ justifyContent: FlexPosition | FlexSpacing; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * Display performance options for the FlexObject. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the FlexObject is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * The name of the FlexObject. */ name: string; /** * If true, the FlexObject does not print. */ nonprinting: boolean; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the FlexObject's fill color overprints any underlying objects. If * false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the FlexObject's stroke color overprints any underlying objects. If * false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the FlexObject (a FlexObject, Spread or MasterSpread). */ readonly parent: Spread | FlexObject | MasterSpread; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of paths. */ readonly paths: Paths; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the FlexObject. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the FlexObject. (Range: -360 to 360) */ shearAngle: number; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The stroke alignment applied to the FlexObject. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the FlexObject. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the FlexObject. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the FlexObject's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the FlexObject. */ verticalScale: number; /** * If true, the FlexObject is visible. */ visible: boolean; /** * The bounds of the FlexObject including the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * Dispatched after a FlexObject is placed. This event bubbles. This event is * not cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a FlexObject is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Add page item to flex container at the end. * @param addPageItem The page item to be added. */ addFlexObject(addPageItem: PageItem): void; /** * Add a page item after the specified page item. * @param referencePageItem Add the page item after this page item. * @param addPageItem The page item to be added. */ addPageItemAfter(referencePageItem: PageItem, addPageItem: PageItem): void; /** * Add a page item at the specified index. * @param positionIndex Add the page item at this index. * @param addPageItem The page item to be added. */ addPageItemAt(positionIndex: number, addPageItem: PageItem): void; /** * Add a page item at the end of the container. * @param addPageItem The page item to be added. */ addPageItemAtEnd(addPageItem: PageItem): void; /** * Add a page item at the start of the container. * @param addPageItem The page item to be added. */ addPageItemAtStart(addPageItem: PageItem): void; /** * Add a page item before the specified page item. * @param referencePageItem Add the page item before this page item. * @param addPageItem The page item to be added. */ addPageItemBefore(referencePageItem: PageItem, addPageItem: PageItem): void; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the FlexObject's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the FlexObject that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the FlexObject. Transformations include * rotation, scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the FlexObject to a different shape. * @param given The FlexObject's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new FlexObject. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new FlexObject. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new FlexObject. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new FlexObject. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new FlexObject. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the FlexObject at the specified location or offset. * @param to The location of the new FlexObject, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new FlexObject from the original FlexObject's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the FlexObject. * @param given The axis around which to flip the FlexObject. * @param around The point around which to flip the FlexObject. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FlexObject[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the FlexObject to a new location. Note: Either the 'to' or 'by' * parameter is required; if both parameters are defined, only the to value is * used. * @param to The new location of the FlexObject,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the FlexObject relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the FlexObject. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the FlexObject in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new FlexObject (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the FlexObject. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the FlexObject using the last transformation performed on any * object. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgain(): string[]; /** * Transforms the FlexObject using the last transformation performed on any * FlexObject. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgainIndividually(): string[]; /** * Transforms the FlexObject using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the FlexObject using the last sequence of transformations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * A collection of flex objects. */ declare class FlexObjects { /** Returns the FlexObject with the specified index or name. */ [index: number]: FlexObject; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new flex object. * @param flexDescription The flex description to create the object from. (Optional) * @param flexDestinationPage The page on which to create the object. (Optional) * @param destinationLayer The layer on which to create the Object. Uses active document layer by default (Optional) * @param placePoint The point where to place the object (only applicable if page is provided) (Optional) * @param withProperties Initial values for properties of the new FlexObject (Optional) */ add(flexDescription?: string, flexDestinationPage?: Page, destinationLayer?: Layer, placePoint?: (number | string)[], withProperties?: Object): FlexObject; /** * Returns any FlexObject in the collection. */ anyItem(): FlexObject; /** * Displays the number of elements in the FlexObject. */ count(): number; /** * Returns every FlexObject in the collection. */ everyItem(): FlexObject; /** * Returns the first FlexObject in the collection. */ firstItem(): FlexObject; /** * Returns the FlexObject with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): FlexObject; /** * Returns the FlexObject with the specified ID. * @param id The ID. */ itemByID(id: number): FlexObject; /** * Returns the FlexObject with the specified name. * @param name The name. */ itemByName(name: string): FlexObject; /** * Returns the FlexObjects within the specified range. * @param from The FlexObject, index, or name at the beginning of the range. Can accept: FlexObject, Long Integer or String. * @param to The FlexObject, index, or name at the end of the range. Can accept: FlexObject, Long Integer or String. */ itemByRange(from: FlexObject | number | string, to: FlexObject | number | string): FlexObject[]; /** * Returns the last FlexObject in the collection. */ lastItem(): FlexObject; /** * Returns the middle FlexObject in the collection. */ middleItem(): FlexObject; /** * Returns the FlexObject whose index follows the specified FlexObject in the * collection. * @param obj The FlexObject whose index comes before the desired FlexObject. */ nextItem(obj: FlexObject): FlexObject; /** * Returns the FlexObject with the index previous to the specified index. * @param obj The index of the FlexObject that follows the desired FlexObject. */ previousItem(obj: FlexObject): FlexObject; /** * Generates a string which, if executed, will return the FlexObject. */ toSource(): string; } /** * Flex Start, Flex Center or Flex End enum. */ declare enum FlexPosition { /** * Center items */ FLEX_CENTER = 1632191348, /** * Align items at the end */ FLEX_END = 1632192101, /** * Align items at the start */ FLEX_START = 1632192115, } /** * Specifies the spacing to be used to justify contents inside flex container. */ declare enum FlexSpacing { /** * Space around items */ FLEX_SPACE_AROUND = 1782797153, /** * Space between items */ FLEX_SPACE_BETWEEN = 1782797154, /** * Space evenly between items */ FLEX_SPACE_EVENLY = 1782797157, } /** * The width or height behavior of the flex container or content item */ declare enum FlexWidthHeightMode { /** * Fill available width or height */ FLEX_FILL = 1716995692, /** * Fixed width or height */ FLEX_FIXED = 1716995704, } /** * Whether flex items are forced onto one line or can wrap onto multiple lines */ declare enum FlexWrap { /** * No wrapping */ NO_WRAP = 1716997751, /** * Wrap items */ WRAP = 1717000048, /** * Wrap items in reverse */ WRAP_REVERSE = 1717000050, } /** * Flip direction options. */ declare enum Flip { /** * Horizontal and vertical flip (same as rotate 180) */ BOTH = 1651471464, /** * Flips the printed image horizontally. */ HORIZONTAL = 1752134266, /** * Flips the printed image horizontally and vertically (same as rotate 180). */ HORIZONTAL_AND_VERTICAL = 1215977068, /** * The printed image is not flipped. */ NONE = 1852796517, /** * Flips the printed image vertically. */ VERTICAL = 1986359924, } /** * Options for flipping or unflipping text relative to the path. */ declare enum FlipValues { /** * Flips the text across the path. */ FLIPPED = 2036755568, /** * No flip effect applied. */ NOT_FLIPPED = 1852206192, /** * Undefined flip effect. */ UNDEFINED_FLIP_VALUE = 1969646704, } /** * Options for specifying the position of a movie's display window. */ declare enum FloatingWindowPosition { /** * Positions the window in the center of the screen. */ CENTER = 1298359662, /** * Positions the window on the left side of the screen midway between the top * and bottom. */ CENTER_LEFT = 1298361446, /** * Positions the window on the right side of the screen midway between the top * and bottom. */ CENTER_RIGHT = 1298362996, /** * Positions the window in the lower left corner of the screen. */ LOWER_LEFT = 1298951270, /** * Positions the window at the bottom of the screen midway between the left and * right edges. */ LOWER_MIDDLE = 1298951524, /** * Positions the window in the lower right corner of the screen. */ LOWER_RIGHT = 1298952820, /** * Positions the window in the upper left corner of the screen. */ UPPER_LEFT = 1668183118, /** * Positions the window at the top of the screen midway between the left and * right edges. */ UPPER_MIDDLE = 1299541348, /** * Positions the window in the upper right corner of the screen. */ UPPER_RIGHT = 1299542644, } /** * The size of the movie's floating window. Valid only when floating window is * true. */ declare enum FloatingWindowSize { /** * The floating window is the movie's original display size. */ FULL = 1298560364, /** * The floating window fills the entire screen. */ MAX = 1299014008, /** * The floating window is one fifth the length and height of the movie's * original display size. */ ONE_FIFTH = 1298557286, /** * The floating window is one fourth the length and height of the movie's * original display size. */ ONE_FOURTH = 1298558834, /** * The floating window is one half the length and height of the movie's * original display size. */ ONE_HALF = 1298686316, /** * The floating window is quadruple the length and height of the movie's * original display size. */ QUADRUPLE = 1299281272, /** * The floating window is triple the length and height of the movie's original * display size. */ TRIPLE = 1299477112, /** * The floating window is twice the length and height of the movie's original * display size. */ TWICE = 1299476344, } /** * Represents a file-system folder or directory in a platform-independent * manner. */ declare class Folder { /** * The full path name for the referenced folder in URI notation. */ readonly absoluteURI: string; /** * When true, the object refers to a file system alias or shortcut. */ readonly alias: boolean; /** * The folder containing the application data for all users. */ static readonly appData: Folder; /** * In Mac OS, a Folder object for the folder containing the bundle of the * running application. */ static readonly appPackage: Folder; /** * A Folder object for the folder containing common files for all programs * installed by the user. */ static readonly commonFiles: Folder; /** * The creation date of the referenced folder, or null if the object does not * refer to a folder on disk. */ readonly created: Date; /** * A Folder object for the current folder. */ static current: Folder; /** * A Folder object for the folder that contains the user’s desktop. */ static readonly desktop: Folder; /** * The localized name portion of the absolute URI for the referenced folder, * without the path specification. */ readonly displayName: string; /** * A message describing the most recent file system error. */ error: string; /** * When true, this object refers to a folder that currently exists in the file * system. */ readonly exists: boolean; /** * The name of the current file system. */ static readonly fs: string; /** * The platform-specific name of the referenced folder as a full path name. */ readonly fsName: string; /** * The full path name for the referenced folder in URI notation. . */ readonly fullName: string; /** * The date of the referenced folder's last modification, or null if the object * does not refer to a folder on disk. */ readonly modified: Date; /** * A folder pointing to the user's My Documents folder. */ static readonly myDocuments: Folder; /** * The folder name portion of the absolute URI for the referenced file, without * the path specification. */ readonly name: string; /** * TThe Folder object for the folder that contains this folder, or null if this * object refers to the root folder of a volume. */ readonly parent: Folder; /** * The path portion of the object absolute URI for the referenced file, without * the folder name. */ readonly path: string; /** * The path name for the referenced folder in URI notation, relative to the * current folder. */ readonly relativeURI: string; /** * A Folder object for the folder containing the executable image of the * running application. */ static readonly startup: Folder; /** * A Folder object for the folder containing the operating system files. */ static readonly system: Folder; /** * A Folder object for the default folder for temporary files. */ static readonly temp: Folder; /** * A Folder object for the folder containing deleted items. On Windows, the * trash folder is a virtual folder containing a database; therefore, the * property value is null on Windows. */ static readonly trash: Folder; /** * A Folder object for the folder containing the user's application data. */ static readonly userData: Folder; /** * Creates and returns a new Folder object referring to a given file-system * location. * @param path The absolute or relative path to the folder associated with this object, specified in URI format. */ constructor(path?: string); /** * Changes the path specification of the referenced folder. * @param path A string containing the new path, absolute or relative to the current folder. */ changePath(path: string): boolean; /** * Creates a folder at the location given by this object's path property. */ create(): boolean; /** * Decodes a UTF-8 encoded string as required by RFC 2396, and returns the * decoded string. * @param uri The UTF-8 string to decode. */ decode(uri: string): string; /** * Encodes a string as required by RFC 2396, and returns the encoded string. * @param name The string to encode. */ encode(name: string): string; /** * Opens this folder in the platform-specific file browser (as if it had been * double-clicked in the file browser). */ execute(): boolean; /** * Retrieves the contents of this folder, filtered by the supplied mask. * @param mask A search mask for file names, specified as a string or a function. */ getFiles(mask: any): any[]; /** * Retrieves and returns the path for this file, relative to the specified base * path, in URI notation. * @param basePath A base path in URI notation. */ getRelativeURI(basePath?: string): string; /** * Reports whether a given encoding is available. * @param name The encoding name. */ isEncodingAvailable(name: string): boolean; /** * Deletes the folder associated with this object from disk immediately, * without moving it to the system trash. */ remove(): boolean; /** * Renames the associated folder. * @param newName The new folder name, with no path information. */ rename(newName: string): boolean; /** * Attempts to resolve the file-system alias or shortcut that this object * refers to. */ resolve(): Folder; /** * Opens the built-in platform-specific file-browsing dialog, and creates a new * File or Folder object for the selected file or folder. * @param prompt The prompt text, if the dialog allows a prompt. */ selectDialog(prompt: string): Folder; /** * Opens the built-in platform-specific file-browsing dialog, and creates a new * File or Folder object for the selected file or folder. * @param prompt The prompt text, if the dialog allows a prompt. */ selectDlg(prompt: string): Folder; /** * Creates and returns a serialized string representation of this object. */ toSource(): string; /** * Converts this object to a string. */ toString(): string; } /** * The folio binding direction option. */ declare enum FolioBindingDirectionOptions { /** * left-edge binding. */ LEFT = 1835102828, /** * right-edge binding. */ RIGHT = 1835102834, } /** * The folio orientation option. */ declare enum FolioOrientationOptions { /** * automatic - determine orientation based on the orientation of the mini * folios. */ AUTO = 1635019116, /** * landscape orientation only. */ LANDSCAPE = 2003395685, /** * portrait orientation only. */ PORTRAIT = 1751738216, /** * both portrait and landscape orientations. */ PORTRAIT_AND_LANDSCAPE = 1699303266, } /** * Follow-shape options for directional feathering. */ declare enum FollowShapeModeOptions { /** * Feathers all edges that face the specified angle. */ ALL_EDGES = 1701721442, /** * Feathers only the leading edge facing the specified angle. */ LEADING_EDGE = 1701721441, /** * Disables shape following and uses the rectangular bounds of the object. */ NONE = 1852796517, } /** * A font. */ declare class Font { /** * If true, the font can be embedded. */ readonly allowEditableEmbedding: boolean; /** * If true, the font can be converted to outlines. */ readonly allowOutlines: boolean; /** * If true, the font can be embedded in a PDF document. */ readonly allowPDFEmbedding: boolean; /** * If true, the can font be printed. */ readonly allowPrinting: boolean; /** * The name of design axes in variable font. */ readonly designAxesName: string[]; /** * Range of design axes in variable font. Can return: Array of Arrays of 2 * Reals. */ readonly designAxesRange: number[][][][]; /** * Value of design axes in variable font. */ readonly designAxesValues: number[]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The name of the font family */ readonly fontFamily: string; /** * The name of the font style. */ readonly fontStyleName: string; /** * The native name of the font style. */ readonly fontStyleNameNative: string; /** * The type of font. */ readonly fontType: FontTypes; /** * The full font name. */ readonly fullName: string; /** * The full native name of the font. */ readonly fullNameNative: string; /** * The index of the Font within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The full path to the Font. */ readonly location: string; /** * The name of the Font. */ readonly name: string; /** * Number of design axes in variable font. */ readonly numDesignAxes: number; /** * The ordering of a CID font. */ readonly ordering: string; /** * The parent of the Font (a Document or Application). */ readonly parent: Application | Document; /** * The platform font name. */ readonly platformName: string; /** * The PostScript name of the font. */ readonly postscriptName: string; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The registry of a CID font. */ readonly registry: string; /** * If true, the font allows only restricted printing. */ readonly restrictedPrinting: boolean; /** * The status of the font. */ readonly status: FontStatus; /** * The font version. */ readonly version: string; /** * The writing script. */ readonly writingScript: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Checks whether the font supports the specified OpenType feature. * @param using The OpenType feature to check for, specified either as an OpenType feature or a string. Can accept: OpenTypeFeature enumerator or String. */ checkOpenTypeFeature(using: OpenTypeFeature | string): boolean; /** * Create a copy of the font with just enough information to render the list of * characters given. * @param charactersForSubset String with all the characters used in the resulting font. * @param fontDestination File location for the new font. */ createSubsetFont(charactersForSubset: string, fontDestination: File): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Font[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Font. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for downloading fonts to the printer. */ declare enum FontDownloading { /** * Downloads all fonts once per page. */ COMPLETE = 2003332197, /** * Downloads only references to fonts. Note: Use when fonts reside in the * printer. */ NONE = 1852796517, /** * Downloads only the characters (glyphs) used in the document. Glyphs are * downloaded once per page. */ SUBSET = 1768842098, /** * Downloads only the characters (glyphs) used in the document. Glyphs are * downloaded once per page. Note: Use when the number of glyphs exceeds 350. */ SUBSET_LARGE = 1818325607, } /** * Options for embedding fonts in the exported EPS. */ declare enum FontEmbedding { /** * Embeds all fonts once per page. */ COMPLETE = 2003332197, /** * Embeds only references to fonts. */ NONE = 1852796517, /** * Embeds only the characters (glyphs) used in the document. Glyphs are * downloaded once per page. */ SUBSET = 1768842098, } /** * Font locking preferences. */ declare class FontLockingPreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, turns on missing glyph protection during font change. */ fontChangeLocking: boolean; /** * If true, turns on missing glyph protection during typing. */ fontInputLocking: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the FontLockingPreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FontLockingPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * FontLockingPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Font status options. */ declare enum FontStatus { /** * The font has been fauxed. */ FAUXED = 1718830689, /** * The font is installed. */ INSTALLED = 1718831470, /** * The font is not available. */ NOT_AVAILABLE = 1718832705, /** * The font is a substitute. */ SUBSTITUTED = 1718834037, /** * The font's status is unknown. */ UNKNOWN = 1433299822, } /** * Font sync preferences. */ declare class FontSyncPreference extends Preference { /** * Auto add font preference. */ autoActivateFont: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the FontSyncPreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FontSyncPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the FontSyncPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Font type options. */ declare enum FontTypes { /** * ATC. */ ATC = 1718894932, /** * Bitmap. */ BITMAP = 1718895209, /** * CID. */ CID = 1718895433, /** * OCF. */ OCF = 1718898499, /** * OpenType CFF. */ OPENTYPE_CFF = 1718898502, /** * OpenType CID. */ OPENTYPE_CID = 1718898505, /** * OpenType TT. */ OPENTYPE_TT = 1718898516, /** * TrueType. */ TRUETYPE = 1718899796, /** * Type 1. */ TYPE_1 = 1718899761, /** * The font type is unknown. */ UNKNOWN = 1433299822, } /** * A collection of fonts. */ declare class Fonts { /** Returns the Font with the specified index or name. */ [index: number]: Font; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Font in the collection. */ anyItem(): Font; /** * Displays the number of elements in the Font. */ count(): number; /** * Returns every Font in the collection. */ everyItem(): Font; /** * Returns the first Font in the collection. */ firstItem(): Font; /** * Returns the Font with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Font; /** * Returns the Font with the specified name. * @param name The name. */ itemByName(name: string): Font; /** * Returns the Fonts within the specified range. * @param from The Font, index, or name at the beginning of the range. Can accept: Font, Long Integer or String. * @param to The Font, index, or name at the end of the range. Can accept: Font, Long Integer or String. */ itemByRange(from: Font | number | string, to: Font | number | string): Font[]; /** * Returns the last Font in the collection. */ lastItem(): Font; /** * Returns the middle Font in the collection. */ middleItem(): Font; /** * Returns the Font whose index follows the specified Font in the collection. * @param obj The Font whose index comes before the desired Font. */ nextItem(obj: Font): Font; /** * Returns the Font with the index previous to the specified index. * @param obj The index of the Font that follows the desired Font. */ previousItem(obj: Font): Font; /** * Generates a string which, if executed, will return the Font. */ toSource(): string; } /** * A footnote. */ declare class Footnote { /** * Lists all graphics contained by the Footnote. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the Footnote. */ readonly allPageItems: PageItem[]; /** * A collection of characters. */ readonly characters: Characters; /** * The text contents of the footnote. Can return: String, SpecialCharacters * enumerator or Array of Strings or SpecialCharacters enumerators. Can also * accept: NothingEnum enumerator or Array of Strings, SpecialCharacters * enumerators or NothingEnum enumerators. */ contents: (NothingEnum | SpecialCharacters | string | string[] | NothingEnum[])[]; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of groups. */ readonly groups: Groups; /** * A collection of hidden text objects. */ readonly hiddenTexts: HiddenTexts; /** * The unique ID of the Footnote. */ readonly id: number; /** * The index of the Footnote within its containing object. */ readonly index: number; /** * A collection of insertion points. */ readonly insertionPoints: InsertionPoints; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * A collection of lines. */ readonly lines: Lines; /** * The name of the Footnote; this is an alias to the Footnote's label property. */ name: string; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * A collection of paragraphs. */ readonly paragraphs: Paragraphs; /** * The parent of the Footnote (a XmlStory, Cell, Story, TextFrame, * EndnoteTextFrame or InsertionPoint). */ readonly parent: Cell | EndnoteTextFrame | Story | TextFrame | InsertionPoint | XmlStory; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The location of the footnote marker in the parent story. */ readonly storyOffset: InsertionPoint; /** * A collection of text columns. */ readonly textColumns: TextColumns; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * A collection of text style ranges. */ readonly textStyleRanges: TextStyleRanges; /** * A collection of text variable instances. */ readonly textVariableInstances: TextVariableInstances; /** * A collection of text objects. */ readonly texts: Texts; /** * A collection of words. */ readonly words: Words; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Converts the footnote to part of the story text and places the converted * text at the former location of the footnote marker in the text. */ convertToText(): Text; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Footnote[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the Footnote. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Footnote. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for specifying the amount of vertical space between the top of the * footnote container and the first line of footnote text. */ declare enum FootnoteFirstBaseline { /** * The tallest character in the font falls below the top of the footnote * container. */ ASCENT_OFFSET = 1296135023, /** * The tops of upper case letters touch the top of the footnote container. */ CAP_HEIGHT = 1296255087, /** * The em box height of the text defines the distance between the baseline of * the text and the top of the footnote container. */ EMBOX_HEIGHT = 1296386159, /** * The footnote minimum first baseline offset value defines the distance * between the baseline of the text and the top of the footnote container. */ FIXED_HEIGHT = 1313228911, /** * The leading value of the text defines the distance between the baseline of * the text and the top of the footnote container. */ LEADING_OFFSET = 1296852079, /** * The tops of lower case letters without ascents, such as x, touch the top of * the footnote container. */ X_HEIGHT = 1299728495, } /** * Options for positioning footnote reference numbers relative to characters * the main text. */ declare enum FootnoteMarkerPositioning { /** * Uses the position defined in the character style applied to footnote * reference numbers. For information, see footnote marker style. */ NORMAL_MARKER = 1181576816, /** * Gives the marker ruby style positioning. */ RUBY_MARKER = 1181577840, /** * Subscripts footnote reference numbers. */ SUBSCRIPT_MARKER = 1181578096, /** * Superscripts footnote reference numbers. */ SUPERSCRIPT_MARKER = 1181569904, } /** * Footnote numbering style options. */ declare enum FootnoteNumberingStyle { /** * Uses Arabic numerals. */ ARABIC = 1298231906, /** * Uses Arabic Abjad */ ARABIC_ABJAD = 1296130410, /** * Uses Arabic Alif Ba Tah */ ARABIC_ALIF_BA_TAH = 1296130420, /** * Asterisks. */ ASTERISKS = 1298232180, /** * Double leading zeros. */ DOUBLE_LEADING_ZEROS = 1296329850, /** * Full-width Arabic. */ FULL_WIDTH_ARABIC = 1296455521, /** * Uses Hebrew Biblical */ HEBREW_BIBLICAL = 1296589410, /** * Uses Hebrew Non Standard */ HEBREW_NON_STANDARD = 1296589422, /** * Kanji. */ KANJI = 1296788073, /** * Uses lowercase letters. */ LOWER_LETTERS = 1296855660, /** * Uses lowercase Roman numerals. */ LOWER_ROMAN = 1297247596, /** * Single leading zeros. */ SINGLE_LEADING_ZEROS = 1297312890, /** * Uses symbols. */ SYMBOLS = 1181971321, /** * Uses uppercase letters. */ UPPER_LETTERS = 1296855669, /** * Uses uppercase Roman numerals. */ UPPER_ROMAN = 1297247605, } /** * Options for specifying default footnote formatting. */ declare class FootnoteOption extends Preference { /** * The swatch (color, gradient, tint, or mixed ink) applied to the rule above * continued footnote text. Note: Valid when continuing rule on is true. Can * return: Swatch or String. */ continuingRuleColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the rule above continued footnote text. Note: Valid when continuing rule * type is not solid. Can return: Swatch or String. */ continuingRuleGapColor: Swatch | string; /** * If true, overprints the gap color of the rule above continued footnote text. * Note: Valid when continuing rule type is not solid. */ continuingRuleGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of the rule above continued * footnote text. (Range: 0 to 100) Note: Valid when continuing rule type is * not solid. * @remarks Range: 0 to 100 */ continuingRuleGapTint: number; /** * The amount to left indent the rule above continued footnote text. Note: * Valid when continuing rule on is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ continuingRuleLeftIndent: number | string; /** * The stroke weight of the rule above continued footnote text. (Range: 0 to * 1000) Note: Valid when continuing rule on is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ continuingRuleLineWeight: number | string; /** * The vertical offset of the rule above continued footnote text. Note: Valid * when continuing rule on is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ continuingRuleOffset: number | string; /** * If true, draws a rule above footnote text that continues from a previous * column. Note: Valid when no splitting is false or undefined. */ continuingRuleOn: boolean; /** * If true, overprints the rule above continued footnote text. Note: Valid when * continuing rule on is true. */ continuingRuleOverprint: boolean; /** * The tint (as a percentage) of the rule above continued footnote text. * (Range: 0 to 100) Note: Valid when continuing rule type is not solid. * @remarks Range: 0 to 100 */ continuingRuleTint: number; /** * The stroke type of the rule above continued footnote text. Note: Valid when * continuing rule on is true. Can return: StrokeStyle or String. */ continuingRuleType: StrokeStyle | string; /** * The length of the rule above continued footnote text. Note: Valid when * continuing rule on is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ continuingRuleWidth: number | string; /** * If true, document will have straddling footnotes. If false, document will * not have straddling footnotes. */ enableStraddling: boolean; /** * If true, footnotes at the end of the story are placed just below the text. * If false, footnotes at the end of the story are placed at the bottom of the * column. */ eosPlacement: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The distance between the top of the footnote container and the footnote * text. */ footnoteFirstBaselineOffset: FootnoteFirstBaseline; /** * The character style to apply to footnote reference numbers in the main text. */ footnoteMarkerStyle: CharacterStyle; /** * The minimum distance between the baseline of the text and the top of the * footnote container. * @remarks Measurement unit — also accepts a string such as "12mm". */ footnoteMinimumFirstBaselineOffset: number | string; /** * The footnote numbering style. Can return: FootnoteNumberingStyle enumerator * or String. */ footnoteNumberingStyle: FootnoteNumberingStyle | string; /** * The paragraph style to apply to footnotes. Note: The space before and after * the paragraph defined in the paragraph style is ignored for footnotes. To * define space above and between footnotes, see spacer and space between. */ footnoteTextStyle: ParagraphStyle; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The position of footnote reference numbers in the main text. Can return: * FootnoteMarkerPositioning enumerator or String. */ markerPositioning: FootnoteMarkerPositioning | string; /** * If true, footnotes cannot split across columns. If false, footnotes flow * into succeeding columns when the footnote text causes the footnote area to * expand upward to reach the footnote reference number in the main text. */ noSplitting: boolean; /** * The parent of the FootnoteOption (a Application or Document). */ readonly parent: Application | Document; /** * The prefix text of the footnote. (Limit: 0 to 100 characters) */ prefix: string; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The point at which to restart footnote numbering. Can return: * FootnoteRestarting enumerator or String. */ restartNumbering: FootnoteRestarting | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the rule above the first footnote in the column. Note: Valid when rule on is * true. Can return: Swatch or String. */ ruleColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the rule above the first footnote in the column. Note: Valid when rule * type is not solid. Can return: Swatch or String. */ ruleGapColor: Swatch | string; /** * If true, overprints the gap color of the rule above the first footnote in * the column. Note: Valid when rule type is not solid. */ ruleGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of the rule above the first * footnote in the column. (Range: 0 to 100) Note: Valid when rule type is not * solid. * @remarks Range: 0 to 100 */ ruleGapTint: number; /** * The amount to left indent the rule above the first footnote in the column. * Note: Valid when rule on is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleLeftIndent: number | string; /** * The stroke weight of the rule above the first footnote in the column. * (Range: 0 to 1000) Note: Valid when rule on is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleLineWeight: number | string; /** * The vertical offset of the rule above the first footnote in the column. * Note: Valid when rule on is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleOffset: number | string; /** * If true, draws a rule between the text and the first footnote in the column. */ ruleOn: boolean; /** * If true, overprints the rule above the first footnote in the column. Note: * Valid when rule on is true. */ ruleOverprint: boolean; /** * The tint (as a percentage) of the rule above the first footnote in the * column. (Range: 0 to 100) Note: Valid when rule on is true. * @remarks Range: 0 to 100 */ ruleTint: number; /** * The stroke type of the rule above the first footnote in a column. Note: * Valid when rule on is true. Can return: StrokeStyle or String. */ ruleType: StrokeStyle | string; /** * The length of the rule above the first footnote in the column. Note: Valid * when rule on is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleWidth: number | string; /** * The text to insert between the footnote marker number and the footnote text. * (Range: 0 to 100 characters) * @remarks Range: 0 to 100 */ separatorText: string; /** * The position of the footnote prefix and/or suffix. Can return: * FootnotePrefixSuffix enumerator or String. */ showPrefixSuffix: FootnotePrefixSuffix | string; /** * The amount of vertical space between footnotes. Note: The space before and * space after defined for the paragraph style applied to the footnote is * ignored. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceBetween: number | string; /** * The minimum amount of vertical space between the bottom of the text column * and the first footnote. Note: The space before amount defined in the * paragraph style applied to the footnote is ignored for the first footnote. * @remarks Measurement unit — also accepts a string such as "12mm". */ spacer: number | string; /** * The number at which to start footnote numbering. * @remarks Range: 1 to 100000 */ startAt: number; /** * The suffix text of the footnote. (Limit: 0 to 100 characters) */ suffix: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FootnoteOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the FootnoteOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Footnote prefix or suffix placement options. */ declare enum FootnotePrefixSuffix { /** * Does not use a prefix or suffix. */ NO_PREFIX_SUFFIX = 1181774702, /** * Places the prefix and/or suffix on both the the footnote reference number in * the main text and the footnote marker number in the footnote text. */ PREFIX_SUFFIX_BOTH = 1181774690, /** * Places the prefix and/or suffix on the footnote marker number in the * footnote text. */ PREFIX_SUFFIX_MARKER = 1181774708, /** * Places the prefix and/or suffix on the footnote reference number in the main * text. */ PREFIX_SUFFIX_REFERENCE = 1181774706, } /** * Options for restarting footnote numbering. */ declare enum FootnoteRestarting { /** * Does not restart numbering; numbers footnotes sequentially throughout the * document. */ DONT_RESTART = 1180988019, /** * Restarts footnote numbering on each page. */ PAGE_RESTART = 1181774451, /** * Restarts footnote numbering in each section. */ SECTION_RESTART = 1181053555, /** * Restarts footnote numbering on each spread. */ SPREAD_RESTART = 1181971059, } /** * A collection of footnotes. */ declare class Footnotes { /** Returns the Footnote with the specified index or name. */ [index: number]: Footnote; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new footnote. * @param at The location of the footnote reference number in the main text relative to the reference object or within the story. (Optional) * @param reference The reference object. Note: Must be an insertion point or a note. Required when the at parameter specifies before or after. Can accept: Note or InsertionPoint. (Optional) * @param withProperties Initial values for properties of the new Footnote (Optional) */ add(at?: LocationOptions, reference?: Note | InsertionPoint, withProperties?: Object): Footnote; /** * Returns any Footnote in the collection. */ anyItem(): Footnote; /** * Displays the number of elements in the Footnote. */ count(): number; /** * Returns every Footnote in the collection. */ everyItem(): Footnote; /** * Returns the first Footnote in the collection. */ firstItem(): Footnote; /** * Returns the Footnote with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Footnote; /** * Returns the Footnote with the specified ID. * @param id The ID. */ itemByID(id: number): Footnote; /** * Returns the Footnote with the specified name. * @param name The name. */ itemByName(name: string): Footnote; /** * Returns the Footnotes within the specified range. * @param from The Footnote, index, or name at the beginning of the range. Can accept: Footnote, Long Integer or String. * @param to The Footnote, index, or name at the end of the range. Can accept: Footnote, Long Integer or String. */ itemByRange(from: Footnote | number | string, to: Footnote | number | string): Footnote[]; /** * Returns the last Footnote in the collection. */ lastItem(): Footnote; /** * Returns the middle Footnote in the collection. */ middleItem(): Footnote; /** * Returns the Footnote whose index follows the specified Footnote in the * collection. * @param obj The Footnote whose index comes before the desired Footnote. */ nextItem(obj: Footnote): Footnote; /** * Returns the Footnote with the index previous to the specified index. * @param obj The index of the Footnote that follows the desired Footnote. */ previousItem(obj: Footnote): Footnote; /** * Generates a string which, if executed, will return the Footnote. */ toSource(): string; } /** * A form field. */ declare class FormField extends PageItem { /** * Indicates whether the FormField has been flipped independently of its parent * object and, if yes, the direction in which the FormField was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the FormField relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the FormField relative to its containing object. * (Range: -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the FormField relative to its containing object. * (Range: -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the FormField relative to its containing object. */ absoluteVerticalScale: number; /** * The index of the active state in the object's states collection. */ activeStateIndex: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the FormField. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the FormField. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * Anchored object settings. */ readonly anchoredObjectSettings: AnchoredObjectSetting; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the FormField. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the FormField. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the FormField. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * Transparency settings for the content of the FormField. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The description of the FormField. */ description: string; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the FormField. */ endJoin: EndJoin; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * FormField. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the FormField's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the FormField. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the FormField excluding the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the FormField. (Range: * -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the FormField. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the FormField, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the FormField. * (Range: -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the FormField. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the FormField, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the FormField. */ horizontalScale: number; /** * The unique ID of the FormField. */ readonly id: number; /** * The index of the FormField within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the FormField is on. */ itemLayer: Layer; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the FormField. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the FormField is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * The name of the FormField. */ name: string; /** * If true, the FormField does not print. */ nonprinting: boolean; /** * If true, the FormField's fill color overprints any underlying objects. If * false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the FormField's stroke color overprints any underlying objects. If * false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the FormField (a Snippet, PlaceGun, FlexObject, Spread, * MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group or * Character). */ readonly parent: FlexObject | GraphicLine | Group | MasterSpread | Oval | PlaceGun | Polygon | Rectangle | SplineItem | Spread | Character | Snippet; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the FormField. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the FormField. (Range: -360 to 360) */ shearAngle: number; /** * The stroke alignment applied to the FormField. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the FormField. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the FormField. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the FormField's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the FormField. */ verticalScale: number; /** * If true, the FormField is visible. */ visible: boolean; /** * The bounds of the FormField including the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * Dispatched after a FormField is placed. This event bubbles. This event is * not cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a FormField is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the FormField's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the FormField that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the FormField. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the FormField to a different shape. * @param given The FormField's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new FormField. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new FormField. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new FormField. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new FormField. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new FormField. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the FormField at the specified location or offset. * @param to The location of the new FormField, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new FormField from the original FormField's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the FormField. * @param given The axis around which to flip the FormField. * @param around The point around which to flip the FormField. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FormField[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the FormField to a new location. Note: Either the 'to' or 'by' * parameter is required; if both parameters are defined, only the to value is * used. * @param to The new location of the FormField,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the FormField relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the FormField. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the FormField in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new FormField (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the FormField. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the FormField using the last transformation performed on any * object. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgain(): string[]; /** * Transforms the FormField using the last transformation performed on any * FormField. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgainIndividually(): string[]; /** * Transforms the FormField using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the FormField using the last sequence of transformations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * A collection of form fields. */ declare class FormFields { /** Returns the FormField with the specified index or name. */ [index: number]: FormField; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new FormField * @param layer The layer on which to create the FormField. (Optional) * @param at The location at which to insert the FormField relative to the reference object or within the container object. (Optional) * @param reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) * @param withProperties Initial values for properties of the new FormField (Optional) */ add(layer?: Layer, at?: LocationOptions, reference?: Document | Layer | MasterSpread | Page | Spread | PageItem, withProperties?: Object): FormField; /** * Returns any FormField in the collection. */ anyItem(): FormField; /** * Displays the number of elements in the FormField. */ count(): number; /** * Returns every FormField in the collection. */ everyItem(): FormField; /** * Returns the first FormField in the collection. */ firstItem(): FormField; /** * Returns the FormField with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): FormField; /** * Returns the FormField with the specified ID. * @param id The ID. */ itemByID(id: number): FormField; /** * Returns the FormField with the specified name. * @param name The name. */ itemByName(name: string): FormField; /** * Returns the FormFields within the specified range. * @param from The FormField, index, or name at the beginning of the range. Can accept: FormField, Long Integer or String. * @param to The FormField, index, or name at the end of the range. Can accept: FormField, Long Integer or String. */ itemByRange(from: FormField | number | string, to: FormField | number | string): FormField[]; /** * Returns the last FormField in the collection. */ lastItem(): FormField; /** * Returns the middle FormField in the collection. */ middleItem(): FormField; /** * Returns the FormField whose index follows the specified FormField in the * collection. * @param obj The FormField whose index comes before the desired FormField. */ nextItem(obj: FormField): FormField; /** * Returns the FormField with the index previous to the specified index. * @param obj The index of the FormField that follows the desired FormField. */ previousItem(obj: FormField): FormField; /** * Generates a string which, if executed, will return the FormField. */ toSource(): string; } /** * Options for fitting placed or pasted content in a frame. */ declare class FrameFittingOption extends Preference { /** * If true, the last saved fitting options will be applied to the contents of a * frame when it is resized. */ autoFit: boolean; /** * The amount in measurement units to crop the bottom edge of a graphic. * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomCrop: number | string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The point with which to align the image empty when fitting in a frame. For * information, see frame fitting options. */ fittingAlignment: AnchorPoint; /** * The frame fitting option to apply to placed or pasted content if the frame * is empty. Can be applied to a frame, object style, or document or to the * application. */ fittingOnEmptyFrame: EmptyFrameFittingOptions; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The amount in measurement units to crop the left edge of a graphic. * @remarks Measurement unit — also accepts a string such as "12mm". */ leftCrop: number | string; /** * The parent of the FrameFittingOption (a ObjectStyle, Oval, Rectangle, * Polygon, Application or Document). */ readonly parent: Application | Oval | Polygon | Rectangle | Document | ObjectStyle; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The amount in measurement units to crop the right edge of a graphic. * @remarks Measurement unit — also accepts a string such as "12mm". */ rightCrop: number | string; /** * The amount in measurement units to crop the top edge of a graphic. * @remarks Measurement unit — also accepts a string such as "12mm". */ topCrop: number | string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): FrameFittingOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the FrameFittingOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Color palette options for GIF conversion. */ declare enum GIFOptionsPalette { /** * Uses the adaptive (no dither) palette. */ ADAPTIVE_PALETTE = 1886151024, /** * Uses the Macintosh palette. */ MACINTOSH_PALETTE = 1886154096, /** * Uses the Web palette. */ WEB_PALETTE = 1886156656, /** * Uses the Windows palette. */ WINDOWS_PALETTE = 1886156644, } /** * Galley preferences. */ declare class GalleyPreference extends Preference { /** * The type of text anti-aliasing to use in story and galley views. */ antiAliasType: AntiAliasType; /** * The background color, specified either as an array of three doubles, each in * the range 0 to 255 and representing R, G, and B values, or as an InCopy UI * color. . Can return: Array of 3 Reals (0 - 255) or InCopyUIColors * enumerator. */ backgroundColor: (number[][] | InCopyUIColors)[]; /** * If true, the cursor blinks. */ blinkCursor: boolean; /** * The cursor type for galley and story views. */ cursorType: CursorTypes; /** * Font family name to use for text display. */ displayFont: string; /** * Size to use for text display. * @remarks Measurement unit — also accepts a string such as "12mm". */ displayFontSize: number | string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Info column width. * @remarks Measurement unit — also accepts a string such as "12mm". */ infoColumnWidth: number | string; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * Amount of spacing between lines. */ lineSpacingValue: LineSpacingType; /** * The parent of the GalleyPreference (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, displays the depth ruler. */ showDepthRuler: boolean; /** * If true, display the Info column. */ showInfoColumn: boolean; /** * If true, show paragraph break marks. */ showParagraphBreakMarks: boolean; /** * If true, show paragraph style names. */ showParagraphStyleNames: boolean; /** * If true, galley text is anti-aliased. */ smoothText: boolean; /** * The text color, specified either as an array of three doubles, each in the * range 0 to 255 and representing R, G, and B values, or as an InCopy UI * color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator. */ textColor: (number[][] | InCopyUIColors)[]; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GalleyPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the GalleyPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * General application preferences. */ declare class GeneralPreference extends Preference { /** * If true, alt text for images are appended with generated by AI tag. */ addAITagToAltText: boolean; /** * If true, application bar is shown. */ readonly applicationBarShown: boolean; /** * If true, on creating new char style through the new char style dialog, it * will be exported to CC Libraries as well */ autoAddCharStyleToCCLibraries: boolean; /** * If true, on creating new para style through the new para style dialog, it * will be exported to CC Libraries as well */ autoAddParaStyleToCCLibraries: boolean; /** * If true, on creating new swatch through the new swatch dialog, it will be * exported to CC Libraries as well */ autoAddSwatchToCCLibraries: boolean; /** * If true, panel drawers close automatically. */ autoCollapseIconPanels: boolean; /** * If true, alt text for images are auto generated when imported. */ autoGenerateAltText: boolean; /** * If true, vertical reveal strips appear when palette UI is hidden. */ autoShowHiddenPanels: boolean; /** * The threshold at which to trigger font subsetting based on the number of * glyphs the font contains. */ completeFontDownloadGlyphLimit: number; /** * Controls whether or not the context bar (contextual task bar) is visible. */ contextBarVisible: boolean; /** * Enable the creation of links on content place */ createLinksOnContentPlace: boolean; /** * When using a custom monitor resolution, what is the value of that resolution * in pixels per inch */ customMonitorPpi: number; /** * If true, enable content-aware fit as default while placing items */ enableContentAwareFit: boolean; /** * If true, floating windows can be docked by user as tabs. */ enableFloatingWindowDocking: boolean; /** * Controls whether or not multi-touch gestures are enabled. */ enableMultiTouchGestures: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Controls whether or not to greek vector graphics when dragging at high * quality. */ greekVectorGraphicsOnDrag: boolean; /** * Controls whether or not to highlight object under selection tool. */ highlightObjectUnderSelectionTool: boolean; /** * If true, includes a preview in saved documents. */ includePreview: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * keyboard shortcut set */ keyboardShortcutSet: string; /** * The value of the system reported main monitor resolution */ readonly mainMonitorPpi: number; /** * Enable the mapping of styles on content place */ mapStylesOnContentPlace: boolean; /** * Controls whether page items move when a page is repositioned from the UI. * The option/alt key temporarily reverses this property */ objectsMoveWithPage: boolean; /** * If true, documents open as tabs. */ openDocumentsAsTabs: boolean; /** * Number of items to show in the Open Recent menu list. Range: 0 to 30 * @remarks Range: 0 to 30 */ openRecentLength: number; /** * The page numbering method. */ pageNumbering: PageNumberingOptions; /** * If true, Large Tabs are shown for panels else Smaller tabs are shown */ panelTabHeightPreference: boolean; /** * The parent of the GeneralPreference (a Application). */ readonly parent: Application; /** * Specify the Pasteboard color preference (0 or 1). Specify 0 to set * preference to Default White, and 1 to set preference to Match with Theme * Color. */ pasteboardColorPreference: number; /** * Controls whether or not to show thumbnails of imported files in the Place * icon. */ placeCursorUsesThumbnails: boolean; /** * Controls whether or not you can select and interact with a locked item. When * this is off, only position is locked. */ preventSelectingLockedItems: boolean; /** * The pages to create preview images for. Note: Valid when include preview is * true. */ previewPages: PreviewPagesOptions; /** * The preview size. Note: Valid when include preview is true. */ previewSize: PreviewSizeOptions; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * set active workspace */ setActiveWorkspace: string; /** * Controls whether or not the anchor object adornment is shown. */ showAnchorObjectAdornment: boolean; /** * Controls whether or not the content grabber adornment is shown. */ showContentGrabber: boolean; /** * Show the conveyor on content collector or content placer tool activation */ showConveyor: boolean; /** * If true, legacy new document dialog will be shown when Ctrl/Cmd + N are * pressed. */ showLegacyNewDocumentDialog: boolean; /** * Controls whether or not the live corners grabber adornment is shown. */ showLiveCorners: boolean; /** * Controls whether or not to show the master page overlay when a page is * selected using the Page Tool. */ showMasterPageOverlay: boolean; /** * If true, show start workspace when no documents are open */ showStartWorkspace: boolean; /** * If true, show stock cart adornment on unlicensed stock images */ showStockPurchaseAdornment: boolean; /** * Controls whether or not to dynamically display transformation information as * part of the cursor while manipulating page items. */ showTransformationValues: boolean; /** * If true, show What's New dialog on startup. */ showWhatsNewOnStartup: boolean; /** * The location in which to store temporary files. */ temporaryFolder: File; /** * Tool tip behavior. */ toolTips: ToolTipOptions; /** * Controls the appearance of the Tools panel. */ toolsPanel: ToolsPanelOptions; /** * Specify the Application User Interface brightness preference (from 0.0 to * 1.0). To use color theme brightness preset values, specify 0.0 for Dark, * 0.50 for Medium Dark, 0.51 for Medium Bright, and 1.0 for Bright. Any value * between 0.0 and 1.0 will automatically be mapped to closest preset. */ uiBrightnessPreference: number; /** * If true, objects after ungrouping go back to their original layers. */ ungroupRemembersLayers: boolean; /** * If true, application lives in a frame. */ readonly useApplicationFrame: boolean; /** * Enable the use of a custom monitor resolution in pixels per inch as opposed * to querying the system settings */ useCustomMonitorResolution: boolean; /** * If true, use incoming spot color definition in case of conflict, when * placing or pasting content */ useIncomingSpotUponConflict: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GeneralPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the GeneralPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * The resolution strategy to employ for imported styles that have the same * names as existing styles. */ declare enum GlobalClashResolutionStrategy { /** * Does not import styles whose names clash with existing items. */ DO_NOT_LOAD_THE_STYLE = 1147495276, /** * Overwrites existing styles whose names clash with imported items. */ LOAD_ALL_WITH_OVERWRITE = 1279350607, /** * Renames imported styles whose names clash with existing items to preserve * existing items. */ LOAD_ALL_WITH_RENAME = 1279350610, } /** * Resolution options when loaded master pages have the same name as existing * masterpages. */ declare enum GlobalClashResolutionStrategyForMasterPage { /** * Overwrites the existing master page. */ LOAD_ALL_WITH_OVERWRITE = 1279350607, /** * Renames the new master page. */ LOAD_ALL_WITH_RENAME = 1279350610, } /** * Glow technique options. */ declare enum GlowTechnique { /** * Precise. */ PRECISE = 2020618338, /** * Softer. */ SOFTER = 2020618337, } /** * Zoom options for the goto destination page. */ declare enum GoToZoomOptions { /** * Displays the page at 100% magnification. */ ACTUAL_SIZE = 2053206906, /** * Fits the text area of the page to the window width; obscures page margins * and may obscure the lower portion of the page. */ FIT_VISIBLE = 1212437334, /** * Fits the page to the width of the window; may obscure the lower portion of * the page. */ FIT_WIDTH = 1212437335, /** * Fits the page in the display window. */ FIT_WINDOW = 1212437367, /** * Inherits the zoom setting from the previously displayed page. */ INHERIT_ZOOM = 1212437370, } /** * A behavior object that jumps to an anchor. */ declare class GotoAnchorBehavior extends Behavior { /** * The anchor item, specified as a bookmark or a hyperlink text or page * destination. Can return: Bookmark, HyperlinkTextDestination or * HyperlinkPageDestination. */ anchorItem: Bookmark | HyperlinkTextDestination | HyperlinkPageDestination; /** * The anchor name. */ readonly anchorName: string; /** * The event which triggers the behavior. */ behaviorEvent: BehaviorEvents; /** * If true, the behavior is enabled. */ enableBehavior: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The file path (colon delimited on the Mac OS). Can also accept: File. */ filePath: string | File; /** * The unique ID of the GotoAnchorBehavior. */ readonly id: number; /** * The index of the GotoAnchorBehavior within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the GotoAnchorBehavior. */ readonly name: string; /** * The parent of the GotoAnchorBehavior (a Button, CheckBox, ComboBox, ListBox, * RadioButton, TextBox or SignatureField). */ readonly parent: CheckBox | ComboBox | ListBox | RadioButton | TextBox | Button | SignatureField; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The zoom setting. */ zoomSetting: GoToZoomOptions; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GotoAnchorBehavior[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the GotoAnchorBehavior. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the GotoAnchorBehavior. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of goto anchor behavior objects. */ declare class GotoAnchorBehaviors { /** Returns the GotoAnchorBehavior with the specified index or name. */ [index: number]: GotoAnchorBehavior; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new GotoAnchorBehavior. * @param withProperties Initial values for properties of the new GotoAnchorBehavior (Optional) */ add(withProperties?: Object): GotoAnchorBehavior; /** * Returns any GotoAnchorBehavior in the collection. */ anyItem(): GotoAnchorBehavior; /** * Displays the number of elements in the GotoAnchorBehavior. */ count(): number; /** * Returns every GotoAnchorBehavior in the collection. */ everyItem(): GotoAnchorBehavior; /** * Returns the first GotoAnchorBehavior in the collection. */ firstItem(): GotoAnchorBehavior; /** * Returns the GotoAnchorBehavior with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): GotoAnchorBehavior; /** * Returns the GotoAnchorBehavior with the specified ID. * @param id The ID. */ itemByID(id: number): GotoAnchorBehavior; /** * Returns the GotoAnchorBehavior with the specified name. * @param name The name. */ itemByName(name: string): GotoAnchorBehavior; /** * Returns the GotoAnchorBehaviors within the specified range. * @param from The GotoAnchorBehavior, index, or name at the beginning of the range. Can accept: GotoAnchorBehavior, Long Integer or String. * @param to The GotoAnchorBehavior, index, or name at the end of the range. Can accept: GotoAnchorBehavior, Long Integer or String. */ itemByRange(from: GotoAnchorBehavior | number | string, to: GotoAnchorBehavior | number | string): GotoAnchorBehavior[]; /** * Returns the last GotoAnchorBehavior in the collection. */ lastItem(): GotoAnchorBehavior; /** * Returns the middle GotoAnchorBehavior in the collection. */ middleItem(): GotoAnchorBehavior; /** * Returns the GotoAnchorBehavior whose index follows the specified * GotoAnchorBehavior in the collection. * @param obj The GotoAnchorBehavior whose index comes before the desired GotoAnchorBehavior. */ nextItem(obj: GotoAnchorBehavior): GotoAnchorBehavior; /** * Returns the GotoAnchorBehavior with the index previous to the specified * index. * @param obj The index of the GotoAnchorBehavior that follows the desired GotoAnchorBehavior. */ previousItem(obj: GotoAnchorBehavior): GotoAnchorBehavior; /** * Generates a string which, if executed, will return the GotoAnchorBehavior. */ toSource(): string; } /** * A behavior object that jumps to the first page of the document. */ declare class GotoFirstPageBehavior extends Behavior { /** * The event which triggers the behavior. */ behaviorEvent: BehaviorEvents; /** * If true, the behavior is enabled. */ enableBehavior: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the GotoFirstPageBehavior. */ readonly id: number; /** * The index of the GotoFirstPageBehavior within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the GotoFirstPageBehavior. */ readonly name: string; /** * The parent of the GotoFirstPageBehavior (a Button, CheckBox, ComboBox, * ListBox, RadioButton, TextBox or SignatureField). */ readonly parent: CheckBox | ComboBox | ListBox | RadioButton | TextBox | Button | SignatureField; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The zoom setting. */ zoomSetting: GoToZoomOptions; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GotoFirstPageBehavior[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the GotoFirstPageBehavior. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * GotoFirstPageBehavior. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of goto first page behavior objects. */ declare class GotoFirstPageBehaviors { /** Returns the GotoFirstPageBehavior with the specified index or name. */ [index: number]: GotoFirstPageBehavior; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new GotoFirstPageBehavior. * @param withProperties Initial values for properties of the new GotoFirstPageBehavior (Optional) */ add(withProperties?: Object): GotoFirstPageBehavior; /** * Returns any GotoFirstPageBehavior in the collection. */ anyItem(): GotoFirstPageBehavior; /** * Displays the number of elements in the GotoFirstPageBehavior. */ count(): number; /** * Returns every GotoFirstPageBehavior in the collection. */ everyItem(): GotoFirstPageBehavior; /** * Returns the first GotoFirstPageBehavior in the collection. */ firstItem(): GotoFirstPageBehavior; /** * Returns the GotoFirstPageBehavior with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): GotoFirstPageBehavior; /** * Returns the GotoFirstPageBehavior with the specified ID. * @param id The ID. */ itemByID(id: number): GotoFirstPageBehavior; /** * Returns the GotoFirstPageBehavior with the specified name. * @param name The name. */ itemByName(name: string): GotoFirstPageBehavior; /** * Returns the GotoFirstPageBehaviors within the specified range. * @param from The GotoFirstPageBehavior, index, or name at the beginning of the range. Can accept: GotoFirstPageBehavior, Long Integer or String. * @param to The GotoFirstPageBehavior, index, or name at the end of the range. Can accept: GotoFirstPageBehavior, Long Integer or String. */ itemByRange(from: GotoFirstPageBehavior | number | string, to: GotoFirstPageBehavior | number | string): GotoFirstPageBehavior[]; /** * Returns the last GotoFirstPageBehavior in the collection. */ lastItem(): GotoFirstPageBehavior; /** * Returns the middle GotoFirstPageBehavior in the collection. */ middleItem(): GotoFirstPageBehavior; /** * Returns the GotoFirstPageBehavior whose index follows the specified * GotoFirstPageBehavior in the collection. * @param obj The GotoFirstPageBehavior whose index comes before the desired GotoFirstPageBehavior. */ nextItem(obj: GotoFirstPageBehavior): GotoFirstPageBehavior; /** * Returns the GotoFirstPageBehavior with the index previous to the specified * index. * @param obj The index of the GotoFirstPageBehavior that follows the desired GotoFirstPageBehavior. */ previousItem(obj: GotoFirstPageBehavior): GotoFirstPageBehavior; /** * Generates a string which, if executed, will return the * GotoFirstPageBehavior. */ toSource(): string; } /** * A behavior object that jumps to the last page of the document. */ declare class GotoLastPageBehavior extends Behavior { /** * The event which triggers the behavior. */ behaviorEvent: BehaviorEvents; /** * If true, the behavior is enabled. */ enableBehavior: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the GotoLastPageBehavior. */ readonly id: number; /** * The index of the GotoLastPageBehavior within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the GotoLastPageBehavior. */ readonly name: string; /** * The parent of the GotoLastPageBehavior (a Button, CheckBox, ComboBox, * ListBox, RadioButton, TextBox or SignatureField). */ readonly parent: CheckBox | ComboBox | ListBox | RadioButton | TextBox | Button | SignatureField; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The zoom setting. */ zoomSetting: GoToZoomOptions; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GotoLastPageBehavior[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the GotoLastPageBehavior. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the GotoLastPageBehavior. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of goto last page behavior objects. */ declare class GotoLastPageBehaviors { /** Returns the GotoLastPageBehavior with the specified index or name. */ [index: number]: GotoLastPageBehavior; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new GotoLastPageBehavior. * @param withProperties Initial values for properties of the new GotoLastPageBehavior (Optional) */ add(withProperties?: Object): GotoLastPageBehavior; /** * Returns any GotoLastPageBehavior in the collection. */ anyItem(): GotoLastPageBehavior; /** * Displays the number of elements in the GotoLastPageBehavior. */ count(): number; /** * Returns every GotoLastPageBehavior in the collection. */ everyItem(): GotoLastPageBehavior; /** * Returns the first GotoLastPageBehavior in the collection. */ firstItem(): GotoLastPageBehavior; /** * Returns the GotoLastPageBehavior with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): GotoLastPageBehavior; /** * Returns the GotoLastPageBehavior with the specified ID. * @param id The ID. */ itemByID(id: number): GotoLastPageBehavior; /** * Returns the GotoLastPageBehavior with the specified name. * @param name The name. */ itemByName(name: string): GotoLastPageBehavior; /** * Returns the GotoLastPageBehaviors within the specified range. * @param from The GotoLastPageBehavior, index, or name at the beginning of the range. Can accept: GotoLastPageBehavior, Long Integer or String. * @param to The GotoLastPageBehavior, index, or name at the end of the range. Can accept: GotoLastPageBehavior, Long Integer or String. */ itemByRange(from: GotoLastPageBehavior | number | string, to: GotoLastPageBehavior | number | string): GotoLastPageBehavior[]; /** * Returns the last GotoLastPageBehavior in the collection. */ lastItem(): GotoLastPageBehavior; /** * Returns the middle GotoLastPageBehavior in the collection. */ middleItem(): GotoLastPageBehavior; /** * Returns the GotoLastPageBehavior whose index follows the specified * GotoLastPageBehavior in the collection. * @param obj The GotoLastPageBehavior whose index comes before the desired GotoLastPageBehavior. */ nextItem(obj: GotoLastPageBehavior): GotoLastPageBehavior; /** * Returns the GotoLastPageBehavior with the index previous to the specified * index. * @param obj The index of the GotoLastPageBehavior that follows the desired GotoLastPageBehavior. */ previousItem(obj: GotoLastPageBehavior): GotoLastPageBehavior; /** * Generates a string which, if executed, will return the GotoLastPageBehavior. */ toSource(): string; } /** * A behavior object that jumps to the next page in the document. */ declare class GotoNextPageBehavior extends Behavior { /** * The event which triggers the behavior. */ behaviorEvent: BehaviorEvents; /** * If true, the behavior is enabled. */ enableBehavior: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the GotoNextPageBehavior. */ readonly id: number; /** * The index of the GotoNextPageBehavior within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the GotoNextPageBehavior. */ readonly name: string; /** * The parent of the GotoNextPageBehavior (a Button, CheckBox, ComboBox, * ListBox, RadioButton, TextBox or SignatureField). */ readonly parent: CheckBox | ComboBox | ListBox | RadioButton | TextBox | Button | SignatureField; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The zoom setting. */ zoomSetting: GoToZoomOptions; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GotoNextPageBehavior[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the GotoNextPageBehavior. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the GotoNextPageBehavior. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of goto next page behavior objects. */ declare class GotoNextPageBehaviors { /** Returns the GotoNextPageBehavior with the specified index or name. */ [index: number]: GotoNextPageBehavior; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new GotoNextPageBehavior. * @param withProperties Initial values for properties of the new GotoNextPageBehavior (Optional) */ add(withProperties?: Object): GotoNextPageBehavior; /** * Returns any GotoNextPageBehavior in the collection. */ anyItem(): GotoNextPageBehavior; /** * Displays the number of elements in the GotoNextPageBehavior. */ count(): number; /** * Returns every GotoNextPageBehavior in the collection. */ everyItem(): GotoNextPageBehavior; /** * Returns the first GotoNextPageBehavior in the collection. */ firstItem(): GotoNextPageBehavior; /** * Returns the GotoNextPageBehavior with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): GotoNextPageBehavior; /** * Returns the GotoNextPageBehavior with the specified ID. * @param id The ID. */ itemByID(id: number): GotoNextPageBehavior; /** * Returns the GotoNextPageBehavior with the specified name. * @param name The name. */ itemByName(name: string): GotoNextPageBehavior; /** * Returns the GotoNextPageBehaviors within the specified range. * @param from The GotoNextPageBehavior, index, or name at the beginning of the range. Can accept: GotoNextPageBehavior, Long Integer or String. * @param to The GotoNextPageBehavior, index, or name at the end of the range. Can accept: GotoNextPageBehavior, Long Integer or String. */ itemByRange(from: GotoNextPageBehavior | number | string, to: GotoNextPageBehavior | number | string): GotoNextPageBehavior[]; /** * Returns the last GotoNextPageBehavior in the collection. */ lastItem(): GotoNextPageBehavior; /** * Returns the middle GotoNextPageBehavior in the collection. */ middleItem(): GotoNextPageBehavior; /** * Returns the GotoNextPageBehavior whose index follows the specified * GotoNextPageBehavior in the collection. * @param obj The GotoNextPageBehavior whose index comes before the desired GotoNextPageBehavior. */ nextItem(obj: GotoNextPageBehavior): GotoNextPageBehavior; /** * Returns the GotoNextPageBehavior with the index previous to the specified * index. * @param obj The index of the GotoNextPageBehavior that follows the desired GotoNextPageBehavior. */ previousItem(obj: GotoNextPageBehavior): GotoNextPageBehavior; /** * Generates a string which, if executed, will return the GotoNextPageBehavior. */ toSource(): string; } /** * A goto next state behavior. */ declare class GotoNextStateBehavior extends Behavior { /** * The associated multi-state object page item. */ associatedMultiStateObject: MultiStateObject; /** * The event which triggers the behavior. */ behaviorEvent: BehaviorEvents; /** * If true, the behavior is enabled. */ enableBehavior: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the GotoNextStateBehavior. */ readonly id: number; /** * The index of the GotoNextStateBehavior within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * If true, will loop to the next or previous state. */ loopsToNextOrPrevious: boolean; /** * The name of the GotoNextStateBehavior. */ readonly name: string; /** * The parent of the GotoNextStateBehavior (a Button). */ readonly parent: Button; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GotoNextStateBehavior[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the GotoNextStateBehavior. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * GotoNextStateBehavior. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of goto next state behaviors. */ declare class GotoNextStateBehaviors { /** Returns the GotoNextStateBehavior with the specified index or name. */ [index: number]: GotoNextStateBehavior; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new GotoNextStateBehavior. * @param withProperties Initial values for properties of the new GotoNextStateBehavior (Optional) */ add(withProperties?: Object): GotoNextStateBehavior; /** * Returns any GotoNextStateBehavior in the collection. */ anyItem(): GotoNextStateBehavior; /** * Displays the number of elements in the GotoNextStateBehavior. */ count(): number; /** * Returns every GotoNextStateBehavior in the collection. */ everyItem(): GotoNextStateBehavior; /** * Returns the first GotoNextStateBehavior in the collection. */ firstItem(): GotoNextStateBehavior; /** * Returns the GotoNextStateBehavior with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): GotoNextStateBehavior; /** * Returns the GotoNextStateBehavior with the specified ID. * @param id The ID. */ itemByID(id: number): GotoNextStateBehavior; /** * Returns the GotoNextStateBehavior with the specified name. * @param name The name. */ itemByName(name: string): GotoNextStateBehavior; /** * Returns the GotoNextStateBehaviors within the specified range. * @param from The GotoNextStateBehavior, index, or name at the beginning of the range. Can accept: GotoNextStateBehavior, Long Integer or String. * @param to The GotoNextStateBehavior, index, or name at the end of the range. Can accept: GotoNextStateBehavior, Long Integer or String. */ itemByRange(from: GotoNextStateBehavior | number | string, to: GotoNextStateBehavior | number | string): GotoNextStateBehavior[]; /** * Returns the last GotoNextStateBehavior in the collection. */ lastItem(): GotoNextStateBehavior; /** * Returns the middle GotoNextStateBehavior in the collection. */ middleItem(): GotoNextStateBehavior; /** * Returns the GotoNextStateBehavior whose index follows the specified * GotoNextStateBehavior in the collection. * @param obj The GotoNextStateBehavior whose index comes before the desired GotoNextStateBehavior. */ nextItem(obj: GotoNextStateBehavior): GotoNextStateBehavior; /** * Returns the GotoNextStateBehavior with the index previous to the specified * index. * @param obj The index of the GotoNextStateBehavior that follows the desired GotoNextStateBehavior. */ previousItem(obj: GotoNextStateBehavior): GotoNextStateBehavior; /** * Generates a string which, if executed, will return the * GotoNextStateBehavior. */ toSource(): string; } /** * A behavior object that jumps to the next view. */ declare class GotoNextViewBehavior extends Behavior { /** * The event which triggers the behavior. */ behaviorEvent: BehaviorEvents; /** * If true, the behavior is enabled. */ enableBehavior: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the GotoNextViewBehavior. */ readonly id: number; /** * The index of the GotoNextViewBehavior within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the GotoNextViewBehavior. */ readonly name: string; /** * The parent of the GotoNextViewBehavior (a Button, CheckBox, ComboBox, * ListBox, RadioButton, TextBox or SignatureField). */ readonly parent: CheckBox | ComboBox | ListBox | RadioButton | TextBox | Button | SignatureField; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The zoom setting. */ zoomSetting: GoToZoomOptions; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GotoNextViewBehavior[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the GotoNextViewBehavior. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the GotoNextViewBehavior. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of goto next view behavior objects. */ declare class GotoNextViewBehaviors { /** Returns the GotoNextViewBehavior with the specified index or name. */ [index: number]: GotoNextViewBehavior; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new GotoNextViewBehavior. * @param withProperties Initial values for properties of the new GotoNextViewBehavior (Optional) */ add(withProperties?: Object): GotoNextViewBehavior; /** * Returns any GotoNextViewBehavior in the collection. */ anyItem(): GotoNextViewBehavior; /** * Displays the number of elements in the GotoNextViewBehavior. */ count(): number; /** * Returns every GotoNextViewBehavior in the collection. */ everyItem(): GotoNextViewBehavior; /** * Returns the first GotoNextViewBehavior in the collection. */ firstItem(): GotoNextViewBehavior; /** * Returns the GotoNextViewBehavior with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): GotoNextViewBehavior; /** * Returns the GotoNextViewBehavior with the specified ID. * @param id The ID. */ itemByID(id: number): GotoNextViewBehavior; /** * Returns the GotoNextViewBehavior with the specified name. * @param name The name. */ itemByName(name: string): GotoNextViewBehavior; /** * Returns the GotoNextViewBehaviors within the specified range. * @param from The GotoNextViewBehavior, index, or name at the beginning of the range. Can accept: GotoNextViewBehavior, Long Integer or String. * @param to The GotoNextViewBehavior, index, or name at the end of the range. Can accept: GotoNextViewBehavior, Long Integer or String. */ itemByRange(from: GotoNextViewBehavior | number | string, to: GotoNextViewBehavior | number | string): GotoNextViewBehavior[]; /** * Returns the last GotoNextViewBehavior in the collection. */ lastItem(): GotoNextViewBehavior; /** * Returns the middle GotoNextViewBehavior in the collection. */ middleItem(): GotoNextViewBehavior; /** * Returns the GotoNextViewBehavior whose index follows the specified * GotoNextViewBehavior in the collection. * @param obj The GotoNextViewBehavior whose index comes before the desired GotoNextViewBehavior. */ nextItem(obj: GotoNextViewBehavior): GotoNextViewBehavior; /** * Returns the GotoNextViewBehavior with the index previous to the specified * index. * @param obj The index of the GotoNextViewBehavior that follows the desired GotoNextViewBehavior. */ previousItem(obj: GotoNextViewBehavior): GotoNextViewBehavior; /** * Generates a string which, if executed, will return the GotoNextViewBehavior. */ toSource(): string; } /** * A behavior object that jumps to a specific page of the document. */ declare class GotoPageBehavior extends Behavior { /** * The event which triggers the behavior. */ behaviorEvent: BehaviorEvents; /** * If true, the behavior is enabled. */ enableBehavior: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the GotoPageBehavior. */ readonly id: number; /** * The index of the GotoPageBehavior within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the GotoPageBehavior. */ readonly name: string; /** * The page number to go to expressed as an index where 1 is the first page. */ pageNumber: number; /** * The parent of the GotoPageBehavior (a Button). */ readonly parent: Button; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The zoom setting. */ zoomSetting: GoToZoomOptions; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GotoPageBehavior[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the GotoPageBehavior. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the GotoPageBehavior. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of go to page behavior objects. */ declare class GotoPageBehaviors { /** Returns the GotoPageBehavior with the specified index or name. */ [index: number]: GotoPageBehavior; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new GotoPageBehavior. * @param withProperties Initial values for properties of the new GotoPageBehavior (Optional) */ add(withProperties?: Object): GotoPageBehavior; /** * Returns any GotoPageBehavior in the collection. */ anyItem(): GotoPageBehavior; /** * Displays the number of elements in the GotoPageBehavior. */ count(): number; /** * Returns every GotoPageBehavior in the collection. */ everyItem(): GotoPageBehavior; /** * Returns the first GotoPageBehavior in the collection. */ firstItem(): GotoPageBehavior; /** * Returns the GotoPageBehavior with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): GotoPageBehavior; /** * Returns the GotoPageBehavior with the specified ID. * @param id The ID. */ itemByID(id: number): GotoPageBehavior; /** * Returns the GotoPageBehavior with the specified name. * @param name The name. */ itemByName(name: string): GotoPageBehavior; /** * Returns the GotoPageBehaviors within the specified range. * @param from The GotoPageBehavior, index, or name at the beginning of the range. Can accept: GotoPageBehavior, Long Integer or String. * @param to The GotoPageBehavior, index, or name at the end of the range. Can accept: GotoPageBehavior, Long Integer or String. */ itemByRange(from: GotoPageBehavior | number | string, to: GotoPageBehavior | number | string): GotoPageBehavior[]; /** * Returns the last GotoPageBehavior in the collection. */ lastItem(): GotoPageBehavior; /** * Returns the middle GotoPageBehavior in the collection. */ middleItem(): GotoPageBehavior; /** * Returns the GotoPageBehavior whose index follows the specified * GotoPageBehavior in the collection. * @param obj The GotoPageBehavior whose index comes before the desired GotoPageBehavior. */ nextItem(obj: GotoPageBehavior): GotoPageBehavior; /** * Returns the GotoPageBehavior with the index previous to the specified index. * @param obj The index of the GotoPageBehavior that follows the desired GotoPageBehavior. */ previousItem(obj: GotoPageBehavior): GotoPageBehavior; /** * Generates a string which, if executed, will return the GotoPageBehavior. */ toSource(): string; } /** * A behavior object that jumps to the previous page in the document. */ declare class GotoPreviousPageBehavior extends Behavior { /** * The event which triggers the behavior. */ behaviorEvent: BehaviorEvents; /** * If true, the behavior is enabled. */ enableBehavior: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the GotoPreviousPageBehavior. */ readonly id: number; /** * The index of the GotoPreviousPageBehavior within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the GotoPreviousPageBehavior. */ readonly name: string; /** * The parent of the GotoPreviousPageBehavior (a Button, CheckBox, ComboBox, * ListBox, RadioButton, TextBox or SignatureField). */ readonly parent: CheckBox | ComboBox | ListBox | RadioButton | TextBox | Button | SignatureField; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The zoom setting. */ zoomSetting: GoToZoomOptions; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GotoPreviousPageBehavior[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the GotoPreviousPageBehavior. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * GotoPreviousPageBehavior. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of goto previous page behavior objects. */ declare class GotoPreviousPageBehaviors { /** Returns the GotoPreviousPageBehavior with the specified index or name. */ [index: number]: GotoPreviousPageBehavior; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new GotoPreviousPageBehavior. * @param withProperties Initial values for properties of the new GotoPreviousPageBehavior (Optional) */ add(withProperties?: Object): GotoPreviousPageBehavior; /** * Returns any GotoPreviousPageBehavior in the collection. */ anyItem(): GotoPreviousPageBehavior; /** * Displays the number of elements in the GotoPreviousPageBehavior. */ count(): number; /** * Returns every GotoPreviousPageBehavior in the collection. */ everyItem(): GotoPreviousPageBehavior; /** * Returns the first GotoPreviousPageBehavior in the collection. */ firstItem(): GotoPreviousPageBehavior; /** * Returns the GotoPreviousPageBehavior with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): GotoPreviousPageBehavior; /** * Returns the GotoPreviousPageBehavior with the specified ID. * @param id The ID. */ itemByID(id: number): GotoPreviousPageBehavior; /** * Returns the GotoPreviousPageBehavior with the specified name. * @param name The name. */ itemByName(name: string): GotoPreviousPageBehavior; /** * Returns the GotoPreviousPageBehaviors within the specified range. * @param from The GotoPreviousPageBehavior, index, or name at the beginning of the range. Can accept: GotoPreviousPageBehavior, Long Integer or String. * @param to The GotoPreviousPageBehavior, index, or name at the end of the range. Can accept: GotoPreviousPageBehavior, Long Integer or String. */ itemByRange(from: GotoPreviousPageBehavior | number | string, to: GotoPreviousPageBehavior | number | string): GotoPreviousPageBehavior[]; /** * Returns the last GotoPreviousPageBehavior in the collection. */ lastItem(): GotoPreviousPageBehavior; /** * Returns the middle GotoPreviousPageBehavior in the collection. */ middleItem(): GotoPreviousPageBehavior; /** * Returns the GotoPreviousPageBehavior whose index follows the specified * GotoPreviousPageBehavior in the collection. * @param obj The GotoPreviousPageBehavior whose index comes before the desired GotoPreviousPageBehavior. */ nextItem(obj: GotoPreviousPageBehavior): GotoPreviousPageBehavior; /** * Returns the GotoPreviousPageBehavior with the index previous to the * specified index. * @param obj The index of the GotoPreviousPageBehavior that follows the desired GotoPreviousPageBehavior. */ previousItem(obj: GotoPreviousPageBehavior): GotoPreviousPageBehavior; /** * Generates a string which, if executed, will return the * GotoPreviousPageBehavior. */ toSource(): string; } /** * A goto previous state behavior. */ declare class GotoPreviousStateBehavior extends Behavior { /** * The associated multi-state object page item. */ associatedMultiStateObject: MultiStateObject; /** * The event which triggers the behavior. */ behaviorEvent: BehaviorEvents; /** * If true, the behavior is enabled. */ enableBehavior: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the GotoPreviousStateBehavior. */ readonly id: number; /** * The index of the GotoPreviousStateBehavior within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * If true, will loop to the next or previous state. */ loopsToNextOrPrevious: boolean; /** * The name of the GotoPreviousStateBehavior. */ readonly name: string; /** * The parent of the GotoPreviousStateBehavior (a Button). */ readonly parent: Button; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GotoPreviousStateBehavior[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the GotoPreviousStateBehavior. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * GotoPreviousStateBehavior. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of goto previous state behaviors. */ declare class GotoPreviousStateBehaviors { /** Returns the GotoPreviousStateBehavior with the specified index or name. */ [index: number]: GotoPreviousStateBehavior; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new GotoPreviousStateBehavior. * @param withProperties Initial values for properties of the new GotoPreviousStateBehavior (Optional) */ add(withProperties?: Object): GotoPreviousStateBehavior; /** * Returns any GotoPreviousStateBehavior in the collection. */ anyItem(): GotoPreviousStateBehavior; /** * Displays the number of elements in the GotoPreviousStateBehavior. */ count(): number; /** * Returns every GotoPreviousStateBehavior in the collection. */ everyItem(): GotoPreviousStateBehavior; /** * Returns the first GotoPreviousStateBehavior in the collection. */ firstItem(): GotoPreviousStateBehavior; /** * Returns the GotoPreviousStateBehavior with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): GotoPreviousStateBehavior; /** * Returns the GotoPreviousStateBehavior with the specified ID. * @param id The ID. */ itemByID(id: number): GotoPreviousStateBehavior; /** * Returns the GotoPreviousStateBehavior with the specified name. * @param name The name. */ itemByName(name: string): GotoPreviousStateBehavior; /** * Returns the GotoPreviousStateBehaviors within the specified range. * @param from The GotoPreviousStateBehavior, index, or name at the beginning of the range. Can accept: GotoPreviousStateBehavior, Long Integer or String. * @param to The GotoPreviousStateBehavior, index, or name at the end of the range. Can accept: GotoPreviousStateBehavior, Long Integer or String. */ itemByRange(from: GotoPreviousStateBehavior | number | string, to: GotoPreviousStateBehavior | number | string): GotoPreviousStateBehavior[]; /** * Returns the last GotoPreviousStateBehavior in the collection. */ lastItem(): GotoPreviousStateBehavior; /** * Returns the middle GotoPreviousStateBehavior in the collection. */ middleItem(): GotoPreviousStateBehavior; /** * Returns the GotoPreviousStateBehavior whose index follows the specified * GotoPreviousStateBehavior in the collection. * @param obj The GotoPreviousStateBehavior whose index comes before the desired GotoPreviousStateBehavior. */ nextItem(obj: GotoPreviousStateBehavior): GotoPreviousStateBehavior; /** * Returns the GotoPreviousStateBehavior with the index previous to the * specified index. * @param obj The index of the GotoPreviousStateBehavior that follows the desired GotoPreviousStateBehavior. */ previousItem(obj: GotoPreviousStateBehavior): GotoPreviousStateBehavior; /** * Generates a string which, if executed, will return the * GotoPreviousStateBehavior. */ toSource(): string; } /** * A behavior object that jumps to the previous view. */ declare class GotoPreviousViewBehavior extends Behavior { /** * The event which triggers the behavior. */ behaviorEvent: BehaviorEvents; /** * If true, the behavior is enabled. */ enableBehavior: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the GotoPreviousViewBehavior. */ readonly id: number; /** * The index of the GotoPreviousViewBehavior within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the GotoPreviousViewBehavior. */ readonly name: string; /** * The parent of the GotoPreviousViewBehavior (a Button, CheckBox, ComboBox, * ListBox, RadioButton, TextBox or SignatureField). */ readonly parent: CheckBox | ComboBox | ListBox | RadioButton | TextBox | Button | SignatureField; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The zoom setting. */ zoomSetting: GoToZoomOptions; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GotoPreviousViewBehavior[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the GotoPreviousViewBehavior. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * GotoPreviousViewBehavior. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of goto previous view behavior objects. */ declare class GotoPreviousViewBehaviors { /** Returns the GotoPreviousViewBehavior with the specified index or name. */ [index: number]: GotoPreviousViewBehavior; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new GotoPreviousViewBehavior. * @param withProperties Initial values for properties of the new GotoPreviousViewBehavior (Optional) */ add(withProperties?: Object): GotoPreviousViewBehavior; /** * Returns any GotoPreviousViewBehavior in the collection. */ anyItem(): GotoPreviousViewBehavior; /** * Displays the number of elements in the GotoPreviousViewBehavior. */ count(): number; /** * Returns every GotoPreviousViewBehavior in the collection. */ everyItem(): GotoPreviousViewBehavior; /** * Returns the first GotoPreviousViewBehavior in the collection. */ firstItem(): GotoPreviousViewBehavior; /** * Returns the GotoPreviousViewBehavior with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): GotoPreviousViewBehavior; /** * Returns the GotoPreviousViewBehavior with the specified ID. * @param id The ID. */ itemByID(id: number): GotoPreviousViewBehavior; /** * Returns the GotoPreviousViewBehavior with the specified name. * @param name The name. */ itemByName(name: string): GotoPreviousViewBehavior; /** * Returns the GotoPreviousViewBehaviors within the specified range. * @param from The GotoPreviousViewBehavior, index, or name at the beginning of the range. Can accept: GotoPreviousViewBehavior, Long Integer or String. * @param to The GotoPreviousViewBehavior, index, or name at the end of the range. Can accept: GotoPreviousViewBehavior, Long Integer or String. */ itemByRange(from: GotoPreviousViewBehavior | number | string, to: GotoPreviousViewBehavior | number | string): GotoPreviousViewBehavior[]; /** * Returns the last GotoPreviousViewBehavior in the collection. */ lastItem(): GotoPreviousViewBehavior; /** * Returns the middle GotoPreviousViewBehavior in the collection. */ middleItem(): GotoPreviousViewBehavior; /** * Returns the GotoPreviousViewBehavior whose index follows the specified * GotoPreviousViewBehavior in the collection. * @param obj The GotoPreviousViewBehavior whose index comes before the desired GotoPreviousViewBehavior. */ nextItem(obj: GotoPreviousViewBehavior): GotoPreviousViewBehavior; /** * Returns the GotoPreviousViewBehavior with the index previous to the * specified index. * @param obj The index of the GotoPreviousViewBehavior that follows the desired GotoPreviousViewBehavior. */ previousItem(obj: GotoPreviousViewBehavior): GotoPreviousViewBehavior; /** * Generates a string which, if executed, will return the * GotoPreviousViewBehavior. */ toSource(): string; } /** * A goto state behavior. */ declare class GotoStateBehavior extends Behavior { /** * The associated multi-state object page item. */ associatedMultiStateObject: MultiStateObject; /** * The event which triggers the behavior. */ behaviorEvent: BehaviorEvents; /** * If true, the behavior is enabled. */ enableBehavior: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, will automatically go back to the prior state on roll off of the * rollover event. */ goBackOnRollOff: boolean; /** * The unique ID of the GotoStateBehavior. */ readonly id: number; /** * The index of the GotoStateBehavior within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the GotoStateBehavior. */ readonly name: string; /** * The parent of the GotoStateBehavior (a Button). */ readonly parent: Button; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The name of the state in the associated multi-state object. */ stateName: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GotoStateBehavior[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the GotoStateBehavior. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the GotoStateBehavior. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of goto state behaviors. */ declare class GotoStateBehaviors { /** Returns the GotoStateBehavior with the specified index or name. */ [index: number]: GotoStateBehavior; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new GotoStateBehavior. * @param withProperties Initial values for properties of the new GotoStateBehavior (Optional) */ add(withProperties?: Object): GotoStateBehavior; /** * Returns any GotoStateBehavior in the collection. */ anyItem(): GotoStateBehavior; /** * Displays the number of elements in the GotoStateBehavior. */ count(): number; /** * Returns every GotoStateBehavior in the collection. */ everyItem(): GotoStateBehavior; /** * Returns the first GotoStateBehavior in the collection. */ firstItem(): GotoStateBehavior; /** * Returns the GotoStateBehavior with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): GotoStateBehavior; /** * Returns the GotoStateBehavior with the specified ID. * @param id The ID. */ itemByID(id: number): GotoStateBehavior; /** * Returns the GotoStateBehavior with the specified name. * @param name The name. */ itemByName(name: string): GotoStateBehavior; /** * Returns the GotoStateBehaviors within the specified range. * @param from The GotoStateBehavior, index, or name at the beginning of the range. Can accept: GotoStateBehavior, Long Integer or String. * @param to The GotoStateBehavior, index, or name at the end of the range. Can accept: GotoStateBehavior, Long Integer or String. */ itemByRange(from: GotoStateBehavior | number | string, to: GotoStateBehavior | number | string): GotoStateBehavior[]; /** * Returns the last GotoStateBehavior in the collection. */ lastItem(): GotoStateBehavior; /** * Returns the middle GotoStateBehavior in the collection. */ middleItem(): GotoStateBehavior; /** * Returns the GotoStateBehavior whose index follows the specified * GotoStateBehavior in the collection. * @param obj The GotoStateBehavior whose index comes before the desired GotoStateBehavior. */ nextItem(obj: GotoStateBehavior): GotoStateBehavior; /** * Returns the GotoStateBehavior with the index previous to the specified * index. * @param obj The index of the GotoStateBehavior that follows the desired GotoStateBehavior. */ previousItem(obj: GotoStateBehavior): GotoStateBehavior; /** * Generates a string which, if executed, will return the GotoStateBehavior. */ toSource(): string; } /** * A behavior object that jumps to a URL. */ declare class GotoURLBehavior extends Behavior { /** * The event which triggers the behavior. */ behaviorEvent: BehaviorEvents; /** * If true, the behavior is enabled. */ enableBehavior: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the GotoURLBehavior. */ readonly id: number; /** * The index of the GotoURLBehavior within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the GotoURLBehavior. */ readonly name: string; /** * The parent of the GotoURLBehavior (a Button, CheckBox, ComboBox, ListBox, * RadioButton, TextBox or SignatureField). */ readonly parent: CheckBox | ComboBox | ListBox | RadioButton | TextBox | Button | SignatureField; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The URL. */ url: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GotoURLBehavior[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the GotoURLBehavior. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the GotoURLBehavior. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of goto URL behavior objects. */ declare class GotoURLBehaviors { /** Returns the GotoURLBehavior with the specified index or name. */ [index: number]: GotoURLBehavior; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new GotoURLBehavior. * @param withProperties Initial values for properties of the new GotoURLBehavior (Optional) */ add(withProperties?: Object): GotoURLBehavior; /** * Returns any GotoURLBehavior in the collection. */ anyItem(): GotoURLBehavior; /** * Displays the number of elements in the GotoURLBehavior. */ count(): number; /** * Returns every GotoURLBehavior in the collection. */ everyItem(): GotoURLBehavior; /** * Returns the first GotoURLBehavior in the collection. */ firstItem(): GotoURLBehavior; /** * Returns the GotoURLBehavior with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): GotoURLBehavior; /** * Returns the GotoURLBehavior with the specified ID. * @param id The ID. */ itemByID(id: number): GotoURLBehavior; /** * Returns the GotoURLBehavior with the specified name. * @param name The name. */ itemByName(name: string): GotoURLBehavior; /** * Returns the GotoURLBehaviors within the specified range. * @param from The GotoURLBehavior, index, or name at the beginning of the range. Can accept: GotoURLBehavior, Long Integer or String. * @param to The GotoURLBehavior, index, or name at the end of the range. Can accept: GotoURLBehavior, Long Integer or String. */ itemByRange(from: GotoURLBehavior | number | string, to: GotoURLBehavior | number | string): GotoURLBehavior[]; /** * Returns the last GotoURLBehavior in the collection. */ lastItem(): GotoURLBehavior; /** * Returns the middle GotoURLBehavior in the collection. */ middleItem(): GotoURLBehavior; /** * Returns the GotoURLBehavior whose index follows the specified * GotoURLBehavior in the collection. * @param obj The GotoURLBehavior whose index comes before the desired GotoURLBehavior. */ nextItem(obj: GotoURLBehavior): GotoURLBehavior; /** * Returns the GotoURLBehavior with the index previous to the specified index. * @param obj The index of the GotoURLBehavior that follows the desired GotoURLBehavior. */ previousItem(obj: GotoURLBehavior): GotoURLBehavior; /** * Generates a string which, if executed, will return the GotoURLBehavior. */ toSource(): string; } /** * GPU performance settings for the application. */ declare class GpuPerformancePreference extends Preference { /** * If true, enables animated zoom. */ enableAnimatedZoom: boolean; /** * If true, enables GPU performance. */ enableGpuPerformance: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the GpuPerformancePreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GpuPerformancePreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * GpuPerformancePreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Grabber preferences. */ declare class GrabberPreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The display performance quality setting to use when scrolling. */ grabberPanning: PanningTypes; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the GrabberPreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GrabberPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the GrabberPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A gradient. */ declare class Gradient extends Swatch { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * A collection of gradient stops. */ readonly gradientStops: GradientStops; /** * The unique ID of the Gradient. */ readonly id: number; /** * The index of the Gradient within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the Gradient. */ name: string; /** * The parent of the Gradient (a Application or Document). */ readonly parent: Application | Document; /** * The color group that a swatch belongs to */ readonly parentColorGroup: ColorGroup; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The gradient type. */ type: GradientType; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the Gradient. */ duplicate(): Gradient; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Gradient[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Merges the specified swatches with the swatch. * @param with_ The swatches to merge. Can accept: Array of Swatches, Swatch or String. */ merge(with_: (Swatches | Swatch | string)[]): Swatch; /** * Deletes the swatch. * @param replacingWith The swatch to apply in place of the deleted swatch. (Optional) */ remove(replacingWith?: Swatch): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Gradient. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Gradient feather effect settings. */ declare class GradientFeatherSetting extends Preference { /** * The angle of the gradient feather. * @remarks Range: -180 to 180 */ angle: number; /** * If true, the gradient feather effect is applied. */ applied: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The center point (for a radial gradient) or starting point (for a linear * gradient) applied to the fill, as page coordinates in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStart: (number | string)[]; /** * The hilite angle of the radial gradient feather. */ hiliteAngle: number; /** * The hilite length of the radial gradient feather. * @remarks Measurement unit — also accepts a string such as "12mm". */ hiliteLength: number | string; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The length of the axial gradient, or radius of the radial gradient. * @remarks Measurement unit — also accepts a string such as "12mm". */ length: number | string; /** * A collection of opacity gradient stops. */ readonly opacityGradientStops: OpacityGradientStops; /** * The parent of the GradientFeatherSetting (a TransparencySetting, * StrokeTransparencySetting, FillTransparencySetting or * ContentTransparencySetting). */ readonly parent: FillTransparencySetting | StrokeTransparencySetting | ContentTransparencySetting | TransparencySetting; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The type of gradient. */ type: GradientType; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GradientFeatherSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * GradientFeatherSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A gradient stop in a gradient. */ declare class GradientStop { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the GradientStop within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The starting location (as a percentage of the gradient length) of the * gradient stop on the gradient. (Range: 0 to 100). * @remarks Range: 0 to 100 */ location: number; /** * The mid-point (as a percentage of the gradient length) of the gradient stop. * (Range: 13 to 87) * @remarks Range: 13 to 87 */ midpoint: number; /** * The parent of the GradientStop (a Gradient). */ readonly parent: Gradient; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gradient * stop. Can return: MixedInk or Color. */ stopColor: MixedInk | Color; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GradientStop[]; /** * Deletes the GradientStop. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the GradientStop. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of gradient stops. */ declare class GradientStops { /** Returns the GradientStop with the specified index or name. */ [index: number]: GradientStop; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new GradientStop. * @param withProperties Initial values for properties of the new GradientStop (Optional) */ add(withProperties?: Object): GradientStop; /** * Returns any GradientStop in the collection. */ anyItem(): GradientStop; /** * Displays the number of elements in the GradientStop. */ count(): number; /** * Returns every GradientStop in the collection. */ everyItem(): GradientStop; /** * Returns the first GradientStop in the collection. */ firstItem(): GradientStop; /** * Returns the GradientStop with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): GradientStop; /** * Returns the GradientStops within the specified range. * @param from The GradientStop, index, or name at the beginning of the range. Can accept: GradientStop, Long Integer or String. * @param to The GradientStop, index, or name at the end of the range. Can accept: GradientStop, Long Integer or String. */ itemByRange(from: GradientStop | number | string, to: GradientStop | number | string): GradientStop[]; /** * Returns the last GradientStop in the collection. */ lastItem(): GradientStop; /** * Returns the middle GradientStop in the collection. */ middleItem(): GradientStop; /** * Returns the GradientStop whose index follows the specified GradientStop in * the collection. * @param obj The GradientStop whose index comes before the desired GradientStop. */ nextItem(obj: GradientStop): GradientStop; /** * Returns the GradientStop with the index previous to the specified index. * @param obj The index of the GradientStop that follows the desired GradientStop. */ previousItem(obj: GradientStop): GradientStop; /** * Generates a string which, if executed, will return the GradientStop. */ toSource(): string; } /** * Gradient type options. */ declare enum GradientType { /** * A linear gradient. */ LINEAR = 1635282023, /** * A radial gradient. */ RADIAL = 1918985319, } /** * A collection of gradients. */ declare class Gradients { /** Returns the Gradient with the specified index or name. */ [index: number]: Gradient; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new Gradient. * @param withProperties Initial values for properties of the new Gradient (Optional) */ add(withProperties?: Object): Gradient; /** * Returns any Gradient in the collection. */ anyItem(): Gradient; /** * Displays the number of elements in the Gradient. */ count(): number; /** * Returns every Gradient in the collection. */ everyItem(): Gradient; /** * Returns the first Gradient in the collection. */ firstItem(): Gradient; /** * Returns the Gradient with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Gradient; /** * Returns the Gradient with the specified ID. * @param id The ID. */ itemByID(id: number): Gradient; /** * Returns the Gradient with the specified name. * @param name The name. */ itemByName(name: string): Gradient; /** * Returns the Gradients within the specified range. * @param from The Gradient, index, or name at the beginning of the range. Can accept: Gradient, Long Integer or String. * @param to The Gradient, index, or name at the end of the range. Can accept: Gradient, Long Integer or String. */ itemByRange(from: Gradient | number | string, to: Gradient | number | string): Gradient[]; /** * Returns the last Gradient in the collection. */ lastItem(): Gradient; /** * Returns the middle Gradient in the collection. */ middleItem(): Gradient; /** * Returns the Gradient whose index follows the specified Gradient in the * collection. * @param obj The Gradient whose index comes before the desired Gradient. */ nextItem(obj: Gradient): Gradient; /** * Returns the Gradient with the index previous to the specified index. * @param obj The index of the Gradient that follows the desired Gradient. */ previousItem(obj: Gradient): Gradient; /** * Generates a string which, if executed, will return the Gradient. */ toSource(): string; } /** * An imported graphic in any graphic file format (including vector, metafile, * and bitmap formats). */ declare class Graphic extends PageItem { /** * Indicates whether the Graphic has been flipped independently of its parent * object and, if yes, the direction in which the Graphic was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the Graphic relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the Graphic relative to its containing object. (Range: * -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the Graphic relative to its containing object. (Range: * -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the Graphic relative to its containing object. */ absoluteVerticalScale: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the Graphic. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the Graphic. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the Graphic. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the Graphic. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the Graphic. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * Transparency settings for the content of the Graphic. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the Graphic. */ endJoin: EndJoin; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * Graphic. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the Graphic's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the Graphic. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the Graphic excluding the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the Graphic. (Range: * -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the Graphic. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the Graphic, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the Graphic. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the Graphic. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the Graphic, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the Graphic. */ horizontalScale: number; /** * The unique ID of the Graphic. */ readonly id: number; /** * The type of the image. */ readonly imageTypeName: string; /** * The index of the Graphic within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the Graphic is on. */ itemLayer: Layer; /** * The source file of the link. */ readonly itemLink: Link; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the Graphic. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the Graphic is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * The name of the Graphic. */ name: string; /** * If true, the Graphic does not print. */ nonprinting: boolean; /** * If true, the Graphic's fill color overprints any underlying objects. If * false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the Graphic's stroke color overprints any underlying objects. If * false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the Graphic (a Snippet, XMLElement, Sound, PlaceGun, Movie, * TextBox, SignatureField, ComboBox, ListBox, CheckBox, RadioButton, Polygon, * GraphicLine, Rectangle, Oval, SplineItem, State, Button, MultiStateObject, * HtmlItem, FlexObject, FormField, MediaItem, EPSText, SVG, ImportedPage, * PICT, WMF, PDF, EPS, Image, Graphic, Group, EndnoteTextFrame, TextFrame, * PageItem or Spread). */ readonly parent: Button | CheckBox | ComboBox | EPS | EPSText | EndnoteTextFrame | FlexObject | FormField | Graphic | GraphicLine | Group | HtmlItem | Image | ImportedPage | ListBox | MediaItem | Movie | MultiStateObject | Oval | PDF | PICT | PageItem | PlaceGun | Polygon | RadioButton | Rectangle | SVG | SignatureField | Sound | SplineItem | State | TextBox | TextFrame | WMF | XMLElement | Snippet | Spread; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the Graphic. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the Graphic. (Range: -360 to 360) */ shearAngle: number; /** * The stroke alignment applied to the Graphic. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the Graphic. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the Graphic. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the Graphic's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the Graphic. */ verticalScale: number; /** * If true, the Graphic is visible. */ visible: boolean; /** * The bounds of the Graphic including the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * Dispatched after a Graphic is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a Graphic is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the Graphic's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the Graphic that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the Graphic. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the Graphic to a different shape. * @param given The Graphic's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Graphic. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Graphic. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Graphic. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Graphic. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Graphic. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the Graphic at the specified location or offset. * @param to The location of the new Graphic, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new Graphic from the original Graphic's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Exports the Graphic for the web. * @param to The full path name of the exported file. */ exportForWeb(to: File): string[]; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the Graphic. * @param given The axis around which to flip the Graphic. * @param around The point around which to flip the Graphic. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Graphic[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the Graphic to a new location. Note: Either the 'to' or 'by' parameter * is required; if both parameters are defined, only the to value is used. * @param to The new location of the Graphic,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the Graphic relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the Graphic. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the Graphic in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new Graphic (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the Graphic. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the Graphic using the last transformation performed on any * object. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgain(): string[]; /** * Transforms the Graphic using the last transformation performed on any * Graphic. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgainIndividually(): string[]; /** * Transforms the Graphic using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the Graphic using the last sequence of transformations performed * on any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * A layer in a PSD image or PDF file. */ declare class GraphicLayer { /** * If true, the layer is an adjustment layer. Note: Must occur in the script * before overriding the visibility state of the layer with a current * visibility statement. */ readonly adjustmentLayer: boolean; /** * If true, the layer is visible in the document. */ currentVisibility: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, the export state is on. */ readonly exportState: boolean; /** * If true, layer effects have been applied to the layer. Note: Must occur in * the script before overriding the visibility state of the layer with a * current visibility statement. */ readonly fxLayer: boolean; /** * A collection of graphic layers. */ readonly graphicLayers: GraphicLayers; /** * If true, the layer has an export state. */ readonly hasExportState: boolean; /** * If true, the layer has a print state. */ readonly hasPrintState: boolean; /** * If true, the layer has a view state. */ readonly hasViewState: boolean; /** * The unique ID of the GraphicLayer. */ readonly id: number; /** * The index of the GraphicLayer within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * If true, the GraphicLayer is locked. */ readonly locked: boolean; /** * The name of the GraphicLayer. */ readonly name: string; /** * Returns the visibility setting set for the layer before the graphic file was * imported. Note: Must occur in the script before overriding the visibility * state with a current visibility statement. */ readonly originalVisibility: boolean; /** * The parent of the GraphicLayer (a GraphicLayerOption or GraphicLayer). */ readonly parent: GraphicLayer | GraphicLayerOption; /** * If true, the print state is on. */ readonly printState: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, the layer is a section divider layer. */ readonly sectionDividerLayer: boolean; /** * If true, the layer is a separator layer. */ readonly separatorLayer: boolean; /** * If true, the view state is on. */ readonly viewState: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GraphicLayer[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the GraphicLayer. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Graphic layer option. */ declare class GraphicLayerOption extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * A collection of graphic layers. */ readonly graphicLayers: GraphicLayers; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the GraphicLayerOption (a Image, PDF or ImportedPage). */ readonly parent: PDF | Image | ImportedPage; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Options for updating a graphic link after the visibility settings for the * graphic layer have been modified in a different application. */ updateLinkOption: UpdateLinkOptions; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GraphicLayerOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the GraphicLayerOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of graphic layers. */ declare class GraphicLayers { /** Returns the GraphicLayer with the specified index or name. */ [index: number]: GraphicLayer; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any GraphicLayer in the collection. */ anyItem(): GraphicLayer; /** * Displays the number of elements in the GraphicLayer. */ count(): number; /** * Returns every GraphicLayer in the collection. */ everyItem(): GraphicLayer; /** * Returns the first GraphicLayer in the collection. */ firstItem(): GraphicLayer; /** * Returns the GraphicLayer with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): GraphicLayer; /** * Returns the GraphicLayer with the specified ID. * @param id The ID. */ itemByID(id: number): GraphicLayer; /** * Returns the GraphicLayer with the specified name. * @param name The name. */ itemByName(name: string): GraphicLayer; /** * Returns the GraphicLayers within the specified range. * @param from The GraphicLayer, index, or name at the beginning of the range. Can accept: GraphicLayer, Long Integer or String. * @param to The GraphicLayer, index, or name at the end of the range. Can accept: GraphicLayer, Long Integer or String. */ itemByRange(from: GraphicLayer | number | string, to: GraphicLayer | number | string): GraphicLayer[]; /** * Returns the last GraphicLayer in the collection. */ lastItem(): GraphicLayer; /** * Returns the middle GraphicLayer in the collection. */ middleItem(): GraphicLayer; /** * Returns the GraphicLayer whose index follows the specified GraphicLayer in * the collection. * @param obj The GraphicLayer whose index comes before the desired GraphicLayer. */ nextItem(obj: GraphicLayer): GraphicLayer; /** * Returns the GraphicLayer with the index previous to the specified index. * @param obj The index of the GraphicLayer that follows the desired GraphicLayer. */ previousItem(obj: GraphicLayer): GraphicLayer; /** * Generates a string which, if executed, will return the GraphicLayer. */ toSource(): string; } /** * A straight line consisting of two points. */ declare class GraphicLine extends SplineItem { /** * Indicates whether the GraphicLine has been flipped independently of its * parent object and, if yes, the direction in which the GraphicLine was * flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the GraphicLine relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the GraphicLine relative to its containing object. * (Range: -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the GraphicLine relative to its containing object. * (Range: -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the GraphicLine relative to its containing object. */ absoluteVerticalScale: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the GraphicLine. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the GraphicLine. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * Anchored object settings. */ readonly anchoredObjectSettings: AnchoredObjectSetting; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the GraphicLine. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the GraphicLine. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the GraphicLine. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * A collection of buttons. */ readonly buttons: Buttons; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * Transparency settings for the content of the GraphicLine. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The type of content that a frame can contain. */ contentType: ContentType; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the GraphicLine. */ endJoin: EndJoin; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * A collection of EPS files. */ readonly epss: EPSs; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * GraphicLine. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the GraphicLine's fill color. (To specify a * tint percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the GraphicLine. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * A collection of form fields. */ readonly formFields: FormFields; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the GraphicLine excluding the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the GraphicLine. * (Range: -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the GraphicLine. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the GraphicLine, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the GraphicLine. * (Range: -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the GraphicLine. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the GraphicLine, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * A collection of groups. */ readonly groups: Groups; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the GraphicLine. */ horizontalScale: number; /** * A collection of embedded HTML page items. */ readonly htmlItems: HtmlItems; /** * The unique ID of the GraphicLine. */ readonly id: number; /** * A collection of bitmap images in any bitmap file format (including TIFF, * JPEG, or GIF). */ readonly images: Images; /** * Imported InDesign pages. */ readonly importedPages: ImportedPages; /** * The index of the GraphicLine within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the GraphicLine is on. */ itemLayer: Layer; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * Display performance options for the GraphicLine. */ localDisplaySetting: DisplaySettingOptions; /** * The lock state. */ readonly lockState: LockStateValues; /** * If true, the GraphicLine is locked. */ locked: boolean; /** * The media items collection. */ readonly mediaItems: MediaItems; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * A collection of movies. */ readonly movies: Movies; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * The name of the GraphicLine. */ name: string; /** * If true, the GraphicLine does not print. */ nonprinting: boolean; /** * Export options for the object */ readonly objectExportOptions: ObjectExportOption; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the GraphicLine's fill color overprints any underlying objects. If * false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the GraphicLine's stroke color overprints any underlying objects. * If false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the GraphicLine (a Snippet, ComboBox, ListBox, TextBox, * SignatureField, Spread, MasterSpread, SplineItem, Polygon, GraphicLine, * Rectangle, Oval, Group, State, Cell, Character, PlaceGun or FlexObject). */ readonly parent: Cell | Character | ComboBox | GraphicLine | Group | ListBox | MasterSpread | Oval | PlaceGun | Polygon | Rectangle | SignatureField | SplineItem | Spread | State | TextBox | FlexObject | Snippet; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of paths. */ readonly paths: Paths; /** * A collection of PDF files. */ readonly pdfs: PDFs; /** * A collection of PICT graphics. */ readonly picts: PICTs; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the GraphicLine. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the GraphicLine. (Range: -360 to 360) */ shearAngle: number; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * A collection of sound clips. */ readonly sounds: Sounds; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The stroke alignment applied to the GraphicLine. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the GraphicLine. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the GraphicLine. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the GraphicLine's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * A collection of text paths. */ readonly textPaths: TextPaths; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the GraphicLine. */ verticalScale: number; /** * If true, the GraphicLine is visible. */ visible: boolean; /** * The bounds of the GraphicLine including the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * A collection of WMF graphics. */ readonly wmfs: WMFs; /** * Dispatched after a GraphicLine is placed. This event bubbles. This event is * not cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a GraphicLine is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Creates a new page item by combining the GraphicLine with other objects. * Deletes the objects if they do not intersect. * @param with_ The object(s) to add. */ addPath(with_: PageItem[]): PageItem; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the GraphicLine's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the GraphicLine that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Brings the GraphicLine forward one level in its layer. */ bringForward(): void; /** * Brings the GraphicLine to the front of its layer or in front of a particular * item. * @param reference The reference object to bring the object in front of (must have same parent) (Optional) */ bringToFront(reference?: PageItem): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Checks in the story or stories. * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ checkIn(versionComments?: string, forceSave?: boolean): boolean; /** * Checks out the story. */ checkOut(): boolean; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the GraphicLine. Transformations include * rotation, scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the GraphicLine to a different shape. * @param given The GraphicLine's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new GraphicLine. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new GraphicLine. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new GraphicLine. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new GraphicLine. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new GraphicLine. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the GraphicLine at the specified location or offset. * @param to The location of the new GraphicLine, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new GraphicLine from the original GraphicLine's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Creates a new page item by excluding the overlapping areas of the * GraphicLine and other objects. * @param with_ The object(s) to exclude. */ excludeOverlapPath(with_: PageItem[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the GraphicLine. * @param given The axis around which to flip the GraphicLine. * @param around The point around which to flip the GraphicLine. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GraphicLine[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Creates a new page item by intersecting the GraphicLine with other objects. * Returns an error if the objects do not intersect. * @param with_ The object(s) with which to intersect. */ intersectPath(with_: PageItem[]): PageItem; /** * Creates a compound path by combining the path(s) of the GraphicLine with the * paths of other objects. * @param with_ The other objects whose paths to include in the new compound path. */ makeCompoundPath(with_: PageItem[]): PageItem; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Creates a new page item by reverse subtracting the overlapping areas of the * GraphicLine and other objects. * @param with_ The object(s) to reverse subtract. */ minusBack(with_: PageItem[]): PageItem; /** * Moves the GraphicLine to a new location. Note: Either the 'to' or 'by' * parameter is required; if both parameters are defined, only the to value is * used. * @param to The new location of the GraphicLine,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the GraphicLine relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Releases a compound path. */ releaseCompoundPath(): PageItem[]; /** * Deletes the GraphicLine. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Reverts the document to its state at the last save operation. */ revert(): boolean; /** * Selects the object. * @param existingSelection The selection status of the GraphicLine in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Sends the GraphicLine back one level in its layer. */ sendBackward(): void; /** * Sends the GraphicLine to the back of its layer or behind a particular item * (must have same parent). * @param reference The reference object to send the object behind (Optional) */ sendToBack(reference?: PageItem): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new GraphicLine (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Creates a new page item by subtracting the overlapping areas of the * GraphicLine and other objects. * @param with_ The object(s) to subtract. */ subtractPath(with_: PageItem[]): PageItem; /** * Generates a string which, if executed, will return the GraphicLine. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the GraphicLine using the last transformation performed on any * object. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgain(): string[]; /** * Transforms the GraphicLine using the last transformation performed on any * GraphicLine. Transformations include moving, rotating, shearing, scaling, * and flipping. */ transformAgainIndividually(): string[]; /** * Transforms the GraphicLine using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the GraphicLine using the last sequence of transformations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * A collection of graphic lines. */ declare class GraphicLines { /** Returns the GraphicLine with the specified index or name. */ [index: number]: GraphicLine; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new GraphicLine * @param layer The layer on which to create the GraphicLine. (Optional) * @param at The location at which to insert the GraphicLine relative to the reference object or within the container object. (Optional) * @param reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) * @param withProperties Initial values for properties of the new GraphicLine (Optional) */ add(layer?: Layer, at?: LocationOptions, reference?: Document | Layer | MasterSpread | Page | Spread | PageItem, withProperties?: Object): GraphicLine; /** * Returns any GraphicLine in the collection. */ anyItem(): GraphicLine; /** * Displays the number of elements in the GraphicLine. */ count(): number; /** * Returns every GraphicLine in the collection. */ everyItem(): GraphicLine; /** * Returns the first GraphicLine in the collection. */ firstItem(): GraphicLine; /** * Returns the GraphicLine with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): GraphicLine; /** * Returns the GraphicLine with the specified ID. * @param id The ID. */ itemByID(id: number): GraphicLine; /** * Returns the GraphicLine with the specified name. * @param name The name. */ itemByName(name: string): GraphicLine; /** * Returns the GraphicLines within the specified range. * @param from The GraphicLine, index, or name at the beginning of the range. Can accept: GraphicLine, Long Integer or String. * @param to The GraphicLine, index, or name at the end of the range. Can accept: GraphicLine, Long Integer or String. */ itemByRange(from: GraphicLine | number | string, to: GraphicLine | number | string): GraphicLine[]; /** * Returns the last GraphicLine in the collection. */ lastItem(): GraphicLine; /** * Returns the middle GraphicLine in the collection. */ middleItem(): GraphicLine; /** * Returns the GraphicLine whose index follows the specified GraphicLine in the * collection. * @param obj The GraphicLine whose index comes before the desired GraphicLine. */ nextItem(obj: GraphicLine): GraphicLine; /** * Returns the GraphicLine with the index previous to the specified index. * @param obj The index of the GraphicLine that follows the desired GraphicLine. */ previousItem(obj: GraphicLine): GraphicLine; /** * Generates a string which, if executed, will return the GraphicLine. */ toSource(): string; } /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ declare class Graphics { /** Returns the Graphic with the specified index or name. */ [index: number]: Graphic; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Graphic in the collection. */ anyItem(): Graphic; /** * Displays the number of elements in the Graphic. */ count(): number; /** * Returns every Graphic in the collection. */ everyItem(): Graphic; /** * Returns the first Graphic in the collection. */ firstItem(): Graphic; /** * Returns the Graphic with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Graphic; /** * Returns the Graphic with the specified ID. * @param id The ID. */ itemByID(id: number): Graphic; /** * Returns the Graphic with the specified name. * @param name The name. */ itemByName(name: string): Graphic; /** * Returns the Graphics within the specified range. * @param from The Graphic, index, or name at the beginning of the range. Can accept: Graphic, Long Integer or String. * @param to The Graphic, index, or name at the end of the range. Can accept: Graphic, Long Integer or String. */ itemByRange(from: Graphic | number | string, to: Graphic | number | string): Graphic[]; /** * Returns the last Graphic in the collection. */ lastItem(): Graphic; /** * Returns the middle Graphic in the collection. */ middleItem(): Graphic; /** * Returns the Graphic whose index follows the specified Graphic in the * collection. * @param obj The Graphic whose index comes before the desired Graphic. */ nextItem(obj: Graphic): Graphic; /** * Returns the Graphic with the index previous to the specified index. * @param obj The index of the Graphic that follows the desired Graphic. */ previousItem(obj: Graphic): Graphic; /** * Generates a string which, if executed, will return the Graphic. */ toSource(): string; } /** * Alignment options for frame grids or baseline grids. */ declare enum GridAlignment { /** * Aligns the text baseline to the grid. */ ALIGN_BASELINE = 1247896172, /** * Aligns the bottom of the em box to the grid. */ ALIGN_EM_BOTTOM = 1247896173, /** * Aligns the center of the em box to the grid. */ ALIGN_EM_CENTER = 1247896436, /** * Aligns the top of the em box to the grid. */ ALIGN_EM_TOP = 1247900784, /** * Aligns the bottom of the ICF box to the grid. */ ALIGN_ICF_BOTTOM = 1248420461, /** * Aligns the top of the ICF box to the grid. */ ALIGN_ICF_TOP = 1248425072, /** * Lines are not aligned to the grid. */ NONE = 1852796517, } /** * Grid defaults. Note: Applies to named, layout, and frame (story) grids. */ declare class GridDataInformation extends Preference { /** * The font applied to the GridDataInformation, specified as either a font * object or the name of font family. Can return: Font or String. */ appliedFont: Font | string; /** * The amount of white space between characters. */ characterAki: number; /** * The alignment of small characters to the largest character in the line. */ characterAlignment: CharacterAlignment; /** * The character count location. Note: Valid when show character count is true. */ characterCountLocation: CharacterCountLocation; /** * The character size for the character count display. */ characterCountSize: number; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The name of the font style. */ fontStyle: string; /** * The alignment to the frame grid or baseline grid. */ gridAlignment: GridAlignment; /** * The grid view setting. */ gridView: GridViewSettings; /** * The horizontal scaling applied to the GridDataInformation. */ horizontalScale: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The amount of white space between lines. */ lineAki: number; /** * The line justification. */ lineAlignment: LineAlignment; /** * The parent of the GridDataInformation (a Story, XmlStory, Page, NamedGrid, * TextFrame or EndnoteTextFrame). */ readonly parent: NamedGrid | Page | TextFrame | XmlStory | EndnoteTextFrame | Story; /** * The text size. * @remarks Measurement unit — also accepts a string such as "12mm". */ pointSize: number | string; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The vertical scaling applied to the GridDataInformation. */ verticalScale: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GridDataInformation[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the GridDataInformation. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Grid preferences. */ declare class GridPreference extends Preference { /** * The color of the baseline grid, specified either as an array of three * doubles, each in the range 0 to 255, representing R, G, and B values, or as * a UI color. . Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. */ baselineColor: (number[][] | UIColors)[]; /** * The amount of space between baseline grid lines. * @remarks Measurement unit — also accepts a string such as "12mm". */ baselineDivision: number | string; /** * The zero point for the baseline grid offset. */ baselineGridRelativeOption: BaselineGridRelativeOption; /** * If true, displays the baseline grid. */ baselineGridShown: boolean; /** * The amount to offset the baseline grid from the zero point. * @remarks Measurement unit — also accepts a string such as "12mm". */ baselineStart: number | string; /** * The magnification (as a percentage) less than which ruler guides do not * appear. (Range: 5 to 4000) * @remarks Range: 5 to 4000 */ baselineViewThreshold: number; /** * If true, displays the document grid. */ documentGridShown: boolean; /** * If true, an object snaps to the nearest grid line when the object is * created, moved, or resized. */ documentGridSnapto: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The color of the document grid, specified either as an array of three * doubles, each in the range 0 to 255, representing R, G, and B values, or as * a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. */ gridColor: (number[][] | UIColors)[]; /** * If true, places grids behind all other objects on the spread. */ gridsInBack: boolean; /** * The number of rows into which to subdivide the space between horizontal * document grid lines. * @remarks Range: 1 to 1000 */ horizontalGridSubdivision: number; /** * The amount of space between major horizontal lines in the document grid. * @remarks Measurement unit — also accepts a string such as "12mm". */ horizontalGridlineDivision: number | string; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the GridPreference (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The number of columns into which to subdivide the space between vertical * document grid lines. * @remarks Range: 1 to 1000 */ verticalGridSubdivision: number; /** * The amount of space between major vertical lines in the document grid. * @remarks Measurement unit — also accepts a string such as "12mm". */ verticalGridlineDivision: number | string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GridPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the GridPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Grid printing and exporting preferences. */ declare class GridPrintingPreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, displays frame (story) grids in the printed or exported document. */ frameGridPrinting: boolean; /** * The stroke weight (in points) of the frame grid. */ frameGridStrokeWeight: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * If true, displays layout grids in the printed or exported document. */ layoutGridPrinting: boolean; /** * The stroke weight (in points) of the layout grid. */ layoutGridStrokeWeight: number; /** * If true, displays page items other than text, frame grids, and layout grids * in the printed or exported document. For information on printing and * exporting text and grids, see text printing, frame grid printing, and layout * grid printing. */ pageItemPrinting: boolean; /** * The parent of the GridPrintingPreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, displays text in the printed or exported document. */ textPrinting: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GridPrintingPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * GridPrintingPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Grid view options. */ declare enum GridViewSettings { /** * Align view. */ ALIGN_VIEW_ENUM = 1783062902, /** * Grid and ZN view. */ GRID_AND_ZN_VIEW_ENUM = 1783064442, /** * Grid view. */ GRID_VIEW_ENUM = 1783064438, /** * ZN view. */ ZN_VIEW_ENUM = 1783069302, } /** * A group. */ declare class Group extends PageItem { /** * Indicates whether the Group has been flipped independently of its parent * object and, if yes, the direction in which the Group was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the Group relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the Group relative to its containing object. (Range: * -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the Group relative to its containing object. (Range: * -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the Group relative to its containing object. */ absoluteVerticalScale: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the Group. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the Group. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * Anchored object settings. */ readonly anchoredObjectSettings: AnchoredObjectSetting; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the Group. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the Group. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * A collection of group items that are also part of an article. */ readonly articleChildren: ArticleChildren; /** * The XML element associated with the Group. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * A collection of buttons. */ readonly buttons: Buttons; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * Transparency settings for the content of the Group. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the Group. */ endJoin: EndJoin; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * Group. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the Group's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the Group. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * A collection of form fields. */ readonly formFields: FormFields; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the Group excluding the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the Group. (Range: * -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the Group. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the Group, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the Group. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the Group. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the Group, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * A collection of groups. */ readonly groups: Groups; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the Group. */ horizontalScale: number; /** * The unique ID of the Group. */ readonly id: number; /** * The index of the Group within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the Group is on. */ itemLayer: Layer; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * Display performance options for the Group. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the Group is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * The name of the Group. */ name: string; /** * If true, the Group does not print. */ nonprinting: boolean; /** * Export options for the object */ readonly objectExportOptions: ObjectExportOption; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the Group's fill color overprints any underlying objects. If false, * the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the Group's stroke color overprints any underlying objects. If * false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the Group (a Snippet, PlaceGun, ComboBox, ListBox, TextBox, * SignatureField, FlexObject, Spread, MasterSpread, SplineItem, Polygon, * GraphicLine, Rectangle, Oval, Group, State or Character). */ readonly parent: ComboBox | FlexObject | GraphicLine | Group | ListBox | MasterSpread | Oval | PlaceGun | Polygon | Rectangle | SignatureField | SplineItem | Spread | State | TextBox | Character | Snippet; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the Group. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the Group. (Range: -360 to 360) */ shearAngle: number; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The stroke alignment applied to the Group. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the Group. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the Group. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the Group's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the Group. */ verticalScale: number; /** * If true, the Group is visible. */ visible: boolean; /** * The bounds of the Group including the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * Dispatched after a Group is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a Group is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the Group's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the Group that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Brings the Group forward one level in its layer. */ bringForward(): void; /** * Brings the Group to the front of its layer or in front of a particular item. * @param reference The reference object to bring the object in front of (must have same parent) (Optional) */ bringToFront(reference?: PageItem): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the Group. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the Group to a different shape. * @param given The Group's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Group. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Group. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Group. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Group. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Group. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the Group at the specified location or offset. * @param to The location of the new Group, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new Group from the original Group's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the Group. * @param given The axis around which to flip the Group. * @param around The point around which to flip the Group. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Group[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the Group to a new location. Note: Either the 'to' or 'by' parameter * is required; if both parameters are defined, only the to value is used. * @param to The new location of the Group,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the Group relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the Group. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the Group in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Sends the Group back one level in its layer. */ sendBackward(): void; /** * Sends the Group to the back of its layer or behind a particular item (must * have same parent). * @param reference The reference object to send the object behind (Optional) */ sendToBack(reference?: PageItem): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new Group (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the Group. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the Group using the last transformation performed on any object. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformAgain(): string[]; /** * Transforms the Group using the last transformation performed on any Group. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformAgainIndividually(): string[]; /** * Transforms the Group using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the Group using the last sequence of transformations performed on * any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; /** * Ungroups the group. */ ungroup(): void; } /** * A collection of groups. */ declare class Groups { /** Returns the Group with the specified index or name. */ [index: number]: Group; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new Group. * @param groupItems The objects to group. * @param layer The layer on which to create the Group. (Optional) * @param at The location at which to insert the Group relative to the reference object or within the container object. (Optional) * @param reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) * @param withProperties Initial values for properties of the new Group (Optional) */ add(groupItems: PageItem[], layer?: Layer, at?: LocationOptions, reference?: Document | Layer | MasterSpread | Page | Spread | PageItem, withProperties?: Object): Group; /** * Returns any Group in the collection. */ anyItem(): Group; /** * Displays the number of elements in the Group. */ count(): number; /** * Returns every Group in the collection. */ everyItem(): Group; /** * Returns the first Group in the collection. */ firstItem(): Group; /** * Returns the Group with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Group; /** * Returns the Group with the specified ID. * @param id The ID. */ itemByID(id: number): Group; /** * Returns the Group with the specified name. * @param name The name. */ itemByName(name: string): Group; /** * Returns the Groups within the specified range. * @param from The Group, index, or name at the beginning of the range. Can accept: Group, Long Integer or String. * @param to The Group, index, or name at the end of the range. Can accept: Group, Long Integer or String. */ itemByRange(from: Group | number | string, to: Group | number | string): Group[]; /** * Returns the last Group in the collection. */ lastItem(): Group; /** * Returns the middle Group in the collection. */ middleItem(): Group; /** * Returns the Group whose index follows the specified Group in the collection. * @param obj The Group whose index comes before the desired Group. */ nextItem(obj: Group): Group; /** * Returns the Group with the index previous to the specified index. * @param obj The index of the Group that follows the desired Group. */ previousItem(obj: Group): Group; /** * Generates a string which, if executed, will return the Group. */ toSource(): string; } /** * A guide. */ declare class Guide { /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, horizontal orientation guides stop at the edges of the specified * page. If false, the guides extends across the width of the spread and into * the pasteboard area. */ fitToPage: boolean; /** * The color of the guide, specified either as an array of three doubles, each * in the range 0 to 255 and representing R, G, and B values, or as a UI color. * Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. */ guideColor: (number[][] | UIColors)[]; /** * The type of the guide. */ guideType: GuideTypeOptions; /** * The zone of the guide. * @remarks Measurement unit — also accepts a string such as "12mm". */ guideZone: number | string; /** * The unique ID of the Guide. */ readonly id: number; /** * The index of the Guide within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the Guide is on. */ itemLayer: Layer; /** * A property that can be set to any string. */ label: string; /** * The location at which to place the guide relative to the current ruler zero * point. * @remarks Measurement unit — also accepts a string such as "12mm". */ location: number | string; /** * If true, the Guide is locked. */ locked: boolean; /** * The name of the Guide; this is an alias to the Guide's label property. */ name: string; /** * The orientation of the guide. */ orientation: HorizontalOrVertical; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The parent of the Guide (a Spread or MasterSpread). */ readonly parent: MasterSpread | Spread; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The view magnification as a percentage below which guides are no longer * displayed. (Range: 5.0 to 4000.0) * @remarks Range: 5 to 4000 */ viewThreshold: number; /** * Dispatched after a Guide is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the Guide. */ duplicate(): Guide; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Guide[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Moves the guide to a new location. Note: Either the to or the by parameter * is required; if both parameters are defined, only the to value is used. * @param to The new location of the guide, in the format [x, y]. (Optional) * @param by The amount to move the guide relative to its current position, in the format [x, y]. (Optional) */ move(to?: (number | string)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Deletes the Guide. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the Guide in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Generates a string which, if executed, will return the Guide. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * Guide preferences. */ declare class GuidePreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, places guides behind all other objects on the spread. */ guidesInBack: boolean; /** * If true, guides cannot be moved, added, or deleted. */ guidesLocked: boolean; /** * If true, displays the guides. */ guidesShown: boolean; /** * If true, an object within the specified range snaps to the nearest guide * when the object is created, moved, or resized. For range information, see * guide snapto zone. */ guidesSnapto: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the GuidePreference (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The color of the guide, specified either as an array of three doubles, each * in the range 0 to 255 and representing R, G, and B values, or as a UI color. * . Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. */ rulerGuidesColor: (number[][] | UIColors)[]; /** * The magnification (as a percentage) less than which ruler guides do not * appear. (Range: 5 to 4000) * @remarks Range: 5 to 4000 */ rulerGuidesViewThreshold: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): GuidePreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the GuidePreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Guide type options for ruler guides. */ declare enum GuideTypeOptions { /** * Liquid guide. */ LIQUID = 1735617635, /** * Ruler guide (default). */ RULER = 1735618160, } /** * A collection of guides. */ declare class Guides { /** Returns the Guide with the specified index or name. */ [index: number]: Guide; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new guide. * @param layer The layer on which to create the guide. (Optional) * @param withProperties Initial values for properties of the new Guide (Optional) */ add(layer?: Layer, withProperties?: Object): Guide; /** * Returns any Guide in the collection. */ anyItem(): Guide; /** * Displays the number of elements in the Guide. */ count(): number; /** * Returns every Guide in the collection. */ everyItem(): Guide; /** * Returns the first Guide in the collection. */ firstItem(): Guide; /** * Returns the Guide with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Guide; /** * Returns the Guide with the specified ID. * @param id The ID. */ itemByID(id: number): Guide; /** * Returns the Guide with the specified name. * @param name The name. */ itemByName(name: string): Guide; /** * Returns the Guides within the specified range. * @param from The Guide, index, or name at the beginning of the range. Can accept: Guide, Long Integer or String. * @param to The Guide, index, or name at the end of the range. Can accept: Guide, Long Integer or String. */ itemByRange(from: Guide | number | string, to: Guide | number | string): Guide[]; /** * Returns the last Guide in the collection. */ lastItem(): Guide; /** * Returns the middle Guide in the collection. */ middleItem(): Guide; /** * Returns the Guide whose index follows the specified Guide in the collection. * @param obj The Guide whose index comes before the desired Guide. */ nextItem(obj: Guide): Guide; /** * Returns the Guide with the index previous to the specified index. * @param obj The index of the Guide that follows the desired Guide. */ previousItem(obj: Guide): Guide; /** * Generates a string which, if executed, will return the Guide. */ toSource(): string; } /** * HTML export preferences. */ declare class HTMLExportPreference extends Preference { /** * The bullet export option. */ bulletExportOption: BulletListExportOption; /** * Allows user to select the image size option for conversion */ customImageSizeOption: ImageSizeOption; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The export order. */ exportOrder: ExportOrder; /** * If true and have selection, export selected content to HTML. */ exportSelection: boolean; /** * The file path of external cascading style sheets. */ externalStyleSheets: string[]; /** * If true, InDesign will generate cascade style sheet. */ generateCascadeStyleSheet: boolean; /** * If true, generates interlaced GIFs. Note: Not valid when image conversion is * JPEG. */ gifOptionsInterlaced: boolean; /** * The color palette for GIF conversion. Note: Not valid when image conversion * is JPEG. */ gifOptionsPalette: GIFOptionsPalette; /** * ignore object level image conversion settings. */ ignoreObjectConversionSettings: boolean; /** * Alignment applied to images */ imageAlignment: ImageAlignmentType; /** * The file format to use for converted images. Note: Valid only when copy * optimized images and/or copy formatted images is true. */ imageConversion: ImageConversion; /** * The export order. */ imageExportOption: ImageExportOption; /** * The export resolution */ imageExportResolution: ImageResolution; /** * The image extension on server. */ imageExtension: string; /** * Space After applied to images * @remarks Range: 0 to 8640 */ imageSpaceAfter: number; /** * Space Before applied to images * @remarks Range: 0 to 8640 */ imageSpaceBefore: number; /** * If true, InDesign will generate class attributes for elements in HTML, else * will generate plain html without class attributes. */ includeClassesInHTML: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The file path of external javascripts. */ javascripts: string[]; /** * The formatting method for converted JPEG images. Note: Not valid when image * conversion is GIF. */ jpegOptionsFormat: JPEGOptionsFormat; /** * The quality of converted JPEG images. Note: Not valid when image conversion * is GIF. */ jpegOptionsQuality: JPEGOptionsQuality; /** * The PNG compression level. */ level: number; /** * The numbered list export option. */ numberedListExportOption: NumberedListExportOption; /** * The parent of the HTMLExportPreference (a Document). */ readonly parent: Document; /** * If true, format image based on layout appearence. */ preserveLayoutAppearence: boolean; /** * If true, output local style override. */ preserveLocalOverride: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The server path for image . */ serverPath: string; /** * Use SVG As */ useSVGAs: UseSVGAsEnum; /** * If true, open docuemnt in viewer after export. */ viewDocumentAfterExport: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): HTMLExportPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the HTMLExportPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * HTML FXL export preferences. */ declare class HTMLFXLExportPreference extends Preference { /** * The epub page range. */ epubPageRange: string; /** * The epub page range format. */ epubPageRangeFormat: PageRangeFormat; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the HTMLFXLExportPreference (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): HTMLFXLExportPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * HTMLFXLExportPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Position options for header columns in a table. */ declare enum HeaderColumnsPositionTypes { /** * Header columns are the leftmost columns. */ HEADER_COLUMNS_LEFT = 1214467174, /** * Header columns are the rightmost columns. */ HEADER_COLUMNS_RIGHT = 1214468724, } /** * Placement options for header or footer rows. */ declare enum HeaderFooterBreakTypes { /** * Places headers or footers in each text column. */ IN_ALL_TEXT_COLUMNS = 1231115363, /** * Places one instance of headers or footers per page. */ ONCE_PER_PAGE = 1332760673, /** * Repeats headers or footers in each text frame. */ ONCE_PER_TEXT_FRAME = 1332761702, } /** * Indexing sort option header types */ declare enum HeaderTypes { /** * Basic Latin */ BASIC_LATIN = 1213481548, /** * Belarusian */ BELARUSIAN = 1213481573, /** * Bulgarian */ BULGARIAN = 1213481589, /** * Chinese Pinyin */ CHINESE_PINYIN = 1213481808, /** * Chinese Stroke Count */ CHINESE_STROKE_COUNT = 1213481811, /** * Croatian */ CROATIAN = 1213481842, /** * Czech */ CZECH = 1213481850, /** * Danish/Norwegian */ DANISH_NORWEGIAN = 1213482062, /** * Estonian */ ESTONIAN = 1213482355, /** * Finnish/Swedish */ FINNISH_SWEDISH = 1213485894, /** * Hiragana: A, I, U, E, O... */ HIRAGANA_ALL = 1213483073, /** * Hiragana: A, Ka, Sa, Ta, Na... */ HIRAGANA_CONSONANTS_ONLY = 1213483075, /** * Hungarian */ HUNGARIAN = 1213483125, /** * Katakana: A, I, U, E, O... */ KATAKANA_ALL = 1213483841, /** * Katakana: A, Ka, Sa, Ta, Na... */ KATAKANA_CONSONANTS_ONLY = 1213483843, /** * Korean Consonant */ KOREAN_CONSONANT = 1213483887, /** * Korean Consonant Plus Vowel */ KOREAN_CONSONANT_PLUS_VOWEL = 1213483862, /** * Latvian */ LATVIAN = 1213484129, /** * Lithuanian */ LITHUANIAN = 1213484137, /** * Polish */ POLISH = 1213485167, /** * Romanian */ ROMANIAN = 1213485679, /** * Russian */ RUSSIAN = 1213485685, /** * Slovak */ SLOVAK = 1213485931, /** * Slovenian */ SLOVENIAN = 1213485934, /** * Spanish */ SPANISH = 1213485936, /** * Turkish */ TURKISH = 1213486197, /** * Ukrainian */ UKRAINIAN = 1213486443, } /** * A hidden text object. */ declare class HiddenText { /** * A collection of characters. */ readonly characters: Characters; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the HiddenText. */ readonly id: number; /** * The index of the HiddenText within its containing object. */ readonly index: number; /** * A collection of insertion points. */ readonly insertionPoints: InsertionPoints; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * A collection of lines. */ readonly lines: Lines; /** * The name of the HiddenText; this is an alias to the HiddenText's label * property. */ name: string; /** * A collection of paragraphs. */ readonly paragraphs: Paragraphs; /** * The parent of the HiddenText (a Story, XmlStory, TextFrame, * EndnoteTextFrame, InsertionPoint, Note, Cell or Footnote). */ readonly parent: Cell | EndnoteTextFrame | InsertionPoint | Note | TextFrame | XmlStory | Footnote | Story; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The insertion point before the table in the story containing the table. */ readonly storyOffset: InsertionPoint; /** * A collection of text columns. */ readonly textColumns: TextColumns; /** * A collection of text style ranges. */ readonly textStyleRanges: TextStyleRanges; /** * A collection of text objects. */ readonly texts: Texts; /** * A collection of words. */ readonly words: Words; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): HiddenText[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the HiddenText. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of hidden text objects. */ declare class HiddenTexts { /** Returns the HiddenText with the specified index or name. */ [index: number]: HiddenText; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any HiddenText in the collection. */ anyItem(): HiddenText; /** * Displays the number of elements in the HiddenText. */ count(): number; /** * Returns every HiddenText in the collection. */ everyItem(): HiddenText; /** * Returns the first HiddenText in the collection. */ firstItem(): HiddenText; /** * Returns the HiddenText with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): HiddenText; /** * Returns the HiddenText with the specified ID. * @param id The ID. */ itemByID(id: number): HiddenText; /** * Returns the HiddenText with the specified name. * @param name The name. */ itemByName(name: string): HiddenText; /** * Returns the HiddenTexts within the specified range. * @param from The HiddenText, index, or name at the beginning of the range. Can accept: HiddenText, Long Integer or String. * @param to The HiddenText, index, or name at the end of the range. Can accept: HiddenText, Long Integer or String. */ itemByRange(from: HiddenText | number | string, to: HiddenText | number | string): HiddenText[]; /** * Returns the last HiddenText in the collection. */ lastItem(): HiddenText; /** * Returns the middle HiddenText in the collection. */ middleItem(): HiddenText; /** * Returns the HiddenText whose index follows the specified HiddenText in the * collection. * @param obj The HiddenText whose index comes before the desired HiddenText. */ nextItem(obj: HiddenText): HiddenText; /** * Returns the HiddenText with the index previous to the specified index. * @param obj The index of the HiddenText that follows the desired HiddenText. */ previousItem(obj: HiddenText): HiddenText; /** * Generates a string which, if executed, will return the HiddenText. */ toSource(): string; } /** * The horizontal alignment of an anchored object. Not valid when anchored * position is inline. */ declare enum HorizontalAlignment { /** * Place the anchored object at the center of the reference. */ CENTER_ALIGN = 1667591796, /** * Place the anchored object to the left of the reference. */ LEFT_ALIGN = 1818584692, /** * Place the anchored object to the right of the reference. */ RIGHT_ALIGN = 1919379572, /** * Place the anchored object relative to the text alignment. */ TEXT_ALIGN = 1954046316, } /** * Orientation options. */ declare enum HorizontalOrVertical { /** * Horizontal orientation. */ HORIZONTAL = 1752134266, /** * Vertical orientation. */ VERTICAL = 1986359924, } /** * HTML5 Export Preference Object */ declare class Html5ExportPreference extends Preference { /** * Copy fonts during export */ copyFonts: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the Html5ExportPreference (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The format of text to export (HTML or SVG) */ textExportFormat: TextExportFormatEnum; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Html5ExportPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * Html5ExportPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Embedded HTML. */ declare class HtmlItem extends PageItem { /** * Indicates whether the HtmlItem has been flipped independently of its parent * object and, if yes, the direction in which the HtmlItem was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the HtmlItem relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the HtmlItem relative to its containing object. * (Range: -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the HtmlItem relative to its containing object. (Range: * -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the HtmlItem relative to its containing object. */ absoluteVerticalScale: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the HtmlItem. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the HtmlItem. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the HtmlItem. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the HtmlItem. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the HtmlItem. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * Transparency settings for the content of the HtmlItem. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the HtmlItem. */ endJoin: EndJoin; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * HtmlItem. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the HtmlItem's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the HtmlItem. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Is this HTML able to adapt its width and height based on changes to the * parent div or does it have fixed dimensions? */ fixedDimensions: boolean; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the HtmlItem excluding the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the HtmlItem. (Range: * -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the HtmlItem. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the HtmlItem, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the HtmlItem. * (Range: -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the HtmlItem. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the HtmlItem, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the HtmlItem. */ horizontalScale: number; /** * The embedded HTML text */ htmlContent: string; /** * The unique ID of the HtmlItem. */ readonly id: number; /** * The index of the HtmlItem within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the HtmlItem is on. */ itemLayer: Layer; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the HtmlItem. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the HtmlItem is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * The name of the HtmlItem. */ name: string; /** * If true, the HtmlItem does not print. */ nonprinting: boolean; /** * If true, the HtmlItem's fill color overprints any underlying objects. If * false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the HtmlItem's stroke color overprints any underlying objects. If * false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the HtmlItem (a SplineItem, Polygon, GraphicLine, Rectangle or * Oval). */ readonly parent: GraphicLine | Polygon | Rectangle | Oval | SplineItem; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the HtmlItem. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the HtmlItem. (Range: -360 to 360) */ shearAngle: number; /** * The stroke alignment applied to the HtmlItem. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the HtmlItem. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the HtmlItem. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the HtmlItem's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the HtmlItem. */ verticalScale: number; /** * If true, the HtmlItem is visible. */ visible: boolean; /** * The bounds of the HtmlItem including the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * Dispatched after a HtmlItem is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a HtmlItem is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the HtmlItem's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the HtmlItem that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the HtmlItem. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the HtmlItem to a different shape. * @param given The HtmlItem's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new HtmlItem. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new HtmlItem. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new HtmlItem. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new HtmlItem. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new HtmlItem. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the HtmlItem at the specified location or offset. * @param to The location of the new HtmlItem, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new HtmlItem from the original HtmlItem's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the HtmlItem. * @param given The axis around which to flip the HtmlItem. * @param around The point around which to flip the HtmlItem. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): HtmlItem[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the HtmlItem to a new location. Note: Either the 'to' or 'by' * parameter is required; if both parameters are defined, only the to value is * used. * @param to The new location of the HtmlItem,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the HtmlItem relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the HtmlItem. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the HtmlItem in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new HtmlItem (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the HtmlItem. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the HtmlItem using the last transformation performed on any * object. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgain(): string[]; /** * Transforms the HtmlItem using the last transformation performed on any * HtmlItem. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgainIndividually(): string[]; /** * Transforms the HtmlItem using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the HtmlItem using the last sequence of transformations performed * on any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * A collection of embedded HTML page items. */ declare class HtmlItems { /** Returns the HtmlItem with the specified index or name. */ [index: number]: HtmlItem; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new HtmlItem * @param layer The layer on which to create the HtmlItem. (Optional) * @param at The location at which to insert the HtmlItem relative to the reference object or within the container object. (Optional) * @param reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) * @param withProperties Initial values for properties of the new HtmlItem (Optional) */ add(layer?: Layer, at?: LocationOptions, reference?: Document | Layer | MasterSpread | Page | Spread | PageItem, withProperties?: Object): HtmlItem; /** * Returns any HtmlItem in the collection. */ anyItem(): HtmlItem; /** * Displays the number of elements in the HtmlItem. */ count(): number; /** * Returns every HtmlItem in the collection. */ everyItem(): HtmlItem; /** * Returns the first HtmlItem in the collection. */ firstItem(): HtmlItem; /** * Returns the HtmlItem with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): HtmlItem; /** * Returns the HtmlItem with the specified ID. * @param id The ID. */ itemByID(id: number): HtmlItem; /** * Returns the HtmlItem with the specified name. * @param name The name. */ itemByName(name: string): HtmlItem; /** * Returns the HtmlItems within the specified range. * @param from The HtmlItem, index, or name at the beginning of the range. Can accept: HtmlItem, Long Integer or String. * @param to The HtmlItem, index, or name at the end of the range. Can accept: HtmlItem, Long Integer or String. */ itemByRange(from: HtmlItem | number | string, to: HtmlItem | number | string): HtmlItem[]; /** * Returns the last HtmlItem in the collection. */ lastItem(): HtmlItem; /** * Returns the middle HtmlItem in the collection. */ middleItem(): HtmlItem; /** * Returns the HtmlItem whose index follows the specified HtmlItem in the * collection. * @param obj The HtmlItem whose index comes before the desired HtmlItem. */ nextItem(obj: HtmlItem): HtmlItem; /** * Returns the HtmlItem with the index previous to the specified index. * @param obj The index of the HtmlItem that follows the desired HtmlItem. */ previousItem(obj: HtmlItem): HtmlItem; /** * Generates a string which, if executed, will return the HtmlItem. */ toSource(): string; } /** * Experimental: An http link connection manager. */ declare class HttpLinkConnectionManagerObject { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the HttpLinkConnectionManagerObject within its containing * object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the HttpLinkConnectionManagerObject (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): HttpLinkConnectionManagerObject[]; /** * Experimental: Create a url connection for the given server address * @param serverurl Server URL to connect * @param jsonData JSON data */ httpConnect(serverurl: string, jsonData: string): void; /** * Experimental: Checks if the given server URL is connected or not. * @param serverurl Server URL to check */ isConnected(serverurl: string): boolean; /** * Experimental: Logout from the given URL * @param serverurl Server URL to logout from */ logout(serverurl: string): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * HttpLinkConnectionManagerObject. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A hyperlink. */ declare class Hyperlink { /** * The hyperlink border color. Can return: Array of 3 Reals (0 - 255) or * UIColors enumerator. */ borderColor: (number[][] | UIColors)[]; /** * The hyperlink border style. */ borderStyle: HyperlinkAppearanceStyle; /** * The text, page, or URL that the hyperlink points to. Can return: * HyperlinkTextDestination, HyperlinkPageDestination, * HyperlinkExternalPageDestination, HyperlinkURLDestination or * ParagraphDestination. */ destination: HyperlinkExternalPageDestination | HyperlinkPageDestination | HyperlinkTextDestination | HyperlinkURLDestination | ParagraphDestination; /** * The epub aria role as recommended by IDPF */ epubAriaRole: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, the hyperlink is hidden. */ readonly hidden: boolean; /** * The hyperlink highlight style. */ highlight: HyperlinkAppearanceHighlight; /** * The hypherlink alt text. */ hypherlinkAltText: string; /** * The unique ID of the Hyperlink. */ readonly id: number; /** * The index of the Hyperlink within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the Hyperlink. */ name: string; /** * The parent of the Hyperlink (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The hyperlinked text or page item. Can return: HyperlinkPageItemSource, * HyperlinkTextSource or CrossReferenceSource. */ source: HyperlinkPageItemSource | HyperlinkTextSource | CrossReferenceSource; /** * If true, the Hyperlink is visible. */ visible: boolean; /** * The stroke weight of the hyperlink border. */ width: HyperlinkAppearanceWidth; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Hyperlink[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the Hyperlink. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Jumps to the hyperlink destination. */ showDestination(): void; /** * Jumps to the hyperlink source. */ showSource(): void; /** * Generates a string which, if executed, will return the Hyperlink. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for highlighting the hyperlink when selected. */ declare enum HyperlinkAppearanceHighlight { /** * Highlights the hyperlink border inset. */ INSET = 1853056372, /** * Highlights the hyperlink fill color. */ INVERT = 1853256308, /** * Does not highlight the hyperlink. */ NONE = 1852796517, /** * Highlights the hyperlink border. */ OUTLINE = 1869900910, } /** * Hyperlink border style options. */ declare enum HyperlinkAppearanceStyle { /** * Uses a dashed stroke. */ DASHED = 1684108136, /** * Uses a solid stroke. */ SOLID = 1936682084, } /** * Hyperlink border weight options. */ declare enum HyperlinkAppearanceWidth { /** * Uses a medium border. */ MEDIUM = 1701727588, /** * Uses a thick border. */ THICK = 1952999787, /** * Uses a thin border. */ THIN = 1952999790, } /** * Hyperlink destination page display options. */ declare enum HyperlinkDestinationPageSetting { /** * Fits the destination page to the window height; may obscure the right side * the page. Note: The magnification changes automatically when the window is * resized vertically. */ FIT_HEIGHT = 1212437352, /** * Displays the visible portion of the destination page as the destination. */ FIT_VIEW = 1212437366, /** * Fits the the text area of the destination page to the window width; obscures * page margins and may obscure the lower portion of the page. Note: The * magnification changes automatically when the window is resized horizontally. */ FIT_VISIBLE = 1212437334, /** * Fits the destination page to the width of the window; may obscure the lower * portion of the page. Note: The magnification changes automatically when the * window is resized horizontally. */ FIT_WIDTH = 1212437335, /** * Fits the entire destination page in the document window. Note: The * magnification changes automatically when the window is resized. */ FIT_WINDOW = 1212437367, /** * Fits the destination page within the specified rectangle. For information on * specifying the rectangle size and position, see the entry for view bounds. */ FIXED = 1212437350, /** * The destination page is displayed at the same zoom percent as the previously * displayed page. Note: The magnification changes automatically when the * window is resized. */ INHERIT_ZOOM = 1212437370, } /** * A hyperlink destination that is a page in a document other than the document * that contains the hyperlink source. For information on hyperlink sources, * hyperlink page item source or hyperlink text source. */ declare class HyperlinkExternalPageDestination { /** * The index of the page that the hyperlink destination points to. Note: Valid * only when hyperlink destination is an external page. * @remarks Range: 1 to 9999 */ destinationPageIndex: number; /** * The path to the document that the hyperlink destination points to. */ documentPath: File; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, the hyperlink is hidden. */ readonly hidden: boolean; /** * The unique ID of the HyperlinkExternalPageDestination. */ readonly id: number; /** * The index of the HyperlinkExternalPageDestination within its containing * object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the HyperlinkExternalPageDestination. */ readonly name: string; /** * The parent of the HyperlinkExternalPageDestination (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The view rectangle, specified in the format [y1, x1, y2, x2]. Note: Valid * only when view setting is fixed. Can return: Ordered array containing * top:Unit, left:Unit, bottom:Unit, right:Unit. */ viewBounds: any[] | number; /** * The zoom percentage. (Range: 5 to 4000) Note: Valid only when view setting * is fixed. * @remarks Range: 5 to 4000 */ viewPercentage: number; /** * The destination page size when the page is reached by clicking the * hyperlink. */ viewSetting: HyperlinkDestinationPageSetting; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): HyperlinkExternalPageDestination[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the HyperlinkExternalPageDestination. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Jumps to the hyperlink destination. */ showDestination(): void; /** * Generates a string which, if executed, will return the * HyperlinkExternalPageDestination. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of hyperlink external page destinations. */ declare class HyperlinkExternalPageDestinations { /** Returns the HyperlinkExternalPageDestination with the specified index or name. */ [index: number]: HyperlinkExternalPageDestination; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new hyperlink external page destination. * @param destination The destination page. (Optional) * @param withProperties Initial values for properties of the new HyperlinkExternalPageDestination (Optional) */ add(destination?: Page, withProperties?: Object): HyperlinkExternalPageDestination; /** * Returns any HyperlinkExternalPageDestination in the collection. */ anyItem(): HyperlinkExternalPageDestination; /** * Displays the number of elements in the HyperlinkExternalPageDestination. */ count(): number; /** * Returns every HyperlinkExternalPageDestination in the collection. */ everyItem(): HyperlinkExternalPageDestination; /** * Returns the first HyperlinkExternalPageDestination in the collection. */ firstItem(): HyperlinkExternalPageDestination; /** * Returns the HyperlinkExternalPageDestination with the specified index or * name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): HyperlinkExternalPageDestination; /** * Returns the HyperlinkExternalPageDestination with the specified ID. * @param id The ID. */ itemByID(id: number): HyperlinkExternalPageDestination; /** * Returns the HyperlinkExternalPageDestination with the specified name. * @param name The name. */ itemByName(name: string): HyperlinkExternalPageDestination; /** * Returns the HyperlinkExternalPageDestinations within the specified range. * @param from The HyperlinkExternalPageDestination, index, or name at the beginning of the range. Can accept: HyperlinkExternalPageDestination, Long Integer or String. * @param to The HyperlinkExternalPageDestination, index, or name at the end of the range. Can accept: HyperlinkExternalPageDestination, Long Integer or String. */ itemByRange(from: HyperlinkExternalPageDestination | number | string, to: HyperlinkExternalPageDestination | number | string): HyperlinkExternalPageDestination[]; /** * Returns the last HyperlinkExternalPageDestination in the collection. */ lastItem(): HyperlinkExternalPageDestination; /** * Returns the middle HyperlinkExternalPageDestination in the collection. */ middleItem(): HyperlinkExternalPageDestination; /** * Returns the HyperlinkExternalPageDestination whose index follows the * specified HyperlinkExternalPageDestination in the collection. * @param obj The HyperlinkExternalPageDestination whose index comes before the desired HyperlinkExternalPageDestination. */ nextItem(obj: HyperlinkExternalPageDestination): HyperlinkExternalPageDestination; /** * Returns the HyperlinkExternalPageDestination with the index previous to the * specified index. * @param obj The index of the HyperlinkExternalPageDestination that follows the desired HyperlinkExternalPageDestination. */ previousItem(obj: HyperlinkExternalPageDestination): HyperlinkExternalPageDestination; /** * Generates a string which, if executed, will return the * HyperlinkExternalPageDestination. */ toSource(): string; } /** * A hyperlink destination that is a document page. */ declare class HyperlinkPageDestination { /** * The page that the hyperlink points to. */ destinationPage: Page; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, the hyperlink is hidden. */ readonly hidden: boolean; /** * The unique ID of the HyperlinkPageDestination. */ readonly id: number; /** * The index of the HyperlinkPageDestination within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the HyperlinkPageDestination. */ name: string; /** * If true or unspecified, allows a custom destination name; also does not * update the name when the destination is moved to a different page. If false, * uses the page number as the page destination name and makes the name * property read-only for the destination object; also updates the name when * the destination is moved to a different page. */ nameManually: boolean; /** * The parent of the HyperlinkPageDestination (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The view rectangle, specified in the format [y1, x1, y2, x2]. Note: Valid * only when view setting is fixed. Can return: Ordered array containing * top:Unit, left:Unit, bottom:Unit, right:Unit. */ viewBounds: any[] | number; /** * The zoom percentage. (Range: 5 to 4000) Note: Valid only when view setting * is fixed. * @remarks Range: 5 to 4000 */ viewPercentage: number; /** * The destination page size when the page is reached by clicking the * hyperlink. */ viewSetting: HyperlinkDestinationPageSetting; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): HyperlinkPageDestination[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the HyperlinkPageDestination. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Jumps to the hyperlink destination. */ showDestination(): void; /** * Generates a string which, if executed, will return the * HyperlinkPageDestination. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of hyperlink page destinations. */ declare class HyperlinkPageDestinations { /** Returns the HyperlinkPageDestination with the specified index or name. */ [index: number]: HyperlinkPageDestination; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new hyperlink page destination. * @param destination The document page that the hyperlink points to. (Optional) * @param withProperties Initial values for properties of the new HyperlinkPageDestination (Optional) */ add(destination?: Page, withProperties?: Object): HyperlinkPageDestination; /** * Returns any HyperlinkPageDestination in the collection. */ anyItem(): HyperlinkPageDestination; /** * Displays the number of elements in the HyperlinkPageDestination. */ count(): number; /** * Returns every HyperlinkPageDestination in the collection. */ everyItem(): HyperlinkPageDestination; /** * Returns the first HyperlinkPageDestination in the collection. */ firstItem(): HyperlinkPageDestination; /** * Returns the HyperlinkPageDestination with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): HyperlinkPageDestination; /** * Returns the HyperlinkPageDestination with the specified ID. * @param id The ID. */ itemByID(id: number): HyperlinkPageDestination; /** * Returns the HyperlinkPageDestination with the specified name. * @param name The name. */ itemByName(name: string): HyperlinkPageDestination; /** * Returns the HyperlinkPageDestinations within the specified range. * @param from The HyperlinkPageDestination, index, or name at the beginning of the range. Can accept: HyperlinkPageDestination, Long Integer or String. * @param to The HyperlinkPageDestination, index, or name at the end of the range. Can accept: HyperlinkPageDestination, Long Integer or String. */ itemByRange(from: HyperlinkPageDestination | number | string, to: HyperlinkPageDestination | number | string): HyperlinkPageDestination[]; /** * Returns the last HyperlinkPageDestination in the collection. */ lastItem(): HyperlinkPageDestination; /** * Returns the middle HyperlinkPageDestination in the collection. */ middleItem(): HyperlinkPageDestination; /** * Returns the HyperlinkPageDestination whose index follows the specified * HyperlinkPageDestination in the collection. * @param obj The HyperlinkPageDestination whose index comes before the desired HyperlinkPageDestination. */ nextItem(obj: HyperlinkPageDestination): HyperlinkPageDestination; /** * Returns the HyperlinkPageDestination with the index previous to the * specified index. * @param obj The index of the HyperlinkPageDestination that follows the desired HyperlinkPageDestination. */ previousItem(obj: HyperlinkPageDestination): HyperlinkPageDestination; /** * Generates a string which, if executed, will return the * HyperlinkPageDestination. */ toSource(): string; } /** * A hyperlinked page item. */ declare class HyperlinkPageItemSource { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, the hyperlink is hidden. */ readonly hidden: boolean; /** * The unique ID of the HyperlinkPageItemSource. */ readonly id: number; /** * The index of the HyperlinkPageItemSource within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the HyperlinkPageItemSource. */ name: string; /** * The parent of the HyperlinkPageItemSource (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The hyperlinked page item. */ sourcePageItem: PageItem; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): HyperlinkPageItemSource[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the HyperlinkPageItemSource. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Jumps to the hyperlink source. */ showSource(): void; /** * Generates a string which, if executed, will return the * HyperlinkPageItemSource. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of hyperlink page item sources. */ declare class HyperlinkPageItemSources { /** Returns the HyperlinkPageItemSource with the specified index or name. */ [index: number]: HyperlinkPageItemSource; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new hyperlink page item source. * @param source The page item to hyperlink. * @param withProperties Initial values for properties of the new HyperlinkPageItemSource (Optional) */ add(source: PageItem, withProperties?: Object): HyperlinkPageItemSource; /** * Returns any HyperlinkPageItemSource in the collection. */ anyItem(): HyperlinkPageItemSource; /** * Displays the number of elements in the HyperlinkPageItemSource. */ count(): number; /** * Returns every HyperlinkPageItemSource in the collection. */ everyItem(): HyperlinkPageItemSource; /** * Returns the first HyperlinkPageItemSource in the collection. */ firstItem(): HyperlinkPageItemSource; /** * Returns the HyperlinkPageItemSource with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): HyperlinkPageItemSource; /** * Returns the HyperlinkPageItemSource with the specified ID. * @param id The ID. */ itemByID(id: number): HyperlinkPageItemSource; /** * Returns the HyperlinkPageItemSource with the specified name. * @param name The name. */ itemByName(name: string): HyperlinkPageItemSource; /** * Returns the HyperlinkPageItemSources within the specified range. * @param from The HyperlinkPageItemSource, index, or name at the beginning of the range. Can accept: HyperlinkPageItemSource, Long Integer or String. * @param to The HyperlinkPageItemSource, index, or name at the end of the range. Can accept: HyperlinkPageItemSource, Long Integer or String. */ itemByRange(from: HyperlinkPageItemSource | number | string, to: HyperlinkPageItemSource | number | string): HyperlinkPageItemSource[]; /** * Returns the last HyperlinkPageItemSource in the collection. */ lastItem(): HyperlinkPageItemSource; /** * Returns the middle HyperlinkPageItemSource in the collection. */ middleItem(): HyperlinkPageItemSource; /** * Returns the HyperlinkPageItemSource whose index follows the specified * HyperlinkPageItemSource in the collection. * @param obj The HyperlinkPageItemSource whose index comes before the desired HyperlinkPageItemSource. */ nextItem(obj: HyperlinkPageItemSource): HyperlinkPageItemSource; /** * Returns the HyperlinkPageItemSource with the index previous to the specified * index. * @param obj The index of the HyperlinkPageItemSource that follows the desired HyperlinkPageItemSource. */ previousItem(obj: HyperlinkPageItemSource): HyperlinkPageItemSource; /** * Generates a string which, if executed, will return the * HyperlinkPageItemSource. */ toSource(): string; } /** * A hyperlink destination that is either text or an insertion point. */ declare class HyperlinkTextDestination { /** * The text or insertion point that the hyperlink points to. Can also accept: * Text. */ destinationText: InsertionPoint | Text; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, the hyperlink is hidden. */ readonly hidden: boolean; /** * The unique ID of the HyperlinkTextDestination. */ readonly id: number; /** * The index of the HyperlinkTextDestination within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the HyperlinkTextDestination. */ name: string; /** * The parent of the HyperlinkTextDestination (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): HyperlinkTextDestination[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the HyperlinkTextDestination. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Jumps to the hyperlink destination. */ showDestination(): void; /** * Generates a string which, if executed, will return the * HyperlinkTextDestination. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of hyperlink text destinations. */ declare class HyperlinkTextDestinations { /** Returns the HyperlinkTextDestination with the specified index or name. */ [index: number]: HyperlinkTextDestination; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new hyperlink text destination. * @param destination The text or insertion point location that the hyperlink points to. * @param withProperties Initial values for properties of the new HyperlinkTextDestination (Optional) */ add(destination: Text, withProperties?: Object): HyperlinkTextDestination; /** * Returns any HyperlinkTextDestination in the collection. */ anyItem(): HyperlinkTextDestination; /** * Displays the number of elements in the HyperlinkTextDestination. */ count(): number; /** * Returns every HyperlinkTextDestination in the collection. */ everyItem(): HyperlinkTextDestination; /** * Returns the first HyperlinkTextDestination in the collection. */ firstItem(): HyperlinkTextDestination; /** * Returns the HyperlinkTextDestination with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): HyperlinkTextDestination; /** * Returns the HyperlinkTextDestination with the specified ID. * @param id The ID. */ itemByID(id: number): HyperlinkTextDestination; /** * Returns the HyperlinkTextDestination with the specified name. * @param name The name. */ itemByName(name: string): HyperlinkTextDestination; /** * Returns the HyperlinkTextDestinations within the specified range. * @param from The HyperlinkTextDestination, index, or name at the beginning of the range. Can accept: HyperlinkTextDestination, Long Integer or String. * @param to The HyperlinkTextDestination, index, or name at the end of the range. Can accept: HyperlinkTextDestination, Long Integer or String. */ itemByRange(from: HyperlinkTextDestination | number | string, to: HyperlinkTextDestination | number | string): HyperlinkTextDestination[]; /** * Returns the last HyperlinkTextDestination in the collection. */ lastItem(): HyperlinkTextDestination; /** * Returns the middle HyperlinkTextDestination in the collection. */ middleItem(): HyperlinkTextDestination; /** * Returns the HyperlinkTextDestination whose index follows the specified * HyperlinkTextDestination in the collection. * @param obj The HyperlinkTextDestination whose index comes before the desired HyperlinkTextDestination. */ nextItem(obj: HyperlinkTextDestination): HyperlinkTextDestination; /** * Returns the HyperlinkTextDestination with the index previous to the * specified index. * @param obj The index of the HyperlinkTextDestination that follows the desired HyperlinkTextDestination. */ previousItem(obj: HyperlinkTextDestination): HyperlinkTextDestination; /** * Generates a string which, if executed, will return the * HyperlinkTextDestination. */ toSource(): string; } /** * A hyperlinked text object or insertion point. */ declare class HyperlinkTextSource { /** * Character style of the hyperlink text source. */ appliedCharacterStyle: CharacterStyle; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, the hyperlink is hidden. */ readonly hidden: boolean; /** * The unique ID of the HyperlinkTextSource. */ readonly id: number; /** * The index of the HyperlinkTextSource within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the HyperlinkTextSource. */ name: string; /** * The parent of the HyperlinkTextSource (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The hyperlinked text or insertion point. */ sourceText: Text; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): HyperlinkTextSource[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the HyperlinkTextSource. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Jumps to the hyperlink source. */ showSource(): void; /** * Generates a string which, if executed, will return the HyperlinkTextSource. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of hyperlink text sources. */ declare class HyperlinkTextSources { /** Returns the HyperlinkTextSource with the specified index or name. */ [index: number]: HyperlinkTextSource; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new hyperlink text source. * @param source The text or insertion point to hyperlink. * @param withProperties Initial values for properties of the new HyperlinkTextSource (Optional) */ add(source: Text, withProperties?: Object): HyperlinkTextSource; /** * Returns any HyperlinkTextSource in the collection. */ anyItem(): HyperlinkTextSource; /** * Displays the number of elements in the HyperlinkTextSource. */ count(): number; /** * Returns every HyperlinkTextSource in the collection. */ everyItem(): HyperlinkTextSource; /** * Returns the first HyperlinkTextSource in the collection. */ firstItem(): HyperlinkTextSource; /** * Returns the HyperlinkTextSource with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): HyperlinkTextSource; /** * Returns the HyperlinkTextSource with the specified ID. * @param id The ID. */ itemByID(id: number): HyperlinkTextSource; /** * Returns the HyperlinkTextSource with the specified name. * @param name The name. */ itemByName(name: string): HyperlinkTextSource; /** * Returns the HyperlinkTextSources within the specified range. * @param from The HyperlinkTextSource, index, or name at the beginning of the range. Can accept: HyperlinkTextSource, Long Integer or String. * @param to The HyperlinkTextSource, index, or name at the end of the range. Can accept: HyperlinkTextSource, Long Integer or String. */ itemByRange(from: HyperlinkTextSource | number | string, to: HyperlinkTextSource | number | string): HyperlinkTextSource[]; /** * Returns the last HyperlinkTextSource in the collection. */ lastItem(): HyperlinkTextSource; /** * Returns the middle HyperlinkTextSource in the collection. */ middleItem(): HyperlinkTextSource; /** * Returns the HyperlinkTextSource whose index follows the specified * HyperlinkTextSource in the collection. * @param obj The HyperlinkTextSource whose index comes before the desired HyperlinkTextSource. */ nextItem(obj: HyperlinkTextSource): HyperlinkTextSource; /** * Returns the HyperlinkTextSource with the index previous to the specified * index. * @param obj The index of the HyperlinkTextSource that follows the desired HyperlinkTextSource. */ previousItem(obj: HyperlinkTextSource): HyperlinkTextSource; /** * Generates a string which, if executed, will return the HyperlinkTextSource. */ toSource(): string; } /** * A hyperlink destination that is a URL. */ declare class HyperlinkURLDestination { /** * The URL the hyperlink points to. */ destinationURL: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, the hyperlink is hidden. */ readonly hidden: boolean; /** * The unique ID of the HyperlinkURLDestination. */ readonly id: number; /** * The index of the HyperlinkURLDestination within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the HyperlinkURLDestination. */ name: string; /** * The parent of the HyperlinkURLDestination (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): HyperlinkURLDestination[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the HyperlinkURLDestination. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Jumps to the hyperlink destination. */ showDestination(): void; /** * Generates a string which, if executed, will return the * HyperlinkURLDestination. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of hyperlink URL destinations. */ declare class HyperlinkURLDestinations { /** Returns the HyperlinkURLDestination with the specified index or name. */ [index: number]: HyperlinkURLDestination; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new hyperlink URL destination. * @param destination The URL that the hyperlink points to. (Optional) * @param withProperties Initial values for properties of the new HyperlinkURLDestination (Optional) */ add(destination?: string, withProperties?: Object): HyperlinkURLDestination; /** * Returns any HyperlinkURLDestination in the collection. */ anyItem(): HyperlinkURLDestination; /** * Displays the number of elements in the HyperlinkURLDestination. */ count(): number; /** * Returns every HyperlinkURLDestination in the collection. */ everyItem(): HyperlinkURLDestination; /** * Returns the first HyperlinkURLDestination in the collection. */ firstItem(): HyperlinkURLDestination; /** * Returns the HyperlinkURLDestination with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): HyperlinkURLDestination; /** * Returns the HyperlinkURLDestination with the specified ID. * @param id The ID. */ itemByID(id: number): HyperlinkURLDestination; /** * Returns the HyperlinkURLDestination with the specified name. * @param name The name. */ itemByName(name: string): HyperlinkURLDestination; /** * Returns the HyperlinkURLDestinations within the specified range. * @param from The HyperlinkURLDestination, index, or name at the beginning of the range. Can accept: HyperlinkURLDestination, Long Integer or String. * @param to The HyperlinkURLDestination, index, or name at the end of the range. Can accept: HyperlinkURLDestination, Long Integer or String. */ itemByRange(from: HyperlinkURLDestination | number | string, to: HyperlinkURLDestination | number | string): HyperlinkURLDestination[]; /** * Returns the last HyperlinkURLDestination in the collection. */ lastItem(): HyperlinkURLDestination; /** * Returns the middle HyperlinkURLDestination in the collection. */ middleItem(): HyperlinkURLDestination; /** * Returns the HyperlinkURLDestination whose index follows the specified * HyperlinkURLDestination in the collection. * @param obj The HyperlinkURLDestination whose index comes before the desired HyperlinkURLDestination. */ nextItem(obj: HyperlinkURLDestination): HyperlinkURLDestination; /** * Returns the HyperlinkURLDestination with the index previous to the specified * index. * @param obj The index of the HyperlinkURLDestination that follows the desired HyperlinkURLDestination. */ previousItem(obj: HyperlinkURLDestination): HyperlinkURLDestination; /** * Generates a string which, if executed, will return the * HyperlinkURLDestination. */ toSource(): string; } /** * A collection of hyperlinks. */ declare class Hyperlinks { /** Returns the Hyperlink with the specified index or name. */ [index: number]: Hyperlink; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new hyperlink. * @param hyperlinkSource The hyperlinked object. Can accept: HyperlinkPageItemSource, HyperlinkTextSource or CrossReferenceSource. * @param hyperlinkDestination The destination that the hyperlink points to. Can accept: Ordered array containing fileName:String, volumn:String, directoryId:Long Integer, dataLinkClassId:Long Integer, destinationUid:Long Integer, HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination, HyperlinkURLDestination or ParagraphDestination. (Optional) * @param withProperties Initial values for properties of the new Hyperlink (Optional) */ add(hyperlinkSource: HyperlinkPageItemSource | HyperlinkTextSource | CrossReferenceSource, hyperlinkDestination?: HyperlinkExternalPageDestination | HyperlinkPageDestination | HyperlinkTextDestination | HyperlinkURLDestination | any[] | number | string | ParagraphDestination, withProperties?: Object): Hyperlink; /** * Returns any Hyperlink in the collection. */ anyItem(): Hyperlink; /** * Displays the number of elements in the Hyperlink. */ count(): number; /** * Returns every Hyperlink in the collection. */ everyItem(): Hyperlink; /** * Returns the first Hyperlink in the collection. */ firstItem(): Hyperlink; /** * Returns the Hyperlink with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Hyperlink; /** * Returns the Hyperlink with the specified ID. * @param id The ID. */ itemByID(id: number): Hyperlink; /** * Returns the Hyperlink with the specified name. * @param name The name. */ itemByName(name: string): Hyperlink; /** * Returns the Hyperlinks within the specified range. * @param from The Hyperlink, index, or name at the beginning of the range. Can accept: Hyperlink, Long Integer or String. * @param to The Hyperlink, index, or name at the end of the range. Can accept: Hyperlink, Long Integer or String. */ itemByRange(from: Hyperlink | number | string, to: Hyperlink | number | string): Hyperlink[]; /** * Returns the last Hyperlink in the collection. */ lastItem(): Hyperlink; /** * Returns the middle Hyperlink in the collection. */ middleItem(): Hyperlink; /** * Returns the Hyperlink whose index follows the specified Hyperlink in the * collection. * @param obj The Hyperlink whose index comes before the desired Hyperlink. */ nextItem(obj: Hyperlink): Hyperlink; /** * Returns the Hyperlink with the index previous to the specified index. * @param obj The index of the Hyperlink that follows the desired Hyperlink. */ previousItem(obj: Hyperlink): Hyperlink; /** * Generates a string which, if executed, will return the Hyperlink. */ toSource(): string; } /** * A hyphenation exceptions list. */ declare class HyphenationException { /** * A list of words added to the hyphenation exceptions list. */ addedExceptions: string[]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the HyphenationException within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the HyphenationException. */ readonly name: string; /** * The parent of the HyphenationException (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A list of words removed from the hyphenation exceptions list. */ removedExceptions: string[]; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Adds the specified words to the hyphenation exceptions list. * @param addedExceptions The list of words to add. * @param removedList If true, adds the words to the removed exceptions list. If false or unspecified, adds the words to the added exceptions list. (Optional) */ addException(addedExceptions: string[], removedList?: boolean): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): HyphenationException[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the specified words from the hyphenation exceptions list. * @param removedExceptions The list of words to remove. * @param removedList If true, removes the words from the removed exceptions list. If false or unspecified, adds the words to the added exceptions list. (Optional) */ removeException(removedExceptions: string[], removedList?: boolean): void; /** * Generates a string which, if executed, will return the HyphenationException. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of hyphenation exceptions lists. */ declare class HyphenationExceptions { /** Returns the HyphenationException with the specified index or name. */ [index: number]: HyphenationException; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any HyphenationException in the collection. */ anyItem(): HyphenationException; /** * Displays the number of elements in the HyphenationException. */ count(): number; /** * Returns every HyphenationException in the collection. */ everyItem(): HyphenationException; /** * Returns the first HyphenationException in the collection. */ firstItem(): HyphenationException; /** * Returns the HyphenationException with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): HyphenationException; /** * Returns the HyphenationException with the specified name. * @param name The name. */ itemByName(name: string): HyphenationException; /** * Returns the HyphenationExceptions within the specified range. * @param from The HyphenationException, index, or name at the beginning of the range. Can accept: HyphenationException, Long Integer or String. * @param to The HyphenationException, index, or name at the end of the range. Can accept: HyphenationException, Long Integer or String. */ itemByRange(from: HyphenationException | number | string, to: HyphenationException | number | string): HyphenationException[]; /** * Returns the last HyphenationException in the collection. */ lastItem(): HyphenationException; /** * Returns the middle HyphenationException in the collection. */ middleItem(): HyphenationException; /** * Returns the HyphenationException whose index follows the specified * HyphenationException in the collection. * @param obj The HyphenationException whose index comes before the desired HyphenationException. */ nextItem(obj: HyphenationException): HyphenationException; /** * Returns the HyphenationException with the index previous to the specified * index. * @param obj The index of the HyphenationException that follows the desired HyphenationException. */ previousItem(obj: HyphenationException): HyphenationException; /** * Generates a string which, if executed, will return the HyphenationException. */ toSource(): string; } /** * Provider hyphenation styles. Currently only supported by the Duden * hyphenation provider. */ declare enum HyphenationStyleEnum { /** * Hyphenates at aesthetic hyphenation points. */ HYPH_AESTHETIC = 1684104563, /** * Hyphenates at all possible hyphenation points. */ HYPH_ALL = 1684106348, /** * Hyphenates at all but unaesthetic hyphenation points. */ HYPH_ALL_BUT_UNAESTHETIC = 1684103797, /** * Hyphenates at preferred aesthetic hyphenation points. */ HYPH_PREFERRED_AESTHETIC = 1685086565, } /** * The ICC profiles to include in the PDF document. */ declare enum ICCProfiles { /** * Includes all ICC profiles. */ INCLUDE_ALL = 1229144929, /** * Does not include ICC profiles. */ INCLUDE_NONE = 1229144942, /** * Includes RGB and tagged source CMYK profiles. */ INCLUDE_RGB_AND_TAGGED = 1229144946, /** * Includes tagged source profiles. */ INCLUDE_TAGGED = 1229144948, } /** * Input method editor (IME) preferences. */ declare class IMEPreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, allows inline input for non-Latin text. */ inlineInput: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the IMEPreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, use native digits for Arabic languages. */ useNativeDigits: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): IMEPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the IMEPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Icon size options. */ declare enum IconSizes { /** * Extra large icon. */ EXTRA_LARGE_ICON = 1885695079, /** * Extra small icon. */ EXTRA_SMALL_ICON = 1885696877, /** * Jumbo icon. */ JUMBO_ICON = 1886943340, /** * Large icon. */ LARGE_ICON = 1884058215, /** * Medium icon. */ MEDIUM_ICON = 1886217572, /** * Small icon. */ SMALL_ICON = 1886612844, } /** * An idle event. */ declare class IdleEvent extends Event { /** * If true, the event supports the bubbling phase of propagation. */ readonly bubbles: boolean; /** * If true, the default behavior of the event on its target can be canceled. */ readonly cancelable: boolean; /** * The current propagation target of the event. */ readonly currentTarget: any; /** * If true, the default behavior of the event on its target has been canceled. */ readonly defaultPrevented: boolean; /** * The current propagation phase of the event. */ readonly eventPhase: EventPhases; /** * The name of the event. */ readonly eventType: string; /** * The unique ID of the IdleEvent. */ readonly id: number; /** * The index of the IdleEvent within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the IdleEvent (a IdleTask). */ readonly parent: IdleTask; /** * If true, propagation of the event beyond the current target has been * stopped. */ readonly propagationStopped: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The target of the event. */ readonly target: any; /** * Amount of time allocated to this task at the time the event was dispatched. */ readonly timeAllocated: number; /** * The time the event was initialized. */ readonly timeStamp: Date; /** * Dispatched at idle time for this IdleEvent. This event does not bubble. This * event is not cancelable. */ static readonly ON_IDLE: string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): IdleEvent[]; /** * Cancels the default behavior of the event on its target. */ preventDefault(): void; /** * Stops propagation of the event beyond the current target. */ stopPropagation(): void; /** * Generates a string which, if executed, will return the IdleEvent. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * An attachable idle task. */ declare class IdleTask { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the IdleTask. */ readonly id: number; /** * The index of the IdleTask within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the IdleTask. */ name: string; /** * The parent of the IdleTask (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Amount of time to sleep (in milliseconds) before calling this task again. * Setting this to zero will cause task to be deleted. */ sleep: number; /** * Dispatched at idle time for this IdleTask. This event does not bubble. This * event is not cancelable. */ static readonly ON_IDLE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): IdleTask[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the IdleTask. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the IdleTask. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * All attachable idle tasks. */ declare class IdleTasks { /** Returns the IdleTask with the specified index or name. */ [index: number]: IdleTask; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new IdleTask. * @param withProperties Initial values for properties of the new IdleTask (Optional) */ add(withProperties?: Object): IdleTask; /** * Returns any IdleTask in the collection. */ anyItem(): IdleTask; /** * Displays the number of elements in the IdleTask. */ count(): number; /** * Returns every IdleTask in the collection. */ everyItem(): IdleTask; /** * Returns the first IdleTask in the collection. */ firstItem(): IdleTask; /** * Returns the IdleTask with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): IdleTask; /** * Returns the IdleTask with the specified ID. * @param id The ID. */ itemByID(id: number): IdleTask; /** * Returns the IdleTask with the specified name. * @param name The name. */ itemByName(name: string): IdleTask; /** * Returns the IdleTasks within the specified range. * @param from The IdleTask, index, or name at the beginning of the range. Can accept: IdleTask, Long Integer or String. * @param to The IdleTask, index, or name at the end of the range. Can accept: IdleTask, Long Integer or String. */ itemByRange(from: IdleTask | number | string, to: IdleTask | number | string): IdleTask[]; /** * Returns the last IdleTask in the collection. */ lastItem(): IdleTask; /** * Returns the middle IdleTask in the collection. */ middleItem(): IdleTask; /** * Returns the IdleTask whose index follows the specified IdleTask in the * collection. * @param obj The IdleTask whose index comes before the desired IdleTask. */ nextItem(obj: IdleTask): IdleTask; /** * Returns the IdleTask with the index previous to the specified index. * @param obj The index of the IdleTask that follows the desired IdleTask. */ previousItem(obj: IdleTask): IdleTask; /** * Generates a string which, if executed, will return the IdleTask. */ toSource(): string; } /** * An imported bitmap image in any bitmap file format (including TIFF, JPEG, or * GIF). */ declare class Image extends Graphic { /** * Indicates whether the Image has been flipped independently of its parent * object and, if yes, the direction in which the Image was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the Image relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the Image relative to its containing object. (Range: * -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the Image relative to its containing object. (Range: * -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the Image relative to its containing object. */ absoluteVerticalScale: number; /** * The native resolution of a placed graphic. */ readonly actualPpi: number[]; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the Image. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the Image. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the Image. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the Image. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the Image. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * Clipping path settings. */ readonly clippingPath: ClippingPathSettings; /** * Transparency settings for the content of the Image. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The resolution of a graphic after it has been resized. */ readonly effectivePpi: number[]; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the Image. */ endJoin: EndJoin; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * Image. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the Image's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the Image. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the Image excluding the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the Image. (Range: * -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the Image. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the Image, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the Image. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the Image. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the Image, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * Graphic layer option settings. */ readonly graphicLayerOptions: GraphicLayerOption; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the Image. */ horizontalScale: number; /** * The unique ID of the Image. */ readonly id: number; /** * The image I/O preference properties that define preferences for importing * images. */ readonly imageIOPreferences: ImageIOPreference; /** * The rendering intent override applied to the image. */ imageRenderingIntent: RenderingIntent; /** * The type of the image. */ readonly imageTypeName: string; /** * The index of the Image within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the Image is on. */ itemLayer: Layer; /** * The source file of the link. */ readonly itemLink: Link; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the Image. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the Image is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * The name of the Image. */ name: string; /** * If true, the Image does not print. */ nonprinting: boolean; /** * If true, the Image's fill color overprints any underlying objects. If false, * the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the Image's stroke color overprints any underlying objects. If * false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the Image (a Snippet, XMLElement, Sound, PlaceGun, Movie, * TextBox, SignatureField, ComboBox, ListBox, SplineItem, Polygon, * GraphicLine, Rectangle, Oval or State). */ readonly parent: ComboBox | GraphicLine | ListBox | Movie | Oval | PlaceGun | Polygon | Rectangle | SignatureField | Sound | SplineItem | TextBox | XMLElement | Snippet | State; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * The color profile. Can return: Profile enumerator or String. */ profile: Profile | string; /** * A list of valid RGB profiles. */ readonly profileList: string[]; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the Image. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the Image. (Range: -360 to 360) */ shearAngle: number; /** * The color space. */ readonly space: string; /** * The stroke alignment applied to the Image. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the Image. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the Image. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the Image's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the Image. */ verticalScale: number; /** * If true, the Image is visible. */ visible: boolean; /** * The bounds of the Image including the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * Dispatched after a Image is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a Image is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the Image's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the Image that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the Image. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the Image to a different shape. * @param given The Image's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Image. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Image. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Image. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Image. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Image. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the Image at the specified location or offset. * @param to The location of the new Image, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new Image from the original Image's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Exports the Image for the web. * @param to The full path name of the exported file. */ exportForWeb(to: File): string[]; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the Image. * @param given The axis around which to flip the Image. * @param around The point around which to flip the Image. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Image[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the Image to a new location. Note: Either the 'to' or 'by' parameter * is required; if both parameters are defined, only the to value is used. * @param to The new location of the Image,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the Image relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the Image. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the Image in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new Image (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the Image. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the Image using the last transformation performed on any object. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformAgain(): string[]; /** * Transforms the Image using the last transformation performed on any Image. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformAgainIndividually(): string[]; /** * Transforms the Image using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the Image using the last sequence of transformations performed on * any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * Type of Image alignment for objects */ declare enum ImageAlignmentType { /** * image will be aligned center */ ALIGN_CENTER = 1097614194, /** * image will be aligned left */ ALIGN_LEFT = 1097616486, /** * image will be aligned right */ ALIGN_RIGHT = 1097618036, } /** * File format options for converted images. */ declare enum ImageConversion { /** * Uses the best format based on the image. */ AUTOMATIC = 1768059764, /** * Uses GIF format for all images. */ GIF = 1734960742, /** * Uses JPEG format for all images. */ JPEG = 1785751398, /** * Uses PNG format for all images. */ PNG = 1397059687, } /** * Options for sending image data to the printer or file. */ declare enum ImageDataTypes { /** * Sends full-resolution data. */ ALL_IMAGE_DATA = 1853058416, /** * Prints graphics frames with crossbars in place of graphics. */ NONE = 1852796517, /** * Sends just enough data to print graphics at the best possible resolution for * the output device. */ OPTIMIZED_SUBSAMPLING = 1869640563, /** * Sends screen-resolution versions (72 dpi) of placed bitmap images. */ PROXY_IMAGE_DATA = 1819243130, } /** * Choices for export image. */ declare enum ImageExportOption { /** * link to server. */ LINK_TO_SERVER = 1700949107, /** * optimized image. */ OPTIMIZED_IMAGE = 1700949872, /** * original image. */ ORIGINAL_IMAGE = 1700949874, } /** * File format options for converted images */ declare enum ImageFormat { /** * Uses GIF format for selected object. */ GIF = 1734960742, /** * Uses JPEG format for selected object. */ JPEG = 1785751398, /** * Uses PNG format, for selected object. */ PNG = 1397059687, } /** * Image I/O preferences. */ declare class ImageIOPreference extends Preference { /** * If true, allows auto embedding. */ allowAutoEmbedding: boolean; /** * The name of the alpha channel. */ alphaChannelName: string; /** * If true, applies clipping paths defined in Photoshop to placed images. */ applyPhotoshopClippingPath: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the ImageIOPreference (a Application or Image). */ readonly parent: Application | Image; /** * The image resolution in ppi, set when the graphic is imported. */ readonly previewResolution: number; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ImageIOPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ImageIOPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Image Page Break Options. */ declare enum ImagePageBreakType { /** * Page break after image. */ PAGE_BREAK_AFTER = 1114792294, /** * Page break before image. */ PAGE_BREAK_BEFORE = 1114792550, /** * Page break before and after image. */ PAGE_BREAK_BEFORE_AND_AFTER = 1114792545, } /** * Image preferences. */ declare class ImagePreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the ImagePreference (a Application). */ readonly parent: Application; /** * If true, preserve image bounds when relinking. */ preserveBounds: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ImagePreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ImagePreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Image resolution for converted object */ declare enum ImageResolution { /** * 150 pixels per inch */ PPI_150 = 1920151654, /** * 300 pixels per inch */ PPI_300 = 1920160872, /** * 72 pixels per inch */ PPI_72 = 1920160628, /** * 96 pixels per inch */ PPI_96 = 1920159347, } /** * Image size option for a converted object */ declare enum ImageSizeOption { /** * Image size to be used is absolute. */ SIZE_FIXED = 1182295162, /** * CSS size to be used is none. */ SIZE_NONE = 1399746414, /** * Image size to be used is relative to the text flow. */ SIZE_RELATIVE_TO_TEXT_FLOW = 1383486566, } /** * A collection of bitmap images in any bitmap file format (including TIFF, * JPEG, or GIF). */ declare class Images { /** Returns the Image with the specified index or name. */ [index: number]: Image; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Image in the collection. */ anyItem(): Image; /** * Displays the number of elements in the Image. */ count(): number; /** * Returns every Image in the collection. */ everyItem(): Image; /** * Returns the first Image in the collection. */ firstItem(): Image; /** * Returns the Image with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Image; /** * Returns the Image with the specified ID. * @param id The ID. */ itemByID(id: number): Image; /** * Returns the Image with the specified name. * @param name The name. */ itemByName(name: string): Image; /** * Returns the Images within the specified range. * @param from The Image, index, or name at the beginning of the range. Can accept: Image, Long Integer or String. * @param to The Image, index, or name at the end of the range. Can accept: Image, Long Integer or String. */ itemByRange(from: Image | number | string, to: Image | number | string): Image[]; /** * Returns the last Image in the collection. */ lastItem(): Image; /** * Returns the middle Image in the collection. */ middleItem(): Image; /** * Returns the Image whose index follows the specified Image in the collection. * @param obj The Image whose index comes before the desired Image. */ nextItem(obj: Image): Image; /** * Returns the Image with the index previous to the specified index. * @param obj The index of the Image that follows the desired Image. */ previousItem(obj: Image): Image; /** * Generates a string which, if executed, will return the Image. */ toSource(): string; } /** * An import or export event. */ declare class ImportExportEvent extends Event { /** * If true, the event supports the bubbling phase of propagation. */ readonly bubbles: boolean; /** * If true, the default behavior of the event on its target can be canceled. */ readonly cancelable: boolean; /** * The current propagation target of the event. */ readonly currentTarget: any; /** * If true, the default behavior of the event on its target has been canceled. */ readonly defaultPrevented: boolean; /** * The current propagation phase of the event. */ readonly eventPhase: EventPhases; /** * The name of the event. */ readonly eventType: string; /** * The import/export file format. */ readonly format: string; /** * The full path to the ImportExportEvent, including the name of the * ImportExportEvent. */ readonly fullName: File; /** * The unique ID of the ImportExportEvent. */ readonly id: number; /** * The index of the ImportExportEvent within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the ImportExportEvent (a Application or Document). */ readonly parent: Application | Document; /** * If true, propagation of the event beyond the current target has been * stopped. */ readonly propagationStopped: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The target of the event. */ readonly target: any; /** * The time the event was initialized. */ readonly timeStamp: Date; /** * Controls the display of dialogs and alerts during script processing. */ userInteractionLevel: UserInteractionLevels; /** * Dispatched after a ImportExportEvent is exported. This event bubbles. This * event is not cancelable. */ static readonly AFTER_EXPORT: string; /** * Dispatched after importing a file into a ImportExportEvent. This event * bubbles. This event is not cancelable. */ static readonly AFTER_IMPORT: string; /** * Dispatched before a ImportExportEvent is exported. This event bubbles. This * event is cancelable. */ static readonly BEFORE_EXPORT: string; /** * Dispatched before importing a file into a ImportExportEvent. This event * bubbles. This event is cancelable. */ static readonly BEFORE_IMPORT: string; /** * Dispatched after a ImportExportEvent export is canceled or fails. This event * bubbles. This event is not cancelable. */ static readonly FAILED_EXPORT: string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ImportExportEvent[]; /** * Cancels the default behavior of the event on its target. */ preventDefault(): void; /** * Stops propagation of the event beyond the current target. */ stopPropagation(): void; /** * Generates a string which, if executed, will return the ImportExportEvent. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Style import options. */ declare enum ImportFormat { /** * Imports cell styles. */ CELL_STYLES_FORMAT = 1698919284, /** * Imports character styles. */ CHARACTER_STYLES_FORMAT = 1131565940, /** * Imports object styles. */ OBJECT_STYLES_FORMAT = 1332368244, /** * Imports paragraph styles. */ PARAGRAPH_STYLES_FORMAT = 1885885300, /** * Imports stroke styles. */ STROKE_STYLES_FORMAT = 1817408620, /** * Imports table and cell styles. */ TABLE_AND_CELL_STYLES_FORMAT = 1700021107, /** * Imports table styles. */ TABLE_STYLES_FORMAT = 1700033396, /** * Imports character and paragraph styles. */ TEXT_STYLES_FORMAT = 1668305780, /** * Imports table of contents styles. */ TOC_STYLES_FORMAT = 1415795572, } /** * Import platform options. */ declare enum ImportPlatform { /** * Macintosh. */ MACINTOSH = 1296130931, /** * Windows. */ PC = 1466852474, } /** * An imported InDesign page. */ declare class ImportedPage extends Graphic { /** * Indicates whether the ImportedPage has been flipped independently of its * parent object and, if yes, the direction in which the ImportedPage was * flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the ImportedPage relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the ImportedPage relative to its containing object. * (Range: -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the ImportedPage relative to its containing object. * (Range: -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the ImportedPage relative to its containing object. */ absoluteVerticalScale: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the ImportedPage. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the ImportedPage. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the ImportedPage. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the ImportedPage. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the ImportedPage. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * Clipping path settings. */ readonly clippingPath: ClippingPathSettings; /** * Transparency settings for the content of the ImportedPage. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the ImportedPage. */ endJoin: EndJoin; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * ImportedPage. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the ImportedPage's fill color. (To specify a * tint percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the ImportedPage. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the ImportedPage excluding the stroke width, in the format * [y1, x1, y2, x2], which give the coordinates of the top-left and * bottom-right corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the ImportedPage. * (Range: -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the ImportedPage. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the ImportedPage, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the ImportedPage. * (Range: -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the ImportedPage. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the ImportedPage, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * Graphic layer option settings. */ readonly graphicLayerOptions: GraphicLayerOption; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the ImportedPage. */ horizontalScale: number; /** * The unique ID of the ImportedPage. */ readonly id: number; /** * The type of the image. */ readonly imageTypeName: string; /** * Specifies the cropping of the imported InDesign page. Read only for page * items. */ readonly importedPageCrop: ImportedPageCropOptions; /** * The index of the ImportedPage within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the ImportedPage is on. */ itemLayer: Layer; /** * The source file of the link. */ readonly itemLink: Link; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the ImportedPage. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the ImportedPage is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * The name of the ImportedPage. */ name: string; /** * If true, the ImportedPage does not print. */ nonprinting: boolean; /** * If true, the ImportedPage's fill color overprints any underlying objects. If * false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the ImportedPage's stroke color overprints any underlying objects. * If false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * Which page of the InDesign document should be imported. Read only for page * items. */ readonly pageNumber: number; /** * The parent of the ImportedPage (a PlaceGun, SplineItem, Polygon, * GraphicLine, Rectangle or Oval). */ readonly parent: GraphicLine | Polygon | Rectangle | SplineItem | Oval | PlaceGun; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * PDF attribute settings. */ readonly pdfAttributes: PDFAttribute; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the ImportedPage. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the ImportedPage. (Range: -360 to 360) */ shearAngle: number; /** * The stroke alignment applied to the ImportedPage. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the ImportedPage. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the ImportedPage. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the ImportedPage's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the ImportedPage. */ verticalScale: number; /** * If true, the ImportedPage is visible. */ visible: boolean; /** * The bounds of the ImportedPage including the stroke width, in the format * [y1, x1, y2, x2], which give the coordinates of the top-left and * bottom-right corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * Dispatched after a ImportedPage is placed. This event bubbles. This event is * not cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a ImportedPage is placed. This event bubbles. This event * is cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the ImportedPage's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the ImportedPage that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the ImportedPage. Transformations include * rotation, scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the ImportedPage to a different shape. * @param given The ImportedPage's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new ImportedPage. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new ImportedPage. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new ImportedPage. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new ImportedPage. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new ImportedPage. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the ImportedPage at the specified location or offset. * @param to The location of the new ImportedPage, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new ImportedPage from the original ImportedPage's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Exports the ImportedPage for the web. * @param to The full path name of the exported file. */ exportForWeb(to: File): string[]; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the ImportedPage. * @param given The axis around which to flip the ImportedPage. * @param around The point around which to flip the ImportedPage. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ImportedPage[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the ImportedPage to a new location. Note: Either the 'to' or 'by' * parameter is required; if both parameters are defined, only the to value is * used. * @param to The new location of the ImportedPage,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the ImportedPage relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the ImportedPage. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the ImportedPage in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new ImportedPage (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the ImportedPage. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the ImportedPage using the last transformation performed on any * object. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgain(): string[]; /** * Transforms the ImportedPage using the last transformation performed on any * ImportedPage. Transformations include moving, rotating, shearing, scaling, * and flipping. */ transformAgainIndividually(): string[]; /** * Transforms the ImportedPage using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the ImportedPage using the last sequence of transformations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * Placed InDesign page attribute. */ declare class ImportedPageAttribute extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Specifies the cropping of the imported InDesign page. Read only for page * items. */ importedPageCrop: ImportedPageCropOptions; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * Which page of the InDesign document should be imported. Read only for page * items. */ pageNumber: number; /** * The parent of the ImportedPageAttribute (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ImportedPageAttribute[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * ImportedPageAttribute. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * The cropping option of an imported InDesign page. */ declare enum ImportedPageCropOptions { /** * Places the page's bleed area. */ CROP_BLEED = 1131573314, /** * Places the page's bounding box. */ CROP_CONTENT = 1131573315, /** * Places the page's slug area. */ CROP_SLUG = 1131565932, } /** * Imported InDesign pages. */ declare class ImportedPages { /** Returns the ImportedPage with the specified index or name. */ [index: number]: ImportedPage; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new ImportedPage. * @param withProperties Initial values for properties of the new ImportedPage (Optional) */ add(withProperties?: Object): ImportedPage; /** * Returns any ImportedPage in the collection. */ anyItem(): ImportedPage; /** * Displays the number of elements in the ImportedPage. */ count(): number; /** * Returns every ImportedPage in the collection. */ everyItem(): ImportedPage; /** * Returns the first ImportedPage in the collection. */ firstItem(): ImportedPage; /** * Returns the ImportedPage with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): ImportedPage; /** * Returns the ImportedPage with the specified ID. * @param id The ID. */ itemByID(id: number): ImportedPage; /** * Returns the ImportedPage with the specified name. * @param name The name. */ itemByName(name: string): ImportedPage; /** * Returns the ImportedPages within the specified range. * @param from The ImportedPage, index, or name at the beginning of the range. Can accept: ImportedPage, Long Integer or String. * @param to The ImportedPage, index, or name at the end of the range. Can accept: ImportedPage, Long Integer or String. */ itemByRange(from: ImportedPage | number | string, to: ImportedPage | number | string): ImportedPage[]; /** * Returns the last ImportedPage in the collection. */ lastItem(): ImportedPage; /** * Returns the middle ImportedPage in the collection. */ middleItem(): ImportedPage; /** * Returns the ImportedPage whose index follows the specified ImportedPage in * the collection. * @param obj The ImportedPage whose index comes before the desired ImportedPage. */ nextItem(obj: ImportedPage): ImportedPage; /** * Returns the ImportedPage with the index previous to the specified index. * @param obj The index of the ImportedPage that follows the desired ImportedPage. */ previousItem(obj: ImportedPage): ImportedPage; /** * Generates a string which, if executed, will return the ImportedPage. */ toSource(): string; } /** * Export options for InCopy INCX document format. */ declare class InCopyExportOption extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, export all resources (styles etc), otherwise export resources used * by the story. */ includeAllResources: boolean; /** * If true, include graphic proxy data. */ includeGraphicProxies: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the InCopyExportOption (a Application, Story, XmlStory, Oval, * Rectangle or Polygon). */ readonly parent: Oval | Rectangle | Story | XmlStory | Application | Polygon; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): InCopyExportOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the InCopyExportOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * InCopy UI colors. */ declare enum InCopyUIColors { /** * Amber. */ AMBER = 1765895522, /** * Aqua. */ AQUA = 1765896545, /** * Black. */ BLACK = 1765960811, /** * Blue. */ BLUE = 1765960821, /** * Blueberry. */ BLUEBERRY = 1765960802, /** * Brick red. */ BRICK_RED = 1765962340, /** * Brown. */ BROWN = 1765962350, /** * Burgundy. */ BURGUNDY = 1765962343, /** * Canary. */ CANARY = 1766026873, /** * Carnation. */ CARNATION = 1766023538, /** * Charcoal. */ CHARCOAL = 1766025324, /** * Cirrus. */ CIRRUS = 1766025586, /** * Cornstarch. */ CORNSTARCH = 1766027886, /** * Cute teal. */ CUTE_TEAL = 1766028396, /** * Cyan. */ CYAN = 1766029678, /** * Dark blue. */ DARK_BLUE = 1766089324, /** * Dark green. */ DARK_GREEN = 1766090610, /** * Eggplant. */ EGGPLANT = 1766156135, /** * Electrolyte. */ ELECTROLYTE = 1766157411, /** * Ether. */ ETHER = 1766159464, /** * Fiesta. */ FIESTA = 1766222181, /** * Forest. */ FOREST = 1766224756, /** * Fuchsia. */ FUCHSIA = 1766225267, /** * Gold. */ GOLD = 1766288484, /** * Grape. */ GRAPE = 1766290032, /** * Graphite. */ GRAPHITE = 1766289512, /** * Grass green. */ GRASS_GREEN = 1766287218, /** * Gray. */ GRAY = 1766290041, /** * Green. */ GREEN = 1766290030, /** * Grid blue. */ GRID_BLUE = 1766285932, /** * Grid green. */ GRID_GREEN = 1766286439, /** * Grid orange. */ GRID_ORANGE = 1766289266, /** * Gunmetal. */ GUNMETAL = 1766290798, /** * Iris. */ IRIS = 1766421107, /** * Jade. */ JADE = 1766482276, /** * Lavender. */ LAVENDER = 1766618734, /** * Lemon. */ LEMON = 1766616430, /** * Lichen. */ LICHEN = 1766615395, /** * Light blue. */ LIGHT_BLUE = 1766613612, /** * Light gray. */ LIGHT_GRAY = 1766614898, /** * Light olive. */ LIGHT_OLIVE = 1766616940, /** * Lime. */ LIME = 1766615405, /** * Lipstick. */ LIPSTICK = 1766615408, /** * Magenta. */ MAGENTA = 1766680430, /** * Midnight. */ MIDNIGHT = 1766680932, /** * Mocha. */ MOCHA = 1766682467, /** * Mustard. */ MUSTARD = 1766684019, /** * Ochre. */ OCHRE = 1766810482, /** * Olive green. */ OLIVE_GREEN = 1766812790, /** * Orange. */ ORANGE = 1766814318, /** * Peach. */ PEACH = 1766876008, /** * Pink. */ PINK = 1766878827, /** * Powder. */ POWDER = 1766879095, /** * Purple. */ PURPLE = 1766879856, /** * Red. */ RED = 1767007588, /** * Slate. */ SLATE = 1767074932, /** * Smoke. */ SMOKE = 1767075179, /** * Sulphur. */ SULPHUR = 1767077228, /** * Tan. */ TAN = 1767137646, /** * Teal. */ TEAL = 1767138668, /** * Ultramarine. */ ULTRAMARINE = 1767205997, /** * Violet. */ VIOLET = 1767271540, /** * Wheat. */ WHEAT = 1767336037, /** * White. */ WHITE = 1767336052, /** * Yellow. */ YELLOW = 1767468151, } /** * Index entry capitalization options. */ declare enum IndexCapitalizationOptions { /** * Capitalizes all index entries. Note: Capitalizes only topics created before * the capitalization statement appears in the script. */ ALL_ENTRIES = 1097624645, /** * Capitalizes all level 1 entries. Note: Capitalizes only topics created * before the capitalization statement appears in the script. */ ALL_LEVEL_1_ENTRIES = 1095517556, /** * Capitalizes the specified topic and its nested topics. Valid only as * parameter of the topic capitalize method; cannot be used as a parameter of * the index capitalize method. Note: Must occur after the selected topic and * its nested subtopics are created. */ INCLUDE_SUBENTRIES = 1767072325, /** * Capitalizes the specified topic but does not capitalize its nested topics. * Valid only as parameter of the topic capitalize method; cannot be used as a * parameter of the index capitalize method. Note: Must occur after the * specified topic and its nested topics are created. */ SELECTED_ENTRY = 1398042725, } /** * Options for formatting level 2 and lower index topics. */ declare enum IndexFormat { /** * Places nested topics on the line below and indented from the parent topic. */ NESTED_FORMAT = 1316243814, /** * Places nested topics on the same line as their parent topic, separated by * the specified separator. */ RUNIN_FORMAT = 1382631782, } /** * Index options. */ declare class IndexOptions extends Preference { /** * The character(s) inserted at the start of cross references. */ beforeCrossReferenceSeparator: string; /** * The character(s) inserted between index entries when runin-style index * format is used for nested topics. */ betweenEntriesSeparator: string; /** * The character(s) inserted between separate page numbers, page numbers and * page ranges, and series of page ranges. */ betweenPageNumbersSeparator: string; /** * The character style applied to cross references. */ crossReferenceStyle: CharacterStyle; /** * The character style applied to cross reference topics. */ crossReferenceTopicStyle: CharacterStyle; /** * The character(s) inserted at the end of each index entry. */ entryEndSeparator: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The character(s) inserted after each index topic. */ followingTopicSeparator: string; /** * If true, includes topics and page references from all the documents in a * book. */ includeBookDocuments: boolean; /** * If true, displays headings for sections with no index topics. Note: Valid * only when include section headings is true. */ includeEmptyIndexSections: boolean; /** * If true, includes topics and page references on hidden layers. */ includeHiddenEntries: boolean; /** * If true, displays the letters of the alphabet as index section headings. */ includeSectionHeadings: boolean; /** * The format for level 2 and lower index topics. */ indexFormat: IndexFormat; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The paragraph style applied to level 1 index topics. */ level1Style: ParagraphStyle; /** * The paragraph style applied to level 2 index topics. */ level2Style: ParagraphStyle; /** * The paragraph style applied to level 3 index topics. */ level3Style: ParagraphStyle; /** * The paragraph style applied to level 4 index topics. */ level4Style: ParagraphStyle; /** * The character style applied to page numbers in the index. */ pageNumberStyle: CharacterStyle; /** * The character(s) inserted between page numbers to indicate a page range. */ pageRangeSeparator: string; /** * The parent of the IndexOptions (a Document or Application). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, replaces the content of the existing index. Note: Replaces only * index content; does not update the index location or other index properties * that may have been changed. */ replaceExistingIndex: boolean; /** * The paragraph style applied to index section headings. Note: Valid when * include section headings is true. */ sectionHeadingStyle: ParagraphStyle; /** * The title of the generated index. */ title: string; /** * The paragraph style applied to the title of the generated index. Can also * accept: String. */ titleStyle: ParagraphStyle | string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): IndexOptions[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the IndexOptions. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A section within an index. */ declare class IndexSection { /** * The topics in the specified index section. */ readonly allTopics: Topic[]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the IndexSection. */ readonly id: number; /** * The index of the IndexSection within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the IndexSection. */ readonly name: string; /** * The parent of the IndexSection (a Index). */ readonly parent: Index_; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of index topics. */ readonly topics: Topics; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): IndexSection[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the IndexSection. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of index sections. */ declare class IndexSections { /** Returns the IndexSection with the specified index or name. */ [index: number]: IndexSection; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any IndexSection in the collection. */ anyItem(): IndexSection; /** * Displays the number of elements in the IndexSection. */ count(): number; /** * Returns every IndexSection in the collection. */ everyItem(): IndexSection; /** * Returns the first IndexSection in the collection. */ firstItem(): IndexSection; /** * Returns the IndexSection with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): IndexSection; /** * Returns the IndexSection with the specified ID. * @param id The ID. */ itemByID(id: number): IndexSection; /** * Returns the IndexSection with the specified name. * @param name The name. */ itemByName(name: string): IndexSection; /** * Returns the IndexSections within the specified range. * @param from The IndexSection, index, or name at the beginning of the range. Can accept: IndexSection, Long Integer or String. * @param to The IndexSection, index, or name at the end of the range. Can accept: IndexSection, Long Integer or String. */ itemByRange(from: IndexSection | number | string, to: IndexSection | number | string): IndexSection[]; /** * Returns the last IndexSection in the collection. */ lastItem(): IndexSection; /** * Returns the middle IndexSection in the collection. */ middleItem(): IndexSection; /** * Returns the IndexSection whose index follows the specified IndexSection in * the collection. * @param obj The IndexSection whose index comes before the desired IndexSection. */ nextItem(obj: IndexSection): IndexSection; /** * Returns the IndexSection with the index previous to the specified index. * @param obj The index of the IndexSection that follows the desired IndexSection. */ previousItem(obj: IndexSection): IndexSection; /** * Generates a string which, if executed, will return the IndexSection. */ toSource(): string; } /** * An index. */ declare class Index_ { /** * The topics in the specified index section. */ readonly allTopics: Topic[]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the Index. */ readonly id: number; /** * The index of the Index within its containing object. */ readonly index: number; /** * A collection of index sections. */ readonly indexSections: IndexSections; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the Index; this is an alias to the Index's label property. */ name: string; /** * The parent of the Index (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of index topics. */ readonly topics: Topics; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Makes the initial letter for the specified index topic or group of index * topics upper case. * @param capitalizationOption The entry or entries to capitalize. (Optional) */ capitalize(capitalizationOption?: IndexCapitalizationOptions): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Generates a new index story. * @param on The spread or page on which to place the story. Can accept: Page, Spread or MasterSpread. (Optional) * @param placePoint The coordinates of the upper left corner of the story bounding box, in the format [x, y]. (Optional) * @param destinationLayer The layer on which to place the story. (Optional) * @param autoflowing If true, allows the story to flow onto subsequent pages if the story does not fit on the specified page. If no subsequent pages exist in the document, creates the necessary pages. (Optional) * @param includeOverset If true, includes topics in overset text in the story. (Optional) */ generate(on?: Page | Spread | MasterSpread, placePoint?: (number | string)[], destinationLayer?: Layer, autoflowing?: boolean, includeOverset?: boolean): Story[]; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Index_[]; /** * Imports a list of index topics. * @param from The file from which to import the topics. */ importTopics(from: File): void; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes all index topics that do not have any index entries. */ removeUnusedTopics(): void; /** * Generates a string which, if executed, will return the Index. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Updates the index preview pane. Note: Does not update the index. */ update(): void; } /** * A collection of indexes. */ declare class Indexes { /** Returns the Index_ with the specified index or name. */ [index: number]: Index_; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new Index. * @param withProperties Initial values for properties of the new Index (Optional) */ add(withProperties?: Object): Index_; /** * Returns any Index in the collection. */ anyItem(): Index_; /** * Displays the number of elements in the Index. */ count(): number; /** * Returns every Index in the collection. */ everyItem(): Index_; /** * Returns the first Index in the collection. */ firstItem(): Index_; /** * Returns the Index with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Index_; /** * Returns the Index with the specified ID. * @param id The ID. */ itemByID(id: number): Index_; /** * Returns the Index with the specified name. * @param name The name. */ itemByName(name: string): Index_; /** * Returns the Indexes within the specified range. * @param from The Index, index, or name at the beginning of the range. Can accept: Index, Long Integer or String. * @param to The Index, index, or name at the end of the range. Can accept: Index, Long Integer or String. */ itemByRange(from: Index_ | number | string, to: Index_ | number | string): Index_[]; /** * Returns the last Index in the collection. */ lastItem(): Index_; /** * Returns the middle Index in the collection. */ middleItem(): Index_; /** * Returns the Index whose index follows the specified Index in the collection. * @param obj The Index whose index comes before the desired Index. */ nextItem(obj: Index_): Index_; /** * Returns the Index with the index previous to the specified index. * @param obj The index of the Index that follows the desired Index. */ previousItem(obj: Index_): Index_; /** * Generates a string which, if executed, will return the Index. */ toSource(): string; } /** * An indexing sort option. */ declare class IndexingSortOption { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The header type. Can return: HeaderTypes enumerator or NothingEnum * enumerator. */ headerType: HeaderTypes | NothingEnum; /** * If true, include this indexing sort option. */ include: boolean; /** * The index of the IndexingSortOption within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the IndexingSortOption. */ readonly name: string; /** * The parent of the IndexingSortOption (a Application or Document). */ readonly parent: Application | Document; /** * Priority of this indexing sort option (shuffles prior entries down). */ priority: number; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): IndexingSortOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the IndexingSortOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of indexing sort options. */ declare class IndexingSortOptions { /** Returns the IndexingSortOption with the specified index or name. */ [index: number]: IndexingSortOption; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any IndexingSortOption in the collection. */ anyItem(): IndexingSortOption; /** * Displays the number of elements in the IndexingSortOption. */ count(): number; /** * Returns every IndexingSortOption in the collection. */ everyItem(): IndexingSortOption; /** * Returns the first IndexingSortOption in the collection. */ firstItem(): IndexingSortOption; /** * Returns the IndexingSortOption with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): IndexingSortOption; /** * Returns the IndexingSortOption with the specified name. * @param name The name. */ itemByName(name: string): IndexingSortOption; /** * Returns the IndexingSortOptions within the specified range. * @param from The IndexingSortOption, index, or name at the beginning of the range. Can accept: IndexingSortOption, Long Integer or String. * @param to The IndexingSortOption, index, or name at the end of the range. Can accept: IndexingSortOption, Long Integer or String. */ itemByRange(from: IndexingSortOption | number | string, to: IndexingSortOption | number | string): IndexingSortOption[]; /** * Returns the last IndexingSortOption in the collection. */ lastItem(): IndexingSortOption; /** * Returns the middle IndexingSortOption in the collection. */ middleItem(): IndexingSortOption; /** * Returns the IndexingSortOption whose index follows the specified * IndexingSortOption in the collection. * @param obj The IndexingSortOption whose index comes before the desired IndexingSortOption. */ nextItem(obj: IndexingSortOption): IndexingSortOption; /** * Returns the IndexingSortOption with the index previous to the specified * index. * @param obj The index of the IndexingSortOption that follows the desired IndexingSortOption. */ previousItem(obj: IndexingSortOption): IndexingSortOption; /** * Generates a string which, if executed, will return the IndexingSortOption. */ toSource(): string; } /** * An ink. */ declare class Ink { /** * The ink object to map this ink to. */ aliasInkName: string; /** * The angle of the ink. (Range: 0 to 360) * @remarks Range: 0 to 360 */ angle: number; /** * Converts spot inks to process inks. */ convertToProcess: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The frequency of the ink. (Range: 1 to 500) * @remarks Range: 1 to 500 */ frequency: number; /** * The unique ID of the Ink. */ readonly id: number; /** * The index of the Ink within its containing object. */ readonly index: number; /** * The trapping type of the ink. */ inkType: InkTypes; /** * If true, the ink is a process ink. */ readonly isProcessInk: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the Ink. */ readonly name: string; /** * The neutral density of the ink. (Range: 0.001 to 10.0) * @remarks Range: 0.001 to 10 */ neutralDensity: number; /** * The parent of the Ink (a Application or Document). */ readonly parent: Application | Document; /** * If true, prints the ink. Only valid when printing separations. */ printInk: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The solidity value of the ink. (Range: 0.0 to 1.0) * @remarks Range: 0 to 1 */ readonly solidity: number; /** * The place of the ink in the trapping sequence. */ trapOrder: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Ink[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Ink. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Ink trapping type options. */ declare enum InkTypes { /** * Uses traditional process inks and most spot inks. */ NORMAL = 1852797549, /** * Uses heavy, nontransparent inks to prevent trapping of underlying colors but * allow for trapping along the edges of the ink. Best for metallic inks. */ OPAQUE = 1769230192, /** * Uses heavy, nontransparent inks to prevent trapping of underlying colors but * allow for trapping along the edges of the ink. Best for inks that have * undesirable interactions with other inks. */ OPAQUE_IGNORE = 1769228647, /** * Uses clear inks to ensure that underlying items trap. Best for varnishes and * dieline inks. */ TRANSPARENT = 1769231474, } /** * A collection of inks. */ declare class Inks { /** Returns the Ink with the specified index or name. */ [index: number]: Ink; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Ink in the collection. */ anyItem(): Ink; /** * Displays the number of elements in the Ink. */ count(): number; /** * Returns every Ink in the collection. */ everyItem(): Ink; /** * Returns the first Ink in the collection. */ firstItem(): Ink; /** * Returns the Ink with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Ink; /** * Returns the Ink with the specified ID. * @param id The ID. */ itemByID(id: number): Ink; /** * Returns the Ink with the specified name. * @param name The name. */ itemByName(name: string): Ink; /** * Returns the Inks within the specified range. * @param from The Ink, index, or name at the beginning of the range. Can accept: Ink, Long Integer or String. * @param to The Ink, index, or name at the end of the range. Can accept: Ink, Long Integer or String. */ itemByRange(from: Ink | number | string, to: Ink | number | string): Ink[]; /** * Returns the last Ink in the collection. */ lastItem(): Ink; /** * Returns the middle Ink in the collection. */ middleItem(): Ink; /** * Returns the Ink whose index follows the specified Ink in the collection. * @param obj The Ink whose index comes before the desired Ink. */ nextItem(obj: Ink): Ink; /** * Returns the Ink with the index previous to the specified index. * @param obj The index of the Ink that follows the desired Ink. */ previousItem(obj: Ink): Ink; /** * Generates a string which, if executed, will return the Ink. */ toSource(): string; } /** * Inner glow effect settings. */ declare class InnerGlowSetting extends Preference { /** * If true, the inner glow effect is applied. */ applied: boolean; /** * The blending mode for the inner glow effect. */ blendMode: BlendMode; /** * The color applied to the inner glow, specified as a swatch (color, gradient, * tint, or mixed ink), or as an array of color values. The color mode dictates * the array values: for RGB, specify three values, each in the range 0 to 255, * in the format [R,G,B]; for CMYK, specify four values, each as a percentage * and each in the range 0 to 100, in the format [C,M,Y,K]; for LAB, specify * three values in the format [L,A,B], with L in the range 0 to 100 and A and B * in the range -128 to 127. */ effectColor: Swatch; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The amount (as a percentage) of noise applied to the inner glow. (Range: 0 * to 100) * @remarks Range: 0 to 100 */ noise: number; /** * The opacity of the inner glow (as a percentage). (Range: 0 to 100) * @remarks Range: 0 to 100 */ opacity: number; /** * The parent of the InnerGlowSetting (a TransparencySetting, * StrokeTransparencySetting, FillTransparencySetting or * ContentTransparencySetting). */ readonly parent: FillTransparencySetting | StrokeTransparencySetting | ContentTransparencySetting | TransparencySetting; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The size of the inner glow. * @remarks Measurement unit — also accepts a string such as "12mm". */ size: number | string; /** * The light source of the inner glow effect. */ source: InnerGlowSource; /** * The amount of spread (as a percentage of the inner glow size). (Range: 0 to * 100) * @remarks Range: 0 to 100 */ spread: number; /** * The technique used for the inner glow. */ technique: GlowTechnique; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): InnerGlowSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the InnerGlowSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Inner glow source options. */ declare enum InnerGlowSource { /** * The glow radiates from the object's center. */ CENTER_SOURCED = 2020618593, /** * The glow radiates from the edge of the object. */ EDGE_SOURCED = 2020618594, } /** * Inner shadow effect settings. */ declare class InnerShadowSetting extends Preference { /** * The angle at which the inner shadow is thrown. (Range: -360 to 360) * @remarks Range: -180 to 180 */ angle: number; /** * If true, the inner shadow effect is applied. */ applied: boolean; /** * The blending mode for the inner shadow effect. */ blendMode: BlendMode; /** * The amount to choke the inner shadow (as a percentage of shadow size). * (Range: 0 to 100) * @remarks Range: 0 to 100 */ chokeAmount: number; /** * The distance between the InnerShadowSetting and the shadow. * @remarks Measurement unit — also accepts a string such as "12mm". */ distance: number | string; /** * The color applied to the inner shadow, specified as a swatch (color, * gradient, tint, or mixed ink), or as an array of color values. The color * mode dictates the array values: for RGB, specify three values, each in the * range 0 to 255, in the format [R,G,B]; for CMYK, specify four values, each * as a percentage and each in the range 0 to 100, in the format [C,M,Y,K]; for * LAB, specify three values in the format [L,A,B], with L in the range 0 to * 100 and A and B in the range -128 to 127. */ effectColor: Swatch; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The amount (as a percentage) of noise to add to the shadow. (Range: 0 to * 100) * @remarks Range: 0 to 100 */ noise: number; /** * The opacity (as a percentage) of the inner shadow. (Range: 0 to 100) * @remarks Range: 0 to 100 */ opacity: number; /** * The parent of the InnerShadowSetting (a TransparencySetting, * StrokeTransparencySetting, FillTransparencySetting or * ContentTransparencySetting). */ readonly parent: FillTransparencySetting | StrokeTransparencySetting | ContentTransparencySetting | TransparencySetting; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The size of the inner shadow. * @remarks Measurement unit — also accepts a string such as "12mm". */ size: number | string; /** * If true, the global light angle is used. */ useGlobalLight: boolean; /** * The horizontal offset of the shadow * @remarks Measurement unit — also accepts a string such as "12mm". */ xOffset: number | string; /** * The vertical offset of the shadow * @remarks Measurement unit — also accepts a string such as "12mm". */ yOffset: number | string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): InnerShadowSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the InnerShadowSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * An insertion point between two characters. */ declare class InsertionPoint extends Text { /** * If true, aligns the baseline of the text to the baseline grid. */ alignToBaseline: boolean; /** * Lists all graphics contained by the InsertionPoint. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the InsertionPoint. */ readonly allPageItems: PageItem[]; /** * If true, words unassociated with a hyphenation dictionary can break to the * next line on any character. */ allowArbitraryHyphenation: boolean; /** * The character style applied to the text. Can also accept: String. */ appliedCharacterStyle: CharacterStyle | string; /** * The applied conditions. */ appliedConditions: Condition[]; /** * The font applied to the InsertionPoint, specified as either a font object or * the name of font family. Can return: Font or String. */ appliedFont: Font | string; /** * The language of the text. Can return: LanguageWithVendors or Language. Can * also accept: String. */ appliedLanguage: LanguageWithVendors | string | Language; /** * The applied character styles dictated by nested styles. */ readonly appliedNestedStyles: CharacterStyle[]; /** * The list to be part of. Can return: NumberingList or String. */ appliedNumberingList: NumberingList | string; /** * The paragraph style applied to the text. Can also accept: String. */ appliedParagraphStyle: ParagraphStyle | string; /** * The maximum ascent of any character in the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly ascent: number | string; /** * The XML elements associated with the InsertionPoint. */ readonly associatedXMLElements: XMLItem[]; /** * The percent of the type size to use for auto leading. (Range: 0 to 500). * @remarks Range: 0 to 500 */ autoLeading: number; /** * The number of half-width characters at or below which the characters * automatically run horizontally in vertical text. */ autoTcy: number; /** * If true, auto tcy includes Roman characters. */ autoTcyIncludeRoman: boolean; /** * If true or set to an enumeration value, balances ragged lines. Note: Not * valid with a single-line text composer. Can return: Boolean or * BalanceLinesStyle enumerator. */ balanceRaggedLines: boolean | BalanceLinesStyle; /** * The vertical offset of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly baseline: number | string; /** * The baseline shift applied to the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ baselineShift: number | string; /** * Bullet character. */ readonly bulletChar: Bullet; /** * The alignment of the bullet character. */ bulletsAlignment: ListAlignment; /** * List type for bullets and numbering. */ bulletsAndNumberingListType: ListType; /** * The character style to be used for the text after string. Can return: * CharacterStyle or String. */ bulletsCharacterStyle: CharacterStyle | string; /** * The text after string expression for bullets. */ bulletsTextAfter: string; /** * If true, adds the double period (..), ellipse (...), and double hyphen (--) * to the selected kinsoku set. Note: Valid only when a kinsoku set is in * effect. */ bunriKinshi: boolean; /** * A collection of buttons. */ readonly buttons: Buttons; /** * The capitalization scheme. */ capitalization: Capitalization; /** * The alignment of small characters to the largest character in the line. */ characterAlignment: CharacterAlignment; /** * The direction of the character. */ characterDirection: CharacterDirectionOptions; /** * The rotation angle (in degrees) of individual characters. Note: The rotation * is counterclockwise. */ characterRotation: number; /** * A collection of characters. */ readonly characters: Characters; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * If true, uses grid tracking to track non-Roman characters in CJK grids. */ cjkGridTracking: boolean; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * The text composer to use to compose the text. */ composer: string; /** * The contents of the text. Can return: String or SpecialCharacters * enumerator. */ contents: string | SpecialCharacters; /** * The maximum descent of any character in the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly descent: number | string; /** * Value of Design Axes */ designAxes: number[]; /** * The desired width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ desiredGlyphScaling: number; /** * The desired letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) */ desiredLetterSpacing: number; /** * The desired word spacing, specified as a percentage of the font word space * value. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ desiredWordSpacing: number; /** * Position of diacriticical characters. */ diacriticPosition: DiacriticPositionOptions; /** * The digits type. */ digitsType: DigitsTypeOptions; /** * The number of characters to drop cap. * @remarks Range: 0 to 150 */ dropCapCharacters: number; /** * The number of lines to drop cap. * @remarks Range: 0 to 25 */ dropCapLines: number; /** * The character style to apply to the drop cap. Can also accept: String. */ dropCapStyle: CharacterStyle | string; /** * Details about the drop cap based on the glyph outlines. 1 = left side * bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid. */ dropcapDetail: number; /** * Vertical offset of the end of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly endBaseline: number | string; /** * Horizontal offset of the end of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly endHorizontalOffset: number | string; /** * The stroke join type applied to the characters of the text. */ endJoin: OutlineJoin; /** * A collection of endnote text ranges. */ readonly endnoteRanges: EndnoteRanges; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * A collection of endnotes. */ readonly endnotes: Endnotes; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * InsertionPoint. . Can also accept: String. */ fillColor: Swatch | string; /** * The tint (as a percentage) of the fill color of the InsertionPoint. (To * specify a tint percentage, use a number in the range of 0 to 100; to use the * inherited or overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * The amount to indent the first line. * @remarks Measurement unit — also accepts a string such as "12mm". */ firstLineIndent: number | string; /** * The name of the font style. */ fontStyle: string; /** * A collection of footnotes. */ readonly footnotes: Footnotes; /** * A collection of form fields. */ readonly formFields: FormFields; /** * The glyph variant to substitute for standard glyphs. */ glyphForm: AlternateGlyphForms; /** * The angle of a linear gradient applied to the fill of the text. (Range: -180 * to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the text. */ gradientFillLength: number; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the text. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the text. */ gradientStrokeLength: number; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * If true, aligns only the first line to the frame grid or baseline grid. If * false, aligns all lines to the grid. */ gridAlignFirstLineOnly: boolean; /** * The alignment to the frame grid or baseline grid. */ gridAlignment: GridAlignment; /** * The manual gyoudori setting. */ gridGyoudori: number; /** * A collection of groups. */ readonly groups: Groups; /** * A collection of hidden text objects. */ readonly hiddenTexts: HiddenTexts; /** * The horizontal offset of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly horizontalOffset: number | string; /** * The horizontal scaling applied to the InsertionPoint. */ horizontalScale: number; /** * The relative desirability of better spacing vs. fewer hyphens. A lower value * results in greater use of hyphens. (Range: 0 to 100) * @remarks Range: 0 to 10 */ hyphenWeight: number; /** * If true, allows the last word in a text column to be hyphenated. */ hyphenateAcrossColumns: boolean; /** * The mininum number of letters at the beginning of a word that can be broken * by a hyphen. * @remarks Range: 1 to 15 */ hyphenateAfterFirst: number; /** * The minimum number of letters at the end of a word that can be broken by a * hyphen. * @remarks Range: 1 to 15 */ hyphenateBeforeLast: number; /** * If true, allows hyphenation of capitalized words. */ hyphenateCapitalizedWords: boolean; /** * The maximum number of hyphens that can appear on consecutive lines. To * specify unlimited consecutive lines, use zero. * @remarks Range: 0 to 25 */ hyphenateLadderLimit: number; /** * If true, allows hyphenation in the last word in a paragraph. Note: Valid * only when hyphenation is true. */ hyphenateLastWord: boolean; /** * The minimum number of letters a word must have in order to qualify for * hyphenation. * @remarks Range: 3 to 25 */ hyphenateWordsLongerThan: number; /** * If true, allows hyphenation. */ hyphenation: boolean; /** * The amount of white space allowed at the end of a line of non-justified text * before hypenation begins. Note: Valid when composer is single-line composer. * @remarks Measurement unit — also accepts a string such as "12mm". */ hyphenationZone: number | string; /** * If true, ignores optical edge alignment for the paragraph. */ ignoreEdgeAlignment: boolean; /** * The index of the text in the collection or parent object. */ readonly index: number; /** * A collection of insertion points. */ readonly insertionPoints: InsertionPoints; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The number of grid squares in which to arrange the text. */ jidori: number; /** * The paragraph alignment. */ justification: Justification; /** * Use of Kashidas for justification */ kashidas: KashidasOptions; /** * If true, keeps all lines of the paragraph together. If false, allows * paragraphs to break across pages or columns. */ keepAllLinesTogether: boolean; /** * The minimum number of lines to keep together in a paragraph before allowing * a page break. * @remarks Range: 1 to 50 */ keepFirstLines: number; /** * The minimum number of lines to keep together in a paragraph after a page * break. * @remarks Range: 1 to 50 */ keepLastLines: number; /** * If true, keeps a specified number of lines together when the paragraph * breaks across columns or text frames. */ keepLinesTogether: boolean; /** * If true, forces the rule above the paragraph to remain in the frame bounds. * Note: Valid only when rule above is true. */ keepRuleAboveInFrame: boolean; /** * The minimum number of lines to keep with the next paragraph. * @remarks Range: 0 to 5 */ keepWithNext: number; /** * If the first line in the paragraph should be kept with the last line of * previous paragraph. */ keepWithPrevious: boolean; /** * The alignment of kenten characters relative to the parent characters. */ kentenAlignment: KentenAlignment; /** * The character set used for the custom kenten character. Note: Valid only * when kenten kind is custom. */ kentenCharacterSet: KentenCharacterSet; /** * The character used for kenten. Note: Valid only when kenten kind is custom. */ kentenCustomCharacter: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of * kenten characters. Can return: Swatch or String. */ kentenFillColor: Swatch | string; /** * The font to use for kenten characters. Can return: Font or String. */ kentenFont: Font | string; /** * The size (in points) of kenten characters. */ kentenFontSize: number; /** * The font style of kenten characters. Can return: String or NothingEnum * enumerator. */ kentenFontStyle: string | NothingEnum; /** * The style of kenten characters. */ kentenKind: KentenCharacter; /** * The method of overprinting the kenten fill. */ kentenOverprintFill: AdornmentOverprint; /** * The method of overprinting the kenten stroke. */ kentenOverprintStroke: AdornmentOverprint; /** * The distance between kenten characters and their parent characters. */ kentenPlacement: number; /** * The kenten position relative to the parent character. */ kentenPosition: RubyKentenPosition; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * kenten characters. Can return: Swatch or String. */ kentenStrokeColor: Swatch | string; /** * The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenStrokeTint: number; /** * The fill tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenTint: number; /** * The stroke weight (in points) of kenten characters. */ kentenWeight: number; /** * The horizontal size of kenten characters as a percent of the original size. */ kentenXScale: number; /** * The vertical size of kenten charachers as a percent of the original size. */ kentenYScale: number; /** * The type of pair kerning. */ kerningMethod: string; /** * The amount of space to add or remove between characters, specified in * thousands of an em. */ kerningValue: number; /** * The keyboard direction of the character. */ keyboardDirection: CharacterDirectionOptions; /** * The type of hanging punctuation to allow. Note: Valid only when a kinsoku * set is in effect. */ kinsokuHangType: KinsokuHangTypes; /** * The kinsoku set that determines legitimate line breaks. Can return: * KinsokuTable, KinsokuSet enumerator or String. */ kinsokuSet: KinsokuSet | KinsokuTable | string; /** * The type of kinsoku processing for preventing kinsoku characters from * beginning or ending a line. Note: Valid only when a kinsoku set is defined. */ kinsokuType: KinsokuType; /** * The amount to indent the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ lastLineIndent: number | string; /** * The leading applied to the text. Can return: Unit or Leading enumerator. */ leading: number | Leading; /** * The amount of space before each character. */ leadingAki: number; /** * The point from which leading is measured from line to line. */ leadingModel: LeadingModel; /** * The width of the left indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ leftIndent: number | string; /** * The number of objects in the collection. */ readonly length: number; /** * If true, replaces specific character combinations (e.g., fl, fi) with * ligature characters. */ ligatures: boolean; /** * A collection of lines. */ readonly lines: Lines; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * The maximum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ maximumGlyphScaling: number; /** * The maximum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ maximumLetterSpacing: number; /** * The maximum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ maximumWordSpacing: number; /** * If true, consecutive para borders with completely similar properties are * merged. */ mergeConsecutiveParaBorders: boolean; /** * The minimum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ minimumGlyphScaling: number; /** * The minimum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ minimumLetterSpacing: number; /** * The minimum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ minimumWordSpacing: number; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 0 to 1000 */ miterLimit: number; /** * The mojikumi table. For information, see mojikumi table defaults. Can * return: MojikumiTable, String or MojikumiTableDefaults enumerator. */ mojikumi: MojikumiTable | string | MojikumiTableDefaults; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * A collection of nested GREP styles. */ readonly nestedGrepStyles: NestedGrepStyles; /** * A collection of nested line styles. */ readonly nestedLineStyles: NestedLineStyles; /** * A collection of nested styles. */ readonly nestedStyles: NestedStyles; /** * If true, keeps the text on the same line. */ noBreak: boolean; /** * A collection of notes. */ readonly notes: Notes; /** * The alignment of the number. */ numberingAlignment: ListAlignment; /** * If true, apply the numbering restart policy. */ numberingApplyRestartPolicy: boolean; /** * The character style to be used for the number string. Can return: * CharacterStyle or String. */ numberingCharacterStyle: CharacterStyle | string; /** * Continue the numbering at this level. */ numberingContinue: boolean; /** * The number string expression for numbering. */ numberingExpression: string; /** * Numbering format options. Can return: NumberingStyle enumerator or String. */ numberingFormat: NumberingStyle | string; /** * The level of the paragraph. */ numberingLevel: number; /** * Numbering restart policies. */ readonly numberingRestartPolicies: NumberingRestartPolicy; /** * Determines starting number in a numbered list. */ numberingStartAt: number; /** * OpenType features. Can return: Array of Array of 2 Strings or Long Integers. */ opentypeFeatures: (string[][] | number[])[]; /** * If true, uses contextual alternate forms in OpenType fonts. */ otfContextualAlternate: boolean; /** * If true, uses discretionary ligatures in OpenType fonts. */ otfDiscretionaryLigature: boolean; /** * The figure style in OpenType fonts. */ otfFigureStyle: OTFFigureStyle; /** * If true, uses fractions in OpenType fonts. */ otfFraction: boolean; /** * If true, switches hiragana fonts, which have different glyphs for horizontal * and vertical. */ otfHVKana: boolean; /** * If true, use historical forms in OpenType fonts. */ otfHistorical: boolean; /** * If true, use alternate justification forms in OpenType fonts */ otfJustificationAlternate: boolean; /** * If true, uses localized forms in OpenType fonts. */ otfLocale: boolean; /** * If true, uses mark positioning in OpenType fonts. */ otfMark: boolean; /** * If true, uses ordinals in OpenType fonts. */ otfOrdinal: boolean; /** * If true, use overlapping swash forms in OpenType fonts */ otfOverlapSwash: boolean; /** * If true, kerns according to proportional CJK metrics in OpenType fonts. */ otfProportionalMetrics: boolean; /** * If true, applies italics to half-width alphanumerics. */ otfRomanItalics: boolean; /** * If true, use a slashed zeroes in OpenType fonts. */ otfSlashedZero: boolean; /** * If true, use stretched alternate forms in OpenType fonts */ otfStretchedAlternate: boolean; /** * If true, use stylistic alternate forms in OpenType fonts */ otfStylisticAlternate: boolean; /** * The stylistic sets to use in OpenType fonts. */ otfStylisticSets: number; /** * If true, uses swash forms in OpenType fonts. */ otfSwash: boolean; /** * If true, uses titling forms in OpenType fonts. */ otfTitling: boolean; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the fill color of the characters will overprint. */ overprintFill: boolean; /** * If true, the stroke of the characters will overprint. */ overprintStroke: boolean; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphBorderBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLeftCornerRadius: number | string; /** * The bottom line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLineWeight: number | string; /** * The distance to offset the bottom edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph border. */ paragraphBorderBottomOrigin: ParagraphBorderBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphBorderBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomRightCornerRadius: number | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * stroke. Can return: Swatch or String. */ paragraphBorderColor: Swatch | string; /** * If true, then paragraph border is also displayed at the points where the * paragraph splits across frames or columns. */ paragraphBorderDisplayIfSplits: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * border gap. Note: Valid only when the border type is not solid. Can return: * Swatch or String. */ paragraphBorderGapColor: Swatch | string; /** * If true, the paragraph border gap will overprint. Note: Valid only when * border type is not solid. */ paragraphBorderGapOverprint: boolean; /** * The tint (as a percentage) of the paragraph border gap. Note: Valid only * when the border type is not solid. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderGapTint: number; /** * The left line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftLineWeight: number | string; /** * The distance to offset the left edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftOffset: number | string; /** * If true, the paragraph border is on. */ paragraphBorderOn: boolean; /** * If true, the paragraph border will overprint. */ paragraphBorderOverprint: boolean; /** * The right line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightLineWeight: number | string; /** * The distance to offset the right edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightOffset: number | string; /** * The end shape of an open path. */ paragraphBorderStrokeEndCap: EndCap; /** * The corner join applied to the InsertionPoint. */ paragraphBorderStrokeEndJoin: EndJoin; /** * The tint (as a percentage) of the paragraph stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphBorderTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLeftCornerRadius: number | string; /** * The top line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLineWeight: number | string; /** * The distance to offset the top edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph border. */ paragraphBorderTopOrigin: ParagraphBorderTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphBorderTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopRightCornerRadius: number | string; /** * The type of the border for the paragraph. Can return: StrokeStyle or String. */ paragraphBorderType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph border. */ paragraphBorderWidth: ParagraphBorderEnum; /** * Paragraph direction. */ paragraphDirection: ParagraphDirectionOptions; /** * If true, the gyoudori mode applies to the entire paragraph. If false, the * gyoudori mode applies to each line in the paragraph. */ paragraphGyoudori: boolean; /** * Paragraph justification. */ paragraphJustification: ParagraphJustificationOptions; /** * Paragraph kashida width. 0 is none, 1 is short, 2 is medium, 3 is long */ paragraphKashidaWidth: number; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphShadingBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomLeftCornerRadius: number | string; /** * The distance to offset the bottom edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph shading. */ paragraphShadingBottomOrigin: ParagraphShadingBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphShadingBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomRightCornerRadius: number | string; /** * If true, forces the shading of the paragraph to be clipped with respect to * frame shape. */ paragraphShadingClipToFrame: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * shading. Can return: Swatch or String. */ paragraphShadingColor: Swatch | string; /** * The distance to offset the left edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingLeftOffset: number | string; /** * If true, the paragraph shading is On. */ paragraphShadingOn: boolean; /** * If true, the paragraph shading will overprint. */ paragraphShadingOverprint: boolean; /** * The distance to offset the right edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingRightOffset: number | string; /** * If true, suppress printing of the shading of the paragraph. */ paragraphShadingSuppressPrinting: boolean; /** * The tint (as a percentage) of the paragraph shading. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphShadingTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphShadingTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopLeftCornerRadius: number | string; /** * The distance to offset the top edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph shading. */ paragraphShadingTopOrigin: ParagraphShadingTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphShadingTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopRightCornerRadius: number | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph shading. */ paragraphShadingWidth: ParagraphShadingWidthEnum; /** * A collection of paragraphs. */ readonly paragraphs: Paragraphs; /** * The parent of the InsertionPoint (a XmlStory, TextPath, TextFrame, * EndnoteTextFrame, Text, InsertionPoint, TextStyleRange, Paragraph, * TextColumn, Line, Word, Character, Story, Cell, XMLElement, Endnote, * Footnote, Note, Change or HiddenText). */ readonly parent: Cell | Change | Character | Endnote | EndnoteTextFrame | Footnote | InsertionPoint | Line | Note | Paragraph | Story | Text | TextColumn | TextFrame | TextPath | TextStyleRange | Word | XMLElement | HiddenText | XmlStory; /** * The story that contains the text. */ readonly parentStory: Story; /** * An array of the text frames that contain the text. Can return: Array of * TextFrames or TextPaths. */ readonly parentTextFrames: (TextFrames | TextPaths)[]; /** * The text size. * @remarks Measurement unit — also accepts a string such as "12mm". */ pointSize: number | string; /** * A collection of polygons. */ readonly polygons: Polygons; /** * The text position relative to the baseline. */ position: Position; /** * The OpenType positional form. */ positionalForm: PositionalForms; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The hyphenation style chosen for the provider. */ providerHyphenationStyle: HyphenationStyleEnum; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * If true, disallows line breaks in numbers. If false, lines can break between * digits in multi-digit numbers. */ rensuuji: boolean; /** * The width of the right indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ rightIndent: number | string; /** * If true, rotates Roman characters in vertical text. */ rotateSingleByteCharacters: boolean; /** * The ruby alignment. */ rubyAlignment: RubyAlignments; /** * If true, auto aligns ruby. */ rubyAutoAlign: boolean; /** * If true, automatically scales ruby to the specified percent of parent text * size. For information on specifying a percent, see ruby parent scaling * percent. */ rubyAutoScaling: boolean; /** * If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to * fit one em. */ rubyAutoTcyAutoScale: boolean; /** * The number of digits included in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyDigits: number; /** * If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyIncludeRoman: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby * characters. Can return: Swatch or String. */ rubyFill: Swatch | string; /** * If true, ruby is on. */ rubyFlag: boolean; /** * The font applied to ruby characters. Can return: Font or String. */ rubyFont: Font | string; /** * The size (in points) of ruby characters. */ rubyFontSize: number; /** * The font style of ruby characters. Can return: String or NothingEnum * enumerator. */ rubyFontStyle: string | NothingEnum; /** * If true, uses OpenType Pro fonts for ruby. */ rubyOpenTypePro: boolean; /** * If true, constrains ruby overhang to the specified amount. For information * on specifying an amount, see ruby parent overhang amount. */ rubyOverhang: boolean; /** * The method of overprinting the ruby fill. */ rubyOverprintFill: AdornmentOverprint; /** * The method of overprinting the ruby stroke. */ rubyOverprintStroke: AdornmentOverprint; /** * The amount by which ruby characters can overhang the parent text. */ rubyParentOverhangAmount: RubyOverhang; /** * The amount (as a percentage) to scale the parent text size to determine the * ruby text size. */ rubyParentScalingPercent: number; /** * The ruby spacing relative to the parent text. */ rubyParentSpacing: RubyParentSpacing; /** * The position of ruby characters relative to the parent text. */ rubyPosition: RubyKentenPosition; /** * The ruby string contents. */ rubyString: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * ruby characters. Can return: Swatch or String. */ rubyStroke: Swatch | string; /** * The stroke tint (as a percentage) of ruby characters. */ rubyStrokeTint: number; /** * The tint (as a percentage) of the ruby fill color. (Range: 0 to 100) * @remarks Range: 0 to 100 */ rubyTint: number; /** * The ruby type. */ rubyType: RubyTypes; /** * The stroke weight (in points) of ruby characters. */ rubyWeight: number; /** * The amount of horizontal space between ruby and parent characters. */ rubyXOffset: number; /** * The horizontal size of ruby characters, specified as a percent of the * original size. */ rubyXScale: number; /** * The amount of vertical space between ruby and parent characters. */ rubyYOffset: number; /** * The vertical size of ruby characters, specified as a percent of the original * size. */ rubyYScale: number; /** * If true, places a rule above the paragraph. */ ruleAbove: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule above. Can return: Swatch or String. */ ruleAboveColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule above. Note: Valid only when the paragraph rule above * type is not solid. Can return: Swatch or String. */ ruleAboveGapColor: Swatch | string; /** * If true, the stroke gap of the paragraph rule above will overprint. Note: * Valid only the rule above type is not solid. */ ruleAboveGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule. * (Range: 0 to 100) Note: Valid only when the rule above type is not solid. * @remarks Range: 0 to 100 */ ruleAboveGapTint: number; /** * The distance to indent the left edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLeftIndent: number | string; /** * The line weight of the rule above. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLineWeight: number | string; /** * The amount to offset the paragraph rule above from the baseline of the first * line the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveOffset: number | string; /** * If true, the paragraph rule above will overprint. */ ruleAboveOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleAboveTint: number; /** * The stroke type of the rule above the paragraph. Can return: StrokeStyle or * String. */ ruleAboveType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule above. */ ruleAboveWidth: RuleWidth; /** * If true, applies a paragraph rule below. */ ruleBelow: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule below. Can return: Swatch or String. */ ruleBelowColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule below. Note: Valid only when the paragraph rule below * type is not solid. Can return: Swatch or String. */ ruleBelowGapColor: Swatch | string; /** * If true, the gap color of the rule below will overprint. */ ruleBelowGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule * below. (Range: 0 to 100) Note: Valid only when the paragraph rule below type * is not solid. * @remarks Range: 0 to 100 */ ruleBelowGapTint: number; /** * The distance to indent the left edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLeftIndent: number | string; /** * The line weight of the rule below. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLineWeight: number | string; /** * The amount to offset the the paragraph rule below from the baseline of the * last line of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowOffset: number | string; /** * If true, the rule below will overprint. */ ruleBelowOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleBelowTint: number; /** * The stroke type of the rule below the paragraph. Can return: StrokeStyle or * String. */ ruleBelowType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule below. */ ruleBelowWidth: RuleWidth; /** * The space between paragraphs using same style. Can return: Unit or Spacing * enumerator. */ sameParaStyleSpacing: number | Spacing; /** * If true, the line changes size when characters are scaled. */ scaleAffectsLineHeight: boolean; /** * If true, applies shatai rotation. */ shataiAdjustRotation: boolean; /** * If true, adjusts shatai tsume. */ shataiAdjustTsume: boolean; /** * The shatai lens angle (in degrees). */ shataiDegreeAngle: number; /** * The amount (as a percentage) of shatai obliquing to apply. */ shataiMagnification: number; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * The alignment to use for lines that contain a single word. */ singleWordJustification: SingleWordJustification; /** * The skew angle of the InsertionPoint. */ skew: number; /** * The height of the paragraph space below. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceAfter: number | string; /** * The height of the paragraph space above. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceBefore: number | string; /** * The minimum space after a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceAfter: number | string; /** * The minimum space before a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceBefore: number | string; /** * Whether a paragraph should be a single column, span columns or split columns */ spanColumnType: SpanColumnTypeOptions; /** * The number of columns a paragraph spans or the number of split columns. Can * return: Short Integer (1 - 40) or SpanColumnCountOptions enumerator. */ spanSplitColumnCount: number | SpanColumnCountOptions; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The inside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnInsideGutter: number | string; /** * The outside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnOutsideGutter: number | string; /** * The location at which to start the paragraph. */ startParagraph: StartParagraph; /** * The swatch (color, gradient, tint, or mixed ink) applied to the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughGapColor: Swatch | string; /** * If true, the gap color of the strikethrough stroke will overprint. Note: * Valid when strike through type is not solid. */ strikeThroughGapOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 * to 100) Note: Valid when strike through type is not solid. * @remarks Range: 0 to 100 */ strikeThroughGapTint: number; /** * The amount by which to offset the strikethrough stroke from the text * baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughOffset: number | string; /** * If true, the strikethrough stroke will overprint. */ strikeThroughOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ strikeThroughTint: number; /** * The stroke type of the strikethrough stroke. Can return: StrokeStyle or * String. */ strikeThroughType: StrokeStyle | string; /** * The stroke weight of the strikethrough stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughWeight: number | string; /** * If true, draws a strikethrough line through the text. */ strikeThru: boolean; /** * The stroke alignment applied to the text. */ strokeAlignment: TextStrokeAlign; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the InsertionPoint. Can also accept: String. */ strokeColor: Swatch | string; /** * The tint (as a percentage) of the stroke color of the InsertionPoint. (To * specify a tint percentage, use a number in the range of 0 to 100; to use the * inherited or overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * The stroke weight applied to the characters of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * If true, the applied style has been overridden with additional attributes. */ readonly styleOverridden: boolean; /** * A list of the tab stops in the paragraph. Can return: Array of Arrays of * Property Name/Value Pairs. */ tabList: any[][][]; /** * A collection of tab stops. */ readonly tabStops: TabStops; /** * A collection of tables. */ readonly tables: Tables; /** * If true, makes the character horizontal in vertical text. */ tatechuyoko: boolean; /** * The horizontal offset for horizontal characters in vertical text. */ tatechuyokoXOffset: number; /** * The vertical offset for horizontal characters in vertical text. */ tatechuyokoYOffset: number; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text columns. */ readonly textColumns: TextColumns; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * A collection of text style ranges. */ readonly textStyleRanges: TextStyleRanges; /** * A collection of text variable instances. */ readonly textVariableInstances: TextVariableInstances; /** * A collection of text objects. */ readonly texts: Texts; /** * The amount by which to loosen or tighten a block of text, specified in * thousands of an em. */ tracking: number; /** * The amount of space after each character. */ trailingAki: number; /** * If true, ideographic spaces will not wrap to the next line like text * characters. */ treatIdeographicSpaceAsSpace: boolean; /** * The amount of horizontal character compression. */ tsume: number; /** * If true, underlines the text. */ underline: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the underline * stroke. . Can return: Swatch or String. */ underlineColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * underline stroke. Note: Valid when underline type is not solid. Can return: * Swatch or String. */ underlineGapColor: Swatch | string; /** * If true, the gap color of the underline stroke will overprint. */ underlineGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of the underline stroke. (Range: * 0 to 100) Note: Valid when underline type is not solid. * @remarks Range: 0 to 100 */ underlineGapTint: number; /** * The amount by which to offset the underline from the text baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineOffset: number | string; /** * If true, the underline stroke color will overprint. */ underlineOverprint: boolean; /** * The underline stroke tint (as a percentage). (Range: 0 to 100) * @remarks Range: 0 to 100 */ underlineTint: number; /** * The stroke type of the underline stroke. Can return: StrokeStyle or String. */ underlineType: StrokeStyle | string; /** * The stroke weight of the underline stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineWeight: number | string; /** * The vertical scaling applied to the InsertionPoint. */ verticalScale: number; /** * If true, turns on warichu. */ warichu: boolean; /** * The warichu alignment. */ warichuAlignment: WarichuAlignment; /** * The minimum number of characters allowed after a line break. */ warichuCharsAfterBreak: number; /** * The minimum number of characters allowed before a line break. */ warichuCharsBeforeBreak: number; /** * The gap between lines of warichu characters. */ warichuLineSpacing: number; /** * The number of lines of warichu within a single normal line. */ warichuLines: number; /** * The amount (as a percentage) to scale parent text size to determine warichu * size. */ warichuSize: number; /** * A collection of words. */ readonly words: Words; /** * The x (horizontal) offset for diacritic adjustment. */ xOffsetDiacritic: number; /** * The y (vertical) offset for diacritic adjustment. */ yOffsetDiacritic: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Apply a character style. * @param using The character style to apply. */ applyCharacterStyle(using: CharacterStyle): void; /** * Apply one or more conditions. * @param using The condition(s) to apply * @param removeExisting If true, remove existing conditions. (Optional) */ applyConditions(using: Condition[], removeExisting?: boolean): void; /** * Apply a paragraph style. * @param using The paragraph style to apply. * @param clearingOverrides If true, clear any text attributes before applying the style. (Optional) */ applyParagraphStyle(using: ParagraphStyle, clearingOverrides?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds glyphs that match the find what value and replaces the glyphs with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value and replaces the text * with the change character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeTransliterate(reverseOrder?: boolean): Text[]; /** * Sets the case of the text. * @param using The text case option. */ changecase(using: ChangecaseMode): void; /** * Clears the specified types of override. * @param overridesToClear The types of override to clear. (Optional) */ clearOverrides(overridesToClear?: OverrideType): void; /** * Convert bullets and numbering to text. */ convertBulletsAndNumberingToText(): void; /** * Converts the text to a note. */ convertToNote(): Note; /** * Converts the text to a table. * @param columnSeparator The character that starts a new column in the new table. (Optional) * @param rowSeparator The character starts a new row in the new table. (Optional) * @param numberOfColumns The number of columns in the table. Note: Valid only when the column and row separator characters are the same. (Optional) */ convertToTable(columnSeparator?: string, rowSeparator?: string, numberOfColumns?: number): Table; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new InsertionPoint. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Creates a new endnote. Internally it creates the endnote reference and its * endnote text range. */ createEndnote(): Endnote; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new InsertionPoint. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Converts text to outlines. Each line of text becomes a polygon object. When * the converted text is a single letter that has no internal spaces or * detached parts, the polygon contains only a single path. Note: To determine * whether a font allows the creation of outlines, see allow outlines. * @param deleteOriginal If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) */ createOutlines(deleteOriginal?: boolean): PageItem[]; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new InsertionPoint. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create thumbnail for selected text using the applied style and overrides * with the given properties. * @param previewText Text to use as sample * @param pointSize Text font size (in points) * @param space Color space RGB, CMYK or LAB * @param colorValue Color values * @param to The path to the export file. * @param charOrParaStyle The applied style type to use. */ createStyleThumbnailWithProperties(previewText: string, pointSize: number, space: ColorSpace, colorValue: number[], to: File, charOrParaStyle: StyleType): boolean; /** * Experimental: Place the text fragment fetched from url onto insertion point * and create a link * @param linkResourceURI Resource URI for the link. * @param name The tag name for the key. (Optional) */ createTextFragmentLink(linkResourceURI: string, name?: string): Link; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new InsertionPoint. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create thumbnail for selected text with the given properties. * @param previewText Text to use as sample * @param pointSize Text font size (in points) * @param space Color space RGB, CMYK or LAB * @param colorValue Color values * @param to The path to the export file. */ createThumbnailWithProperties(previewText: string, pointSize: number, space: ColorSpace, colorValue: number[], to: File): boolean; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new InsertionPoint. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Duplicates the text in the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional) */ duplicate(to: LocationOptions, reference?: Cell | Column | Row | Story | Table | Text | PageItem): Text; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Finds glyphs that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGrep(reverseOrder?: boolean): Text[]; /** * Finds hyperlink sources that intersecting with specified text range. * @param sortOrder The sort order of found ranges. (Optional) */ findHyperlinks(sortOrder?: RangeSortOrder): HyperlinkTextSource[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findTransliterate(reverseOrder?: boolean): Text[]; /** * Resolves the object specifier, creating an array of object references. */ getElements(): InsertionPoint[]; /** * If true, Nth design axis of variable font is hidden. * @param nthAxisIndex Index of design axis. */ isNthDesignAxisHidden(nthAxisIndex: number): boolean; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the text to the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional) */ move(to: LocationOptions, reference?: Cell | Column | Row | Story | Table | Text | PageItem): Text; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Recomposes the text in the InsertionPoint. */ recompose(): void; /** * Deletes the InsertionPoint. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Selects the object. * @param existingSelection The selection status of the InsertionPoint in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Set Nth design axis of a variable font. * @param nthAxisIndex Index of design axis. * @param nthAxisValue Value of nth design axis. */ setNthDesignAxis(nthAxisIndex: number, nthAxisValue: number): void; /** * Jump to the text range. */ showText(): void; /** * If true, text has local overrides * @param charOrParaStyle Style type to look at. * @param charStyleAsOverride Whether to consider character styles as overrides or not (Optional) */ textHasOverrides(charOrParaStyle: StyleType, charStyleAsOverride?: boolean): boolean; /** * Generates a string which, if executed, will return the InsertionPoint. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of insertion points. */ declare class InsertionPoints { /** Returns the InsertionPoint with the specified index or name. */ [index: number]: InsertionPoint; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any InsertionPoint in the collection. */ anyItem(): InsertionPoint; /** * Displays the number of elements in the InsertionPoint. */ count(): number; /** * Returns every InsertionPoint in the collection. */ everyItem(): InsertionPoint; /** * Returns the first InsertionPoint in the collection. */ firstItem(): InsertionPoint; /** * Returns the InsertionPoint with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): InsertionPoint; /** * Returns the InsertionPoints within the specified range. * @param from The InsertionPoint, index, or name at the beginning of the range. Can accept: InsertionPoint, Long Integer or String. * @param to The InsertionPoint, index, or name at the end of the range. Can accept: InsertionPoint, Long Integer or String. */ itemByRange(from: InsertionPoint | number | string, to: InsertionPoint | number | string): InsertionPoint[]; /** * Returns the last InsertionPoint in the collection. */ lastItem(): InsertionPoint; /** * Returns the middle InsertionPoint in the collection. */ middleItem(): InsertionPoint; /** * Returns the InsertionPoint whose index follows the specified InsertionPoint * in the collection. * @param obj The InsertionPoint whose index comes before the desired InsertionPoint. */ nextItem(obj: InsertionPoint): InsertionPoint; /** * Returns the InsertionPoint with the index previous to the specified index. * @param obj The index of the InsertionPoint that follows the desired InsertionPoint. */ previousItem(obj: InsertionPoint): InsertionPoint; /** * Generates a string which, if executed, will return the InsertionPoint. */ toSource(): string; } /** * An integer entry control featuring both a pop-up menu and an entry field. * Note: .5 is rounded up. */ declare class IntegerCombobox extends Widget { /** * The default value in an editbox control. Note: Do not specify both edit * contents and edit value. If both are specified, the one that occurs later in * the script is used. */ editContents: string; /** * The real number default value of the editbox or combobox. Note: For * measurement controls, the value is interpreted in points. The points value * is converted to edit units when the dialog opens. Note: Do not specify both * edit value and edit contents. If both are specified, the one that occurs * later in the script is used. */ editValue: number; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the IntegerCombobox. */ readonly id: number; /** * The index of the IntegerCombobox within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The amount to increment/decrement the value when a user selects the control * and holds down the Shift key while pressing an arrow key on the keyboard. */ largeNudge: number; /** * The maximum value that a user is allowed to type in a numeric editbox or * combobox. Note: The value for a measurement editbox or combobox is * interpreted in points, regardless of the edit units specified for the * control. The points value is converted automatically to the edit unit when * the dialog is opened. */ maximumValue: number; /** * The width of the control. For an editbox or combobox, specifies the minimum * width of the box. */ minWidth: number; /** * The minumim value that a user is allowed to type in a numeric editbox or * combobox. Note: The value for a measurement editbox or combobox is * interpreted in points, regardless of the edit units specified for the * control. The points value is converted automatically to the edit unit when * the dialog is opened. */ minimumValue: number; /** * The parent of the IntegerCombobox (a DialogColumn, DialogRow, EnablingGroup * or BorderPanel). */ readonly parent: DialogRow | EnablingGroup | BorderPanel | DialogColumn; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The amount to increment/decrement the value when the user selects the * control and presses an arrow key on the keyboard. */ smallNudge: number; /** * The menu items on a dropdown or combobox control, as an array of strings. */ stringList: string[]; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): IntegerCombobox[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the IntegerCombobox. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of integer comboboxes. */ declare class IntegerComboboxes { /** Returns the IntegerCombobox with the specified index or name. */ [index: number]: IntegerCombobox; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new IntegerCombobox. * @param withProperties Initial values for properties of the new IntegerCombobox (Optional) */ add(withProperties?: Object): IntegerCombobox; /** * Returns any IntegerCombobox in the collection. */ anyItem(): IntegerCombobox; /** * Displays the number of elements in the IntegerCombobox. */ count(): number; /** * Returns every IntegerCombobox in the collection. */ everyItem(): IntegerCombobox; /** * Returns the first IntegerCombobox in the collection. */ firstItem(): IntegerCombobox; /** * Returns the IntegerCombobox with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): IntegerCombobox; /** * Returns the IntegerCombobox with the specified ID. * @param id The ID. */ itemByID(id: number): IntegerCombobox; /** * Returns the IntegerComboboxes within the specified range. * @param from The IntegerCombobox, index, or name at the beginning of the range. Can accept: IntegerCombobox, Long Integer or String. * @param to The IntegerCombobox, index, or name at the end of the range. Can accept: IntegerCombobox, Long Integer or String. */ itemByRange(from: IntegerCombobox | number | string, to: IntegerCombobox | number | string): IntegerCombobox[]; /** * Returns the last IntegerCombobox in the collection. */ lastItem(): IntegerCombobox; /** * Returns the middle IntegerCombobox in the collection. */ middleItem(): IntegerCombobox; /** * Returns the IntegerCombobox whose index follows the specified * IntegerCombobox in the collection. * @param obj The IntegerCombobox whose index comes before the desired IntegerCombobox. */ nextItem(obj: IntegerCombobox): IntegerCombobox; /** * Returns the IntegerCombobox with the index previous to the specified index. * @param obj The index of the IntegerCombobox that follows the desired IntegerCombobox. */ previousItem(obj: IntegerCombobox): IntegerCombobox; /** * Generates a string which, if executed, will return the IntegerCombobox. */ toSource(): string; } /** * A numeric entry field that rounds to the nearest whole number. Note: .5 is * rounded up. */ declare class IntegerEditbox extends Widget { /** * The default value in an editbox control. Note: Do not specify both edit * contents and edit value. If both are specified, the one that occurs later in * the script is used. */ editContents: string; /** * The real number default value of the editbox or combobox. Note: For * measurement controls, the value is interpreted in points. The points value * is converted to edit units when the dialog opens. Note: Do not specify both * edit value and edit contents. If both are specified, the one that occurs * later in the script is used. */ editValue: number; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the IntegerEditbox. */ readonly id: number; /** * The index of the IntegerEditbox within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The amount to increment/decrement the value when a user selects the control * and holds down the Shift key while pressing an arrow key on the keyboard. */ largeNudge: number; /** * The maximum value that a user is allowed to type in a numeric editbox or * combobox. Note: The value for a measurement editbox or combobox is * interpreted in points, regardless of the edit units specified for the * control. The points value is converted automatically to the edit unit when * the dialog is opened. */ maximumValue: number; /** * The width of the control. For an editbox or combobox, specifies the minimum * width of the box. */ minWidth: number; /** * The minumim value that a user is allowed to type in a numeric editbox or * combobox. Note: The value for a measurement editbox or combobox is * interpreted in points, regardless of the edit units specified for the * control. The points value is converted automatically to the edit unit when * the dialog is opened. */ minimumValue: number; /** * The parent of the IntegerEditbox (a DialogColumn, DialogRow, EnablingGroup * or BorderPanel). */ readonly parent: DialogRow | EnablingGroup | BorderPanel | DialogColumn; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The amount to increment/decrement the value when the user selects the * control and presses an arrow key on the keyboard. */ smallNudge: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): IntegerEditbox[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the IntegerEditbox. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of integer editboxes. */ declare class IntegerEditboxes { /** Returns the IntegerEditbox with the specified index or name. */ [index: number]: IntegerEditbox; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new IntegerEditbox. * @param withProperties Initial values for properties of the new IntegerEditbox (Optional) */ add(withProperties?: Object): IntegerEditbox; /** * Returns any IntegerEditbox in the collection. */ anyItem(): IntegerEditbox; /** * Displays the number of elements in the IntegerEditbox. */ count(): number; /** * Returns every IntegerEditbox in the collection. */ everyItem(): IntegerEditbox; /** * Returns the first IntegerEditbox in the collection. */ firstItem(): IntegerEditbox; /** * Returns the IntegerEditbox with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): IntegerEditbox; /** * Returns the IntegerEditbox with the specified ID. * @param id The ID. */ itemByID(id: number): IntegerEditbox; /** * Returns the IntegerEditboxes within the specified range. * @param from The IntegerEditbox, index, or name at the beginning of the range. Can accept: IntegerEditbox, Long Integer or String. * @param to The IntegerEditbox, index, or name at the end of the range. Can accept: IntegerEditbox, Long Integer or String. */ itemByRange(from: IntegerEditbox | number | string, to: IntegerEditbox | number | string): IntegerEditbox[]; /** * Returns the last IntegerEditbox in the collection. */ lastItem(): IntegerEditbox; /** * Returns the middle IntegerEditbox in the collection. */ middleItem(): IntegerEditbox; /** * Returns the IntegerEditbox whose index follows the specified IntegerEditbox * in the collection. * @param obj The IntegerEditbox whose index comes before the desired IntegerEditbox. */ nextItem(obj: IntegerEditbox): IntegerEditbox; /** * Returns the IntegerEditbox with the index previous to the specified index. * @param obj The index of the IntegerEditbox that follows the desired IntegerEditbox. */ previousItem(obj: IntegerEditbox): IntegerEditbox; /** * Generates a string which, if executed, will return the IntegerEditbox. */ toSource(): string; } /** * Options for how to draw interactive elements. */ declare enum InteractiveElementsOptions { /** * Draw interactive elements appearance only. */ APPEARANCE_ONLY = 1097887823, /** * Do not include interactive elements. */ DO_NOT_INCLUDE = 1145981283, } /** * Interactive PDF export settings for the application object. */ declare class InteractivePDFExportPreference extends Preference { /** * Sets the default document language in the exported PDF. The correct ISO code * of the language must be provided. */ defaultDocumentLanguage: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Export each page or spread as a separate PDF file. */ exportAsSinglePages: boolean; /** * If true, export hidden spreads in PDF. If false, skip export of hidden * spreads. */ exportHiddenSpread: boolean; /** * If true, saves each layer as an Acrobat layer within the PDF document. */ exportLayers: boolean; /** * If true, each spread in the exported document is combined into a single page * that has spread's original width. */ exportReaderSpreads: boolean; /** * Automatically flip pages in the exported PDF. */ flipPages: boolean; /** * The speed that the pages flip. * @remarks Range: 0 to 32767 */ flipPagesSpeed: number; /** * If true, generates thumbnail images for each page or spread. */ generateThumbnails: boolean; /** * If true, creates a tagged PDF file. Note: If acrobat compatibility is * acrobat 6 or higher, tags are visible only when the PDF is opened in Acrobat * 6 or higher. */ includeStructure: boolean; /** * How to draw interactive elements. */ interactivePDFInteractiveElementsOption: InteractivePDFInteractiveElementsOptions; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * Open PDF in full screen mode. */ openInFullScreen: boolean; /** * The pages to print, specified either as an enumeration or a string. To * specify a range, separate page numbers in the string with a hyphen (-). To * specify separate pages, separate page numbers in the string with a comma * (,). Can return: PageRange enumerator or String. */ pageRange: PageRange | string; /** * The name of the page transition to use for all pages. */ pageTransitionOverride: PageTransitionOverrideOptions; /** * The parent of the InteractivePDFExportPreference (a Application). */ readonly parent: Application; /** * The export PDF display title. */ pdfDisplayTitle: PdfDisplayTitleOptions; /** * The PDF JPEG quality options. */ pdfJPEGQuality: PDFJPEGQualityOptions; /** * The export PDF magnification options. */ pdfMagnification: PdfMagnificationOptions; /** * The export PDF page layout. */ pdfPageLayout: PageLayoutOptions; /** * The PDF raster compression options. */ pdfRasterCompression: PDFRasterCompressionOptions; /** * If true, retains editing information in the exported PDF, allowing the * document to be re-imported and edited in InDesign. If false, editing * information is not preserved. */ preserveInDesignEditingCapabilities: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The raster resolution. Can return: RasterResolutionOptions enumerator or * Long Integer (72 - 300). */ rasterResolution: RasterResolutionOptions | number; /** * Suffix to be used at the end of each file when pages are exported as * separate PDF files. */ singlePagesPDFSuffix: string; /** * Use tagged PDF structure for interactive elements tab order. */ usePDFStructureForTabOrder: boolean; /** * If true, automatically opens the PDF file after exporting. */ viewPDF: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): InteractivePDFExportPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * InteractivePDFExportPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for how to draw interactive elements. */ declare enum InteractivePDFInteractiveElementsOptions { /** * Draw interactive elements appearance only. */ APPEARANCE_ONLY = 1097887823, /** * Include all interactive elements. */ INCLUDE_ALL_MEDIA = 1231241580, } /** * JPEG export preferences. */ declare class JPEGExportPreference extends Preference { /** * If true, use anti-aliasing for text and vectors during export. */ antiAlias: boolean; /** * True to embed the color profile, false otherwise. */ embedColorProfile: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The export resolution expressed as a real number instead of an integer. * (Range: 1.0 to 2400.0) * @remarks Range: 1 to 2400 */ exportResolution: number; /** * If true, export hidden spreads. If false, skip export of hidden spreads. */ exportingHiddenSpread: boolean; /** * If true, exports each spread as a single JPEG file. If false, exports facing * pages as separate files and appends sequential numbers to each file name. */ exportingSpread: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * One of RGB, CMYK or Gray */ jpegColorSpace: JpegColorSpaceEnum; /** * The page range to export. */ jpegExportRange: ExportRangeOrAllPages; /** * The compression quality. */ jpegQuality: JPEGOptionsQuality; /** * The rendering style. */ jpegRenderingStyle: JPEGOptionsFormat; /** * Suffix to be used at the end of each exported file. */ jpegSuffix: string; /** * The page(s) to export, specified as a page number or an array of page * numbers. Note: Valid when JPEG export range is not all. */ pageString: string; /** * The parent of the JPEGExportPreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, simulates the effects of overprinting spot and process colors in * the same way they would occur when printing. */ simulateOverprint: boolean; /** * If true, uses the document's bleed settings in the exported JPEG. */ useDocumentBleeds: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): JPEGExportPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the JPEGExportPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Formatting options for converted JPEG images. */ declare enum JPEGOptionsFormat { /** * Uses baseline encoding to download the image in one pass. */ BASELINE_ENCODING = 1785751394, /** * Uses progressive encoding to download the image in a series of passes, with * the first pass at low resolution and each successive pass adding resolution * to the image. */ PROGRESSIVE_ENCODING = 1785751408, } /** * Quality options for converted JPEG images. */ declare enum JPEGOptionsQuality { /** * High quality. */ HIGH = 1701726313, /** * Low quality. */ LOW = 1701727351, /** * Maximum quality. */ MAXIMUM = 1701727608, /** * Medium quality. */ MEDIUM = 1701727588, } /** * Options for joining two path points. */ declare enum JoinOptions { /** * Combine two end points and replace with an single averaged point. */ COMBINE = 1668113006, /** * Connect two end points (default). */ CONNECT = 1668178804, } /** * Color space options for representing color in the exported JPEG. */ declare enum JpegColorSpaceEnum { /** * Represents all color values using the CMYK color space. */ CMYK = 1129142603, /** * Converts all color values to high-quality black-and-white images. Gray * levels of the converted objects represent the luminosity of the original * objects. */ GRAY = 1766290041, /** * Represents all color values using the RGB color space. Best suited for * documents that will be viewed on-screen. */ RGB = 1666336578, } /** * Text alignment options. */ declare enum Justification { /** * Aligns text to the side opposite the binding spine of the page. */ AWAY_FROM_BINDING_SIDE = 1633772147, /** * Center aligns the text. */ CENTER_ALIGN = 1667591796, /** * Justifies text text and center aligns the last line in the paragraph. */ CENTER_JUSTIFIED = 1667920756, /** * Justifies the text, including the last line in the paragraph. */ FULLY_JUSTIFIED = 1718971500, /** * Left aligns the text. */ LEFT_ALIGN = 1818584692, /** * Justifies the text and left aligns the last line in the paragraph. */ LEFT_JUSTIFIED = 1818915700, /** * Right aligns the text. */ RIGHT_ALIGN = 1919379572, /** * Justifies the text and right aligns the last line in the paragraph. */ RIGHT_JUSTIFIED = 1919578996, /** * Aligns text to the binding spine of the page or spread. */ TO_BINDING_SIDE = 1630691955, } /** * Kashidas. */ declare enum KashidasOptions { /** * Default kashidas */ DEFAULT_KASHIDAS = 1801544805, /** * Kashidas off */ KASHIDAS_OFF = 1801547622, } /** * Options for aligning kenten characters relative to the parent characters. */ declare enum KentenAlignment { /** * Aligns kenten with the center of parent charactrers. */ ALIGN_KENTEN_CENTER = 1248554595, /** * Aligns kenten with the left of parent characters. */ ALIGN_KENTEN_LEFT = 1248554604, } /** * Style options for kenten characters. */ declare enum KentenCharacter { /** * Uses a custom kenten style. */ CUSTOM = 1131639917, /** * Uses the kenten black circle. */ KENTEN_BLACK_CIRCLE = 1248551523, /** * Uses the kenten black triangle. */ KENTEN_BLACK_TRIANGLE = 1248551540, /** * Uses the kenten bullseye. */ KENTEN_BULLSEYE = 1248551525, /** * Uses the kenten fisheye. */ KENTEN_FISHEYE = 1248552549, /** * Uses the kenten sesame dot. */ KENTEN_SESAME_DOT = 1248551795, /** * Uses the kenten small black circle. */ KENTEN_SMALL_BLACK_CIRCLE = 1248555875, /** * Uses the kenten small white circle. */ KENTEN_SMALL_WHITE_CIRCLE = 1248555895, /** * Uses the kenten white circle. */ KENTEN_WHITE_CIRCLE = 1248556899, /** * Uses the kenten white sesame dot. */ KENTEN_WHITE_SESAME_DOT = 1248551799, /** * Uses the kenten white triangle. */ KENTEN_WHITE_TRIANGLE = 1248556916, /** * Does not use kenten. */ NONE = 1852796517, } /** * Kenten character set options. */ declare enum KentenCharacterSet { /** * Character input. */ CHARACTER_INPUT = 1248028777, /** * JIS. */ JIS = 1246382419, /** * Kuten. */ KUTEN = 1248556404, /** * Shift JIS. */ SHIFT_JIS = 1249077875, /** * Unicode. */ UNICODE = 1249209961, } /** * Hanging punctuation options when a kinsoku set is in effect. */ declare enum KinsokuHangTypes { /** * Enables hanging punctuation but forces hanging punctuation outside the text * frame and does not allow the punctuation to be placed on the text frame. */ KINSOKU_HANG_FORCE = 1248553062, /** * Enables hanging punctuation and allows punctuation marks to be placed on or * outside the text frame but allows burasagari characters to hang as little as * possible. Note: Differs for justified and nonjustified text. For information * on justification, see line alignment. */ KINSOKU_HANG_REGULAR = 1248553074, /** * Disables hanging punctuation. */ NONE = 1852796517, } /** * Predefined kinsoku set options. */ declare enum KinsokuSet { /** * Uses the hard or maximum kinsoku set, which includes all Japanese characters * that should not begin or end a line. */ HARD_KINSOKU = 1248357235, /** * Uses the Korean kinsoku set. */ KOREAN_KINSOKU = 1263692659, /** * Does not use a kinsoku set. */ NOTHING = 1851876449, /** * Uses the simplified Chinese kinsoku set. */ SIMPLIFIED_CHINESE_KINSOKU = 1396927347, /** * Uses the soft or weak kinsoku set, which omits from the hard kinsoku set * long vowel symbols and small hiragana and katakana characters. */ SOFT_KINSOKU = 1249078131, /** * Uses the traditional Chinese kinsoku set. */ TRADITIONAL_CHINESE_KINSOKU = 1413704563, } /** * The kinsoku table. */ declare class KinsokuTable { /** * The characters in the kinsoku set that cannot be separated. */ cantBeSeparatedChars: string; /** * The characters in the kinsoku set that cannot begin lines. */ cantBeginLineChars: string; /** * That characters in the kinsoku set that cannot end lines. */ cantEndLineChars: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The hanging punctuation characters in the kinsoku set. */ hangingPunctuationChars: string; /** * The unique ID of the KinsokuTable. */ readonly id: number; /** * The index of the KinsokuTable within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the KinsokuTable. */ name: string; /** * The parent of the KinsokuTable (a Document or Application). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): KinsokuTable[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the KinsokuTable. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the KinsokuTable. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of kinsoku tables. */ declare class KinsokuTables { /** Returns the KinsokuTable with the specified index or name. */ [index: number]: KinsokuTable; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new kinsoku table. * @param name The name of the new kinsoku table. * @param withProperties Initial values for properties of the new KinsokuTable (Optional) */ add(name: string, withProperties?: Object): KinsokuTable; /** * Returns any KinsokuTable in the collection. */ anyItem(): KinsokuTable; /** * Displays the number of elements in the KinsokuTable. */ count(): number; /** * Returns every KinsokuTable in the collection. */ everyItem(): KinsokuTable; /** * Returns the first KinsokuTable in the collection. */ firstItem(): KinsokuTable; /** * Returns the KinsokuTable with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): KinsokuTable; /** * Returns the KinsokuTable with the specified ID. * @param id The ID. */ itemByID(id: number): KinsokuTable; /** * Returns the KinsokuTable with the specified name. * @param name The name. */ itemByName(name: string): KinsokuTable; /** * Returns the KinsokuTables within the specified range. * @param from The KinsokuTable, index, or name at the beginning of the range. Can accept: KinsokuTable, Long Integer or String. * @param to The KinsokuTable, index, or name at the end of the range. Can accept: KinsokuTable, Long Integer or String. */ itemByRange(from: KinsokuTable | number | string, to: KinsokuTable | number | string): KinsokuTable[]; /** * Returns the last KinsokuTable in the collection. */ lastItem(): KinsokuTable; /** * Returns the middle KinsokuTable in the collection. */ middleItem(): KinsokuTable; /** * Returns the KinsokuTable whose index follows the specified KinsokuTable in * the collection. * @param obj The KinsokuTable whose index comes before the desired KinsokuTable. */ nextItem(obj: KinsokuTable): KinsokuTable; /** * Returns the KinsokuTable with the index previous to the specified index. * @param obj The index of the KinsokuTable that follows the desired KinsokuTable. */ previousItem(obj: KinsokuTable): KinsokuTable; /** * Generates a string which, if executed, will return the KinsokuTable. */ toSource(): string; } /** * Kinsoku processing options. */ declare enum KinsokuType { /** * The kinsoku prioritize adjustment amount. */ KINSOKU_PRIORITIZE_ADJUSTMENT_AMOUNT = 1248553313, /** * Attempts to move characters to the previous line; if the push-in is not * possible, pushes characters to the next line. */ KINSOKU_PUSH_IN_FIRST = 1248553318, /** * Attempts to move characters to the next line; if the push-out is not * possible, pushes characters to the previous line. */ KINSOKU_PUSH_OUT_FIRST = 1248554854, /** * Always moves characters to the next line. Does not attempt a push-in. */ KINSOKU_PUSH_OUT_ONLY = 1248554863, } /** * The language on which to base hyphenation rules and spell checking. */ declare class Language { /** * The double quotes pair for the language. */ doubleQuotes: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The hyphenation rules source. */ hyphenationVendor: string; /** * The full name of the Language object's ICU locale. */ readonly icuLocaleName: string; /** * The unique ID of the Language. */ readonly id: number; /** * The index of the Language within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the Language. */ readonly name: string; /** * The parent of the Language (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The single quotes pair for the language. */ singleQuotes: string; /** * The spell-checking source. */ spellingVendor: string; /** * The untranslated name of the language. */ readonly untranslatedName: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Language[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Language. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Used to specify a language and region. */ declare enum LanguageAndRegion { /** * Albania: Albanian */ ALBANIA_ALBANIAN = 1936802124, /** * Belarus: Belarusian */ BELARUS_BELARUSIAN = 1650803289, /** * Brazil: Portuguese */ BRAZIL_PORTUGUESE = 1886667346, /** * Bulgaria: Bulgarian */ BULGARIA_BULGARIAN = 1650934343, /** * Croatia: Croatian */ CROATIA_CROATIAN = 1752320082, /** * Czech Republic: Czech */ CZECH_REPUBLIC_CZECH = 1668498266, /** * Denmark: Danish */ DENMARK_DANISH = 1684096075, /** * Estonia: Estonian */ ESTONIA_ESTONIAN = 1702118725, /** * Finland: Finnish */ FINLAND_FINNISH = 1718175305, /** * France: French */ FRANCE_FRENCH = 1718765138, /** * Germany: German */ GERMANY_GERMAN = 1684358213, /** * Greece: Greek */ GREECE_GREEK = 1701594962, /** * Hungary: Hungarian */ HUNGARY_HUNGARIAN = 1752516693, /** * India: Tamil */ INDIA_TAMIL = 1952532814, /** * Indic */ INDIC = 1768842345, /** * Israel: Hebrew */ ISRAEL_HEBREW = 1751468364, /** * Italy: Italian */ ITALY_ITALIAN = 1769228628, /** * Japan: Japanese */ JAPAN_JAPANESE = 1784760912, /** * Latvia: Latvian */ LATVIA_LATVIAN = 1819692118, /** * Lituania: Lithuanian */ LITUANIA_LITHUANIAN = 1819561044, /** * Netherlands: Dutch */ NETHERLANDS_DUTCH = 1852591692, /** * Norway: Norwegian */ NORWAY_NORWEGIAN = 1851936335, /** * Poland: Polish */ POLAND_POLISH = 1886146636, /** * Republic Of Korea: Korean */ REPUBLIC_OF_KOREA_KOREAN = 1802455890, /** * Romania: Romanian */ ROMANIA_ROMANIAN = 1919898191, /** * Russian Federation: Russian */ RUSSIAN_FEDERATION_RUSSIAN = 1920291413, /** * Simplified Chinese */ SIMPLIFIED_CHINESE = 2053653326, /** * Slovakia: Slovak */ SLOVAKIA_SLOVAK = 1936479051, /** * Slovenia: Slovenian */ SLOVENIA_SLOVENIAN = 1936479049, /** * Spain: Spanish */ SPAIN_SPANISH = 1702053203, /** * Standard Arabic */ STANDARD_ARABIC = 1634877765, /** * Sweden: Swedish */ SWEDEN_SWEDISH = 1937134422, /** * Thailand: Thai */ THAILAND_THAI = 1952994376, /** * Traditional Chinese */ TRADITIONAL_CHINESE = 2053657687, /** * Turkey: Turkish */ TURKEY_TURKISH = 1953649746, /** * Ukraine: Ukrainian */ UKRAINE_UKRAINIAN = 1969968449, /** * United Kingdom: English */ UNITED_KINGDOM_ENGLISH = 1701726018, /** * United States: English */ UNITED_STATES_ENGLISH = 1701729619, /** * Vietnam: Vietnamese */ VIETNAM_VIETNAMESE = 1986614862, } /** * A language that allows the specification of a hyphenation rules source, a * spell-checking source, and a thesaurus. */ declare class LanguageWithVendors { /** * The user dictionaries for the language. */ dictionaryPaths: string[]; /** * The double quotes pair for the language. */ doubleQuotes: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The hyphenation rules source. */ hyphenationVendor: string; /** * A list of hyphenation vendors. */ readonly hyphenationVendorList: string[]; /** * The full name of the Language object's ICU locale. */ readonly icuLocaleName: string; /** * The unique ID of the LanguageWithVendors. */ readonly id: number; /** * The index of the LanguageWithVendors within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the LanguageWithVendors. */ readonly name: string; /** * The parent of the LanguageWithVendors (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The single quotes pair for the language. */ singleQuotes: string; /** * The spell-checking source. */ spellingVendor: string; /** * A list of spelling vendors. */ readonly spellingVendorList: string[]; /** * The thesaurus source. */ thesaurusVendor: string; /** * The untranslated name of the language. */ readonly untranslatedName: string; /** * Adds the specified user dictionary. * @param filePath The path to the dictionary file. */ addDictionaryPath(filePath: string): string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): LanguageWithVendors[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Removes the specified user dictionary. * @param filePath The path to the dictionary file. */ removeDictionaryPath(filePath: string): string; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the LanguageWithVendors. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of languages. */ declare class Languages { /** Returns the Language with the specified index or name. */ [index: number]: Language; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Language in the collection. */ anyItem(): Language; /** * Displays the number of elements in the Language. */ count(): number; /** * Returns every Language in the collection. */ everyItem(): Language; /** * Returns the first Language in the collection. */ firstItem(): Language; /** * Returns the Language with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Language; /** * Returns the Language with the specified ID. * @param id The ID. */ itemByID(id: number): Language; /** * Returns the Language with the specified name. * @param name The name. */ itemByName(name: string): Language; /** * Returns the Languages within the specified range. * @param from The Language, index, or name at the beginning of the range. Can accept: Language, Long Integer or String. * @param to The Language, index, or name at the end of the range. Can accept: Language, Long Integer or String. */ itemByRange(from: Language | number | string, to: Language | number | string): Language[]; /** * Returns the last Language in the collection. */ lastItem(): Language; /** * Returns the middle Language in the collection. */ middleItem(): Language; /** * Returns the Language whose index follows the specified Language in the * collection. * @param obj The Language whose index comes before the desired Language. */ nextItem(obj: Language): Language; /** * Returns the Language with the index previous to the specified index. * @param obj The index of the Language that follows the desired Language. */ previousItem(obj: Language): Language; /** * Generates a string which, if executed, will return the Language. */ toSource(): string; } /** * A collection of languages with vendors. */ declare class LanguagesWithVendors { /** Returns the LanguageWithVendors with the specified index or name. */ [index: number]: LanguageWithVendors; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any LanguageWithVendors in the collection. */ anyItem(): LanguageWithVendors; /** * Displays the number of elements in the LanguageWithVendors. */ count(): number; /** * Returns every LanguageWithVendors in the collection. */ everyItem(): LanguageWithVendors; /** * Returns the first LanguageWithVendors in the collection. */ firstItem(): LanguageWithVendors; /** * Returns the LanguageWithVendors with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): LanguageWithVendors; /** * Returns the LanguageWithVendors with the specified ID. * @param id The ID. */ itemByID(id: number): LanguageWithVendors; /** * Returns the LanguageWithVendors with the specified name. * @param name The name. */ itemByName(name: string): LanguageWithVendors; /** * Returns the LanguagesWithVendors within the specified range. * @param from The LanguageWithVendors, index, or name at the beginning of the range. Can accept: LanguageWithVendors, Long Integer or String. * @param to The LanguageWithVendors, index, or name at the end of the range. Can accept: LanguageWithVendors, Long Integer or String. */ itemByRange(from: LanguageWithVendors | number | string, to: LanguageWithVendors | number | string): LanguageWithVendors[]; /** * Returns the last LanguageWithVendors in the collection. */ lastItem(): LanguageWithVendors; /** * Returns the middle LanguageWithVendors in the collection. */ middleItem(): LanguageWithVendors; /** * Returns the LanguageWithVendors whose index follows the specified * LanguageWithVendors in the collection. * @param obj The LanguageWithVendors whose index comes before the desired LanguageWithVendors. */ nextItem(obj: LanguageWithVendors): LanguageWithVendors; /** * Returns the LanguageWithVendors with the index previous to the specified * index. * @param obj The index of the LanguageWithVendors that follows the desired LanguageWithVendors. */ previousItem(obj: LanguageWithVendors): LanguageWithVendors; /** * Generates a string which, if executed, will return the LanguageWithVendors. */ toSource(): string; } /** * A layer. */ declare class Layer { /** * Lists all graphics contained by the Layer. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the Layer. */ readonly allPageItems: PageItem[]; /** * A collection of buttons. */ readonly buttons: Buttons; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * A collection of form fields. */ readonly formFields: FormFields; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of groups. */ readonly groups: Groups; /** * A collection of guides. */ readonly guides: Guides; /** * The unique ID of the Layer. */ readonly id: number; /** * If true, text wrap settings applied to objects on the layer will not affect * text on other layers when the layer is hidden. */ ignoreWrap: boolean; /** * The index of the Layer within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The color of the layer, specified either as an array of three doubles, each * in the range 0 to 255 and representing R, G, and B values, or as a UI color. * Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. */ layerColor: (number[][] | UIColors)[]; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * If true, the guide positions on the layer are locked. */ lockGuides: boolean; /** * If true, the Layer is locked. */ locked: boolean; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * The name of the Layer. */ name: string; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the Layer (a Document). */ readonly parent: Document; /** * A collection of polygons. */ readonly polygons: Polygons; /** * If true, the layer will print. */ printable: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * If true, guides are visible on the layer. */ showGuides: boolean; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * If true, the Layer is visible. */ visible: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the Layer. */ duplicate(): Layer; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Layer[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Merges the layer with other layer(s). * @param with_ The layer(s) with which to merge. */ merge(with_: Layer[]): Layer; /** * Moves the Layer to the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to value specifies before or after. (Optional) */ move(to: LocationOptions, reference?: Layer): Layer; /** * Deletes the Layer. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Layer. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of layers. */ declare class Layers { /** Returns the Layer with the specified index or name. */ [index: number]: Layer; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new Layer. * @param withProperties Initial values for properties of the new Layer (Optional) */ add(withProperties?: Object): Layer; /** * Returns any Layer in the collection. */ anyItem(): Layer; /** * Displays the number of elements in the Layer. */ count(): number; /** * Returns every Layer in the collection. */ everyItem(): Layer; /** * Returns the first Layer in the collection. */ firstItem(): Layer; /** * Returns the Layer with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Layer; /** * Returns the Layer with the specified ID. * @param id The ID. */ itemByID(id: number): Layer; /** * Returns the Layer with the specified name. * @param name The name. */ itemByName(name: string): Layer; /** * Returns the Layers within the specified range. * @param from The Layer, index, or name at the beginning of the range. Can accept: Layer, Long Integer or String. * @param to The Layer, index, or name at the end of the range. Can accept: Layer, Long Integer or String. */ itemByRange(from: Layer | number | string, to: Layer | number | string): Layer[]; /** * Returns the last Layer in the collection. */ lastItem(): Layer; /** * Returns the middle Layer in the collection. */ middleItem(): Layer; /** * Returns the Layer whose index follows the specified Layer in the collection. * @param obj The Layer whose index comes before the desired Layer. */ nextItem(obj: Layer): Layer; /** * Returns the Layer with the index previous to the specified index. * @param obj The index of the Layer that follows the desired Layer. */ previousItem(obj: Layer): Layer; /** * Generates a string which, if executed, will return the Layer. */ toSource(): string; } /** * Default properties specific to layout grids. */ declare class LayoutGridDataInformation extends Preference { /** * The font applied to the LayoutGridDataInformation, specified as either a * font object or the name of font family. Can return: Font or String. */ appliedFont: Font | string; /** * The amount of white space between characters. */ characterAki: number; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The name of the font style. */ fontStyle: string; /** * The horizontal scaling applied to the LayoutGridDataInformation. */ horizontalScale: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The amount of white space between lines. */ lineAki: number; /** * The parent of the LayoutGridDataInformation (a Application or Document). */ readonly parent: Application | Document; /** * The text size. * @remarks Measurement unit — also accepts a string such as "12mm". */ pointSize: number | string; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The vertical scaling applied to the LayoutGridDataInformation. */ verticalScale: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): LayoutGridDataInformation[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * LayoutGridDataInformation. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for setting the layout rule on a page. */ declare enum LayoutRuleOptions { /** * Use guide slicing to resize objects on the page as it resizes. */ GUIDE_BASED = 1280329538, /** * Reposition and resize objects on the page as it resizes. */ OBJECT_BASED = 1280331586, /** * No layout rule on the page as it resizes. */ OFF = 1330005536, /** * Use existing layout rule setting on the page. Used for creating alternate * layouts. */ PRESERVE_EXISTING = 1280331890, /** * Recenter objects on the page as it resizes. */ RECENTER = 1280332387, /** * Scale objects on the page as it resizes. */ SCALE = 1280332643, /** * Use layout rule from the page's applied master page. */ USE_MASTER = 1280333133, } /** * A layout window. */ declare class LayoutWindow extends Window { /** * The active layer. Can also accept: String. */ activeLayer: Layer | string; /** * The front-most page. */ activePage: Page; /** * The front-most spread. Can return: Spread or MasterSpread. */ activeSpread: Spread | MasterSpread; /** * The bounds of the window (specified in pixels) in the form [top, left, * bottom, right]. */ bounds: number[]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the LayoutWindow within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the LayoutWindow. */ readonly name: string; /** * If true, display a simulation of overprinting. */ overprintPreview: boolean; /** * The parent of the LayoutWindow (a Document). */ readonly parent: Document; /** * If true, leaves color values unchanged for CMYK objects without embedded * profiles and native objects such as line art or type. Note: Converts images * whose profiles differ from the profile of the simulated device. Valid only * when proofing type is custom. */ preserveColorNumbers: boolean; /** * The profile used for proofing colors. */ proofingProfile: string; /** * The method of proofing colors. */ proofingType: ProofingType; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The screen mode for layout view. */ screenMode: ScreenModeOptions; /** * The selected object(s). Can also accept: Object or NothingEnum enumerator. */ selection: (Object | NothingEnum)[]; /** * The key object of the selection. Can also accept: NothingEnum enumerator. */ selectionKeyObject: PageItem | NothingEnum; /** * If true, simulates the dark gray produced by many printers in place of solid * black, according to the proofing profile. Note: Valid only when proofing * type is custom. */ simulateInkBlack: boolean; /** * If true, simulates the dingy white of real paper, according to the proofing * profile. Note: Valid only when proofing type is custom. */ simulatePaperWhite: boolean; /** * The default anchor point around which to transform objects. Can return: * AnchorPoint enumerator or Array of 2 Units. */ transformReferencePoint: (AnchorPoint | number[][])[]; /** * The display performance preferences override for the view. */ viewDisplaySetting: ViewDisplaySettings; /** * The size (as a percentage) to which to enlarge or reduce the view of the * document. (Range: 5 to 4000) * @remarks Range: 5 to 4000 */ zoomPercentage: number; /** * Dispatched after the LayoutWindow becomes active. This event bubbles. This * event is not cancelable. */ static readonly AFTER_ACTIVATE: string; /** * Dispatched when the value of a property changes on this LayoutWindow. This * event bubbles. This event is not cancelable. */ static readonly AFTER_ATTRIBUTE_CHANGED: string; /** * Dispatched when a LayoutWindow is closing. Since the close has been * committed, it can no longer be canceled. This event bubbles. This event is * not cancelable. */ static readonly AFTER_CLOSE: string; /** * Dispatched after a LayoutWindow is opened. This event bubbles. This event is * not cancelable. */ static readonly AFTER_OPEN: string; /** * Dispatched after an attribute on the active selection changes. This event * bubbles. This event is not cancelable. */ static readonly AFTER_SELECTION_ATTRIBUTE_CHANGED: string; /** * Dispatched after the active selection changes. This event bubbles. This * event is not cancelable. */ static readonly AFTER_SELECTION_CHANGED: string; /** * Dispatched before a LayoutWindow is closed. This event bubbles. This event * is cancelable. */ static readonly BEFORE_CLOSE: string; /** * Dispatched before the LayoutWindow becomes inactive. This event bubbles. * This event is not cancelable. */ static readonly BEFORE_DEACTIVATE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Brings the object to the front. */ bringToFront(): void; /** * Closes the LayoutWindow. */ close(): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): LayoutWindow[]; /** * Maximizes the window. */ maximize(): void; /** * Minimizes the window. */ minimize(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Restores the window. */ restore(): void; /** * Selects the specified object(s). * @param selectableItems The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator. * @param existingSelection The selection status of the LayoutWindow in relation to previously selected objects. (Optional) */ select(selectableItems: (any[] | NothingEnum | Object | SelectAll)[], existingSelection?: SelectionOptions): void; /** * Generates a string which, if executed, will return the LayoutWindow. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Magnifies or reduces the window to the specified display size. * @param given The display size. */ zoom(given: ZoomOptions): void; } /** * A collection of layout windows. */ declare class LayoutWindows { /** Returns the LayoutWindow with the specified index or name. */ [index: number]: LayoutWindow; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any LayoutWindow in the collection. */ anyItem(): LayoutWindow; /** * Displays the number of elements in the LayoutWindow. */ count(): number; /** * Returns every LayoutWindow in the collection. */ everyItem(): LayoutWindow; /** * Returns the first LayoutWindow in the collection. */ firstItem(): LayoutWindow; /** * Returns the LayoutWindow with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): LayoutWindow; /** * Returns the LayoutWindow with the specified name. * @param name The name. */ itemByName(name: string): LayoutWindow; /** * Returns the LayoutWindows within the specified range. * @param from The LayoutWindow, index, or name at the beginning of the range. Can accept: LayoutWindow, Long Integer or String. * @param to The LayoutWindow, index, or name at the end of the range. Can accept: LayoutWindow, Long Integer or String. */ itemByRange(from: LayoutWindow | number | string, to: LayoutWindow | number | string): LayoutWindow[]; /** * Returns the last LayoutWindow in the collection. */ lastItem(): LayoutWindow; /** * Returns the middle LayoutWindow in the collection. */ middleItem(): LayoutWindow; /** * Returns the LayoutWindow whose index follows the specified LayoutWindow in * the collection. * @param obj The LayoutWindow whose index comes before the desired LayoutWindow. */ nextItem(obj: LayoutWindow): LayoutWindow; /** * Returns the LayoutWindow with the index previous to the specified index. * @param obj The index of the LayoutWindow that follows the desired LayoutWindow. */ previousItem(obj: LayoutWindow): LayoutWindow; /** * Generates a string which, if executed, will return the LayoutWindow. */ toSource(): string; } /** * Leading type options. */ declare enum Leading { /** * Apply auto leading. */ AUTO = 1635019116, } /** * Leading model options. */ declare enum LeadingModel { /** * Measures the space between lines from the aki above. */ LEADING_MODEL_AKI_ABOVE = 1248616801, /** * Measures the space between lines from the aki below. */ LEADING_MODEL_AKI_BELOW = 1248616802, /** * Measures the space between the character center points. */ LEADING_MODEL_CENTER = 1248619875, /** * Center down leading model. */ LEADING_MODEL_CENTER_DOWN = 1248617316, /** * Measures the space between type baselines. */ LEADING_MODEL_ROMAN = 1248619858, } /** * A collection of object libraries. */ declare class Libraries { /** Returns the Library with the specified index or name. */ [index: number]: Library; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new object libary. * @param fullName The library's path and file name. * @param withProperties Initial values for properties of the new Library (Optional) */ add(fullName: File, withProperties?: Object): Library; /** * Returns any Library in the collection. */ anyItem(): Library; /** * Displays the number of elements in the Library. */ count(): number; /** * Returns every Library in the collection. */ everyItem(): Library; /** * Returns the first Library in the collection. */ firstItem(): Library; /** * Returns the Library with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Library; /** * Returns the Library with the specified name. * @param name The name. */ itemByName(name: string): Library; /** * Returns the Libraries within the specified range. * @param from The Library, index, or name at the beginning of the range. Can accept: Library, Long Integer or String. * @param to The Library, index, or name at the end of the range. Can accept: Library, Long Integer or String. */ itemByRange(from: Library | number | string, to: Library | number | string): Library[]; /** * Returns the last Library in the collection. */ lastItem(): Library; /** * Returns the middle Library in the collection. */ middleItem(): Library; /** * Returns the Library whose index follows the specified Library in the * collection. * @param obj The Library whose index comes before the desired Library. */ nextItem(obj: Library): Library; /** * Returns the Library with the index previous to the specified index. * @param obj The index of the Library that follows the desired Library. */ previousItem(obj: Library): Library; /** * Generates a string which, if executed, will return the Library. */ toSource(): string; } /** * An object library. */ declare class Library { /** * A collection of object library assets. */ readonly assets: Assets; /** * The associated panel. */ readonly associatedPanel: Panel; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The full path to the file. */ readonly filePath: File; /** * The full path to the Library, including the name of the Library. */ readonly fullName: File; /** * The index of the Library within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the Library. */ readonly name: string; /** * The parent of the Library (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Closes the Library. */ close(): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Library[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Stores the specified object in the library. * @param using The page item(s) to store. Can accept: Array of PageItems, Movies, Sounds, Graphics or XMLElements. * @param withProperties Initial values for properties of the new Library (Optional) */ store(using: (PageItems | Graphics | Movies | Sounds | XMLElements)[], withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the Library. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Library panel */ declare class LibraryPanel extends Panel { /** * The library displayed in this LibraryPanel */ readonly associatedLibrary: Library; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the LibraryPanel within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the LibraryPanel. */ readonly name: string; /** * The parent of the LibraryPanel (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The selected object(s). Can also accept: Object or NothingEnum enumerator. */ selection: (Object | NothingEnum)[]; /** * The sort order of the assets in the LibraryPanel */ sortOrder: SortAssets; /** * LibraryPanel view */ view: LibraryPanelViews; /** * If true, the panel is visible. */ visible: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): LibraryPanel[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Selects the specified object(s). * @param selectableItems The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator. * @param existingSelection The selection status of the LibraryPanel in relation to previously selected objects. (Optional) */ select(selectableItems: (any[] | NothingEnum | Object | SelectAll)[], existingSelection?: SelectionOptions): void; /** * Show all assets */ showAll(): void; /** * Generates a string which, if executed, will return the LibraryPanel. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Library panel views */ declare enum LibraryPanelViews { /** * Large thumbnail view */ LARGE_THUMBNAIL_VIEW = 1699501142, /** * List view */ LIST_VIEW = 1699501673, /** * Thumbnail view */ THUMBNAIL_VIEW = 1700030550, } /** * A line of text. */ declare class Line extends Text { /** * If true, aligns the baseline of the text to the baseline grid. */ alignToBaseline: boolean; /** * Lists all graphics contained by the Line. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the Line. */ readonly allPageItems: PageItem[]; /** * If true, words unassociated with a hyphenation dictionary can break to the * next line on any character. */ allowArbitraryHyphenation: boolean; /** * The character style applied to the text. Can also accept: String. */ appliedCharacterStyle: CharacterStyle | string; /** * The applied conditions. */ appliedConditions: Condition[]; /** * The font applied to the Line, specified as either a font object or the name * of font family. Can return: Font or String. */ appliedFont: Font | string; /** * The language of the text. Can return: LanguageWithVendors or Language. Can * also accept: String. */ appliedLanguage: LanguageWithVendors | string | Language; /** * The applied character styles dictated by nested styles. */ readonly appliedNestedStyles: CharacterStyle[]; /** * The list to be part of. Can return: NumberingList or String. */ appliedNumberingList: NumberingList | string; /** * The paragraph style applied to the text. Can also accept: String. */ appliedParagraphStyle: ParagraphStyle | string; /** * The maximum ascent of any character in the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly ascent: number | string; /** * The XML elements associated with the Line. */ readonly associatedXMLElements: XMLItem[]; /** * The percent of the type size to use for auto leading. (Range: 0 to 500). * @remarks Range: 0 to 500 */ autoLeading: number; /** * The number of half-width characters at or below which the characters * automatically run horizontally in vertical text. */ autoTcy: number; /** * If true, auto tcy includes Roman characters. */ autoTcyIncludeRoman: boolean; /** * If true or set to an enumeration value, balances ragged lines. Note: Not * valid with a single-line text composer. Can return: Boolean or * BalanceLinesStyle enumerator. */ balanceRaggedLines: boolean | BalanceLinesStyle; /** * The vertical offset of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly baseline: number | string; /** * The baseline shift applied to the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ baselineShift: number | string; /** * Bullet character. */ readonly bulletChar: Bullet; /** * The alignment of the bullet character. */ bulletsAlignment: ListAlignment; /** * List type for bullets and numbering. */ bulletsAndNumberingListType: ListType; /** * The character style to be used for the text after string. Can return: * CharacterStyle or String. */ bulletsCharacterStyle: CharacterStyle | string; /** * The text after string expression for bullets. */ bulletsTextAfter: string; /** * If true, adds the double period (..), ellipse (...), and double hyphen (--) * to the selected kinsoku set. Note: Valid only when a kinsoku set is in * effect. */ bunriKinshi: boolean; /** * A collection of buttons. */ readonly buttons: Buttons; /** * The capitalization scheme. */ capitalization: Capitalization; /** * The alignment of small characters to the largest character in the line. */ characterAlignment: CharacterAlignment; /** * The direction of the character. */ characterDirection: CharacterDirectionOptions; /** * The rotation angle (in degrees) of individual characters. Note: The rotation * is counterclockwise. */ characterRotation: number; /** * A collection of characters. */ readonly characters: Characters; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * If true, uses grid tracking to track non-Roman characters in CJK grids. */ cjkGridTracking: boolean; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * The text composer to use to compose the text. */ composer: string; /** * The contents of the text. Can return: String or SpecialCharacters * enumerator. */ contents: string | SpecialCharacters; /** * The maximum descent of any character in the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly descent: number | string; /** * Value of Design Axes */ designAxes: number[]; /** * The desired width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ desiredGlyphScaling: number; /** * The desired letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) */ desiredLetterSpacing: number; /** * The desired word spacing, specified as a percentage of the font word space * value. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ desiredWordSpacing: number; /** * Position of diacriticical characters. */ diacriticPosition: DiacriticPositionOptions; /** * The digits type. */ digitsType: DigitsTypeOptions; /** * The number of characters to drop cap. * @remarks Range: 0 to 150 */ dropCapCharacters: number; /** * The number of lines to drop cap. * @remarks Range: 0 to 25 */ dropCapLines: number; /** * The character style to apply to the drop cap. Can also accept: String. */ dropCapStyle: CharacterStyle | string; /** * Details about the drop cap based on the glyph outlines. 1 = left side * bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid. */ dropcapDetail: number; /** * Vertical offset of the end of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly endBaseline: number | string; /** * Horizontal offset of the end of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly endHorizontalOffset: number | string; /** * The stroke join type applied to the characters of the text. */ endJoin: OutlineJoin; /** * A collection of endnote text ranges. */ readonly endnoteRanges: EndnoteRanges; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * Line. . Can also accept: String. */ fillColor: Swatch | string; /** * The tint (as a percentage) of the fill color of the Line. (To specify a tint * percentage, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * The amount to indent the first line. * @remarks Measurement unit — also accepts a string such as "12mm". */ firstLineIndent: number | string; /** * The name of the font style. */ fontStyle: string; /** * A collection of footnotes. */ readonly footnotes: Footnotes; /** * A collection of form fields. */ readonly formFields: FormFields; /** * The glyph variant to substitute for standard glyphs. */ glyphForm: AlternateGlyphForms; /** * The angle of a linear gradient applied to the fill of the text. (Range: -180 * to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the text. */ gradientFillLength: number; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the text. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the text. */ gradientStrokeLength: number; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * If true, aligns only the first line to the frame grid or baseline grid. If * false, aligns all lines to the grid. */ gridAlignFirstLineOnly: boolean; /** * The alignment to the frame grid or baseline grid. */ gridAlignment: GridAlignment; /** * The manual gyoudori setting. */ gridGyoudori: number; /** * A collection of groups. */ readonly groups: Groups; /** * A collection of hidden text objects. */ readonly hiddenTexts: HiddenTexts; /** * The horizontal offset of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly horizontalOffset: number | string; /** * The horizontal scaling applied to the Line. */ horizontalScale: number; /** * The relative desirability of better spacing vs. fewer hyphens. A lower value * results in greater use of hyphens. (Range: 0 to 100) * @remarks Range: 0 to 10 */ hyphenWeight: number; /** * If true, allows the last word in a text column to be hyphenated. */ hyphenateAcrossColumns: boolean; /** * The mininum number of letters at the beginning of a word that can be broken * by a hyphen. * @remarks Range: 1 to 15 */ hyphenateAfterFirst: number; /** * The minimum number of letters at the end of a word that can be broken by a * hyphen. * @remarks Range: 1 to 15 */ hyphenateBeforeLast: number; /** * If true, allows hyphenation of capitalized words. */ hyphenateCapitalizedWords: boolean; /** * The maximum number of hyphens that can appear on consecutive lines. To * specify unlimited consecutive lines, use zero. * @remarks Range: 0 to 25 */ hyphenateLadderLimit: number; /** * If true, allows hyphenation in the last word in a paragraph. Note: Valid * only when hyphenation is true. */ hyphenateLastWord: boolean; /** * The minimum number of letters a word must have in order to qualify for * hyphenation. * @remarks Range: 3 to 25 */ hyphenateWordsLongerThan: number; /** * If true, allows hyphenation. */ hyphenation: boolean; /** * The amount of white space allowed at the end of a line of non-justified text * before hypenation begins. Note: Valid when composer is single-line composer. * @remarks Measurement unit — also accepts a string such as "12mm". */ hyphenationZone: number | string; /** * If true, ignores optical edge alignment for the paragraph. */ ignoreEdgeAlignment: boolean; /** * The index of the text in the collection or parent object. */ readonly index: number; /** * A collection of insertion points. */ readonly insertionPoints: InsertionPoints; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The number of grid squares in which to arrange the text. */ jidori: number; /** * The paragraph alignment. */ justification: Justification; /** * Use of Kashidas for justification */ kashidas: KashidasOptions; /** * If true, keeps all lines of the paragraph together. If false, allows * paragraphs to break across pages or columns. */ keepAllLinesTogether: boolean; /** * The minimum number of lines to keep together in a paragraph before allowing * a page break. * @remarks Range: 1 to 50 */ keepFirstLines: number; /** * The minimum number of lines to keep together in a paragraph after a page * break. * @remarks Range: 1 to 50 */ keepLastLines: number; /** * If true, keeps a specified number of lines together when the paragraph * breaks across columns or text frames. */ keepLinesTogether: boolean; /** * If true, forces the rule above the paragraph to remain in the frame bounds. * Note: Valid only when rule above is true. */ keepRuleAboveInFrame: boolean; /** * The minimum number of lines to keep with the next paragraph. * @remarks Range: 0 to 5 */ keepWithNext: number; /** * If the first line in the paragraph should be kept with the last line of * previous paragraph. */ keepWithPrevious: boolean; /** * The alignment of kenten characters relative to the parent characters. */ kentenAlignment: KentenAlignment; /** * The character set used for the custom kenten character. Note: Valid only * when kenten kind is custom. */ kentenCharacterSet: KentenCharacterSet; /** * The character used for kenten. Note: Valid only when kenten kind is custom. */ kentenCustomCharacter: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of * kenten characters. Can return: Swatch or String. */ kentenFillColor: Swatch | string; /** * The font to use for kenten characters. Can return: Font or String. */ kentenFont: Font | string; /** * The size (in points) of kenten characters. */ kentenFontSize: number; /** * The font style of kenten characters. Can return: String or NothingEnum * enumerator. */ kentenFontStyle: string | NothingEnum; /** * The style of kenten characters. */ kentenKind: KentenCharacter; /** * The method of overprinting the kenten fill. */ kentenOverprintFill: AdornmentOverprint; /** * The method of overprinting the kenten stroke. */ kentenOverprintStroke: AdornmentOverprint; /** * The distance between kenten characters and their parent characters. */ kentenPlacement: number; /** * The kenten position relative to the parent character. */ kentenPosition: RubyKentenPosition; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * kenten characters. Can return: Swatch or String. */ kentenStrokeColor: Swatch | string; /** * The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenStrokeTint: number; /** * The fill tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenTint: number; /** * The stroke weight (in points) of kenten characters. */ kentenWeight: number; /** * The horizontal size of kenten characters as a percent of the original size. */ kentenXScale: number; /** * The vertical size of kenten charachers as a percent of the original size. */ kentenYScale: number; /** * The type of pair kerning. */ kerningMethod: string; /** * The amount of space to add or remove between characters, specified in * thousands of an em. */ kerningValue: number; /** * The keyboard direction of the character. */ keyboardDirection: CharacterDirectionOptions; /** * The type of hanging punctuation to allow. Note: Valid only when a kinsoku * set is in effect. */ kinsokuHangType: KinsokuHangTypes; /** * The kinsoku set that determines legitimate line breaks. Can return: * KinsokuTable, KinsokuSet enumerator or String. */ kinsokuSet: KinsokuSet | KinsokuTable | string; /** * The type of kinsoku processing for preventing kinsoku characters from * beginning or ending a line. Note: Valid only when a kinsoku set is defined. */ kinsokuType: KinsokuType; /** * The amount to indent the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ lastLineIndent: number | string; /** * The leading applied to the text. Can return: Unit or Leading enumerator. */ leading: number | Leading; /** * The amount of space before each character. */ leadingAki: number; /** * The point from which leading is measured from line to line. */ leadingModel: LeadingModel; /** * The width of the left indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ leftIndent: number | string; /** * The number of objects in the collection. */ readonly length: number; /** * If true, replaces specific character combinations (e.g., fl, fi) with * ligature characters. */ ligatures: boolean; /** * A collection of lines. */ readonly lines: Lines; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * The maximum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ maximumGlyphScaling: number; /** * The maximum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ maximumLetterSpacing: number; /** * The maximum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ maximumWordSpacing: number; /** * If true, consecutive para borders with completely similar properties are * merged. */ mergeConsecutiveParaBorders: boolean; /** * The minimum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ minimumGlyphScaling: number; /** * The minimum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ minimumLetterSpacing: number; /** * The minimum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ minimumWordSpacing: number; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 0 to 1000 */ miterLimit: number; /** * The mojikumi table. For information, see mojikumi table defaults. Can * return: MojikumiTable, String or MojikumiTableDefaults enumerator. */ mojikumi: MojikumiTable | string | MojikumiTableDefaults; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * A collection of nested GREP styles. */ readonly nestedGrepStyles: NestedGrepStyles; /** * A collection of nested line styles. */ readonly nestedLineStyles: NestedLineStyles; /** * A collection of nested styles. */ readonly nestedStyles: NestedStyles; /** * If true, keeps the text on the same line. */ noBreak: boolean; /** * A collection of notes. */ readonly notes: Notes; /** * The alignment of the number. */ numberingAlignment: ListAlignment; /** * If true, apply the numbering restart policy. */ numberingApplyRestartPolicy: boolean; /** * The character style to be used for the number string. Can return: * CharacterStyle or String. */ numberingCharacterStyle: CharacterStyle | string; /** * Continue the numbering at this level. */ numberingContinue: boolean; /** * The number string expression for numbering. */ numberingExpression: string; /** * Numbering format options. Can return: NumberingStyle enumerator or String. */ numberingFormat: NumberingStyle | string; /** * The level of the paragraph. */ numberingLevel: number; /** * Numbering restart policies. */ readonly numberingRestartPolicies: NumberingRestartPolicy; /** * Determines starting number in a numbered list. */ numberingStartAt: number; /** * OpenType features. Can return: Array of Array of 2 Strings or Long Integers. */ opentypeFeatures: (string[][] | number[])[]; /** * If true, uses contextual alternate forms in OpenType fonts. */ otfContextualAlternate: boolean; /** * If true, uses discretionary ligatures in OpenType fonts. */ otfDiscretionaryLigature: boolean; /** * The figure style in OpenType fonts. */ otfFigureStyle: OTFFigureStyle; /** * If true, uses fractions in OpenType fonts. */ otfFraction: boolean; /** * If true, switches hiragana fonts, which have different glyphs for horizontal * and vertical. */ otfHVKana: boolean; /** * If true, use historical forms in OpenType fonts. */ otfHistorical: boolean; /** * If true, use alternate justification forms in OpenType fonts */ otfJustificationAlternate: boolean; /** * If true, uses localized forms in OpenType fonts. */ otfLocale: boolean; /** * If true, uses mark positioning in OpenType fonts. */ otfMark: boolean; /** * If true, uses ordinals in OpenType fonts. */ otfOrdinal: boolean; /** * If true, use overlapping swash forms in OpenType fonts */ otfOverlapSwash: boolean; /** * If true, kerns according to proportional CJK metrics in OpenType fonts. */ otfProportionalMetrics: boolean; /** * If true, applies italics to half-width alphanumerics. */ otfRomanItalics: boolean; /** * If true, use a slashed zeroes in OpenType fonts. */ otfSlashedZero: boolean; /** * If true, use stretched alternate forms in OpenType fonts */ otfStretchedAlternate: boolean; /** * If true, use stylistic alternate forms in OpenType fonts */ otfStylisticAlternate: boolean; /** * The stylistic sets to use in OpenType fonts. */ otfStylisticSets: number; /** * If true, uses swash forms in OpenType fonts. */ otfSwash: boolean; /** * If true, uses titling forms in OpenType fonts. */ otfTitling: boolean; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the fill color of the characters will overprint. */ overprintFill: boolean; /** * If true, the stroke of the characters will overprint. */ overprintStroke: boolean; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphBorderBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLeftCornerRadius: number | string; /** * The bottom line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLineWeight: number | string; /** * The distance to offset the bottom edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph border. */ paragraphBorderBottomOrigin: ParagraphBorderBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphBorderBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomRightCornerRadius: number | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * stroke. Can return: Swatch or String. */ paragraphBorderColor: Swatch | string; /** * If true, then paragraph border is also displayed at the points where the * paragraph splits across frames or columns. */ paragraphBorderDisplayIfSplits: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * border gap. Note: Valid only when the border type is not solid. Can return: * Swatch or String. */ paragraphBorderGapColor: Swatch | string; /** * If true, the paragraph border gap will overprint. Note: Valid only when * border type is not solid. */ paragraphBorderGapOverprint: boolean; /** * The tint (as a percentage) of the paragraph border gap. Note: Valid only * when the border type is not solid. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderGapTint: number; /** * The left line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftLineWeight: number | string; /** * The distance to offset the left edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftOffset: number | string; /** * If true, the paragraph border is on. */ paragraphBorderOn: boolean; /** * If true, the paragraph border will overprint. */ paragraphBorderOverprint: boolean; /** * The right line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightLineWeight: number | string; /** * The distance to offset the right edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightOffset: number | string; /** * The end shape of an open path. */ paragraphBorderStrokeEndCap: EndCap; /** * The corner join applied to the Line. */ paragraphBorderStrokeEndJoin: EndJoin; /** * The tint (as a percentage) of the paragraph stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphBorderTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLeftCornerRadius: number | string; /** * The top line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLineWeight: number | string; /** * The distance to offset the top edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph border. */ paragraphBorderTopOrigin: ParagraphBorderTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphBorderTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopRightCornerRadius: number | string; /** * The type of the border for the paragraph. Can return: StrokeStyle or String. */ paragraphBorderType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph border. */ paragraphBorderWidth: ParagraphBorderEnum; /** * Paragraph direction. */ paragraphDirection: ParagraphDirectionOptions; /** * If true, the gyoudori mode applies to the entire paragraph. If false, the * gyoudori mode applies to each line in the paragraph. */ paragraphGyoudori: boolean; /** * Paragraph justification. */ paragraphJustification: ParagraphJustificationOptions; /** * Paragraph kashida width. 0 is none, 1 is short, 2 is medium, 3 is long */ paragraphKashidaWidth: number; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphShadingBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomLeftCornerRadius: number | string; /** * The distance to offset the bottom edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph shading. */ paragraphShadingBottomOrigin: ParagraphShadingBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphShadingBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomRightCornerRadius: number | string; /** * If true, forces the shading of the paragraph to be clipped with respect to * frame shape. */ paragraphShadingClipToFrame: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * shading. Can return: Swatch or String. */ paragraphShadingColor: Swatch | string; /** * The distance to offset the left edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingLeftOffset: number | string; /** * If true, the paragraph shading is On. */ paragraphShadingOn: boolean; /** * If true, the paragraph shading will overprint. */ paragraphShadingOverprint: boolean; /** * The distance to offset the right edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingRightOffset: number | string; /** * If true, suppress printing of the shading of the paragraph. */ paragraphShadingSuppressPrinting: boolean; /** * The tint (as a percentage) of the paragraph shading. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphShadingTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphShadingTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopLeftCornerRadius: number | string; /** * The distance to offset the top edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph shading. */ paragraphShadingTopOrigin: ParagraphShadingTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphShadingTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopRightCornerRadius: number | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph shading. */ paragraphShadingWidth: ParagraphShadingWidthEnum; /** * A collection of paragraphs. */ readonly paragraphs: Paragraphs; /** * The parent of the Line (a XmlStory, TextPath, TextFrame, EndnoteTextFrame, * Text, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, * Character, Story, Cell, XMLElement, Endnote, Footnote, Note, Change or * HiddenText). */ readonly parent: Cell | Change | Character | Endnote | EndnoteTextFrame | Footnote | InsertionPoint | Line | Note | Paragraph | Story | Text | TextColumn | TextFrame | TextPath | TextStyleRange | Word | XMLElement | HiddenText | XmlStory; /** * The story that contains the text. */ readonly parentStory: Story; /** * An array of the text frames that contain the text. Can return: Array of * TextFrames or TextPaths. */ readonly parentTextFrames: (TextFrames | TextPaths)[]; /** * The text size. * @remarks Measurement unit — also accepts a string such as "12mm". */ pointSize: number | string; /** * A collection of polygons. */ readonly polygons: Polygons; /** * The text position relative to the baseline. */ position: Position; /** * The OpenType positional form. */ positionalForm: PositionalForms; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The hyphenation style chosen for the provider. */ providerHyphenationStyle: HyphenationStyleEnum; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * If true, disallows line breaks in numbers. If false, lines can break between * digits in multi-digit numbers. */ rensuuji: boolean; /** * The width of the right indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ rightIndent: number | string; /** * If true, rotates Roman characters in vertical text. */ rotateSingleByteCharacters: boolean; /** * The ruby alignment. */ rubyAlignment: RubyAlignments; /** * If true, auto aligns ruby. */ rubyAutoAlign: boolean; /** * If true, automatically scales ruby to the specified percent of parent text * size. For information on specifying a percent, see ruby parent scaling * percent. */ rubyAutoScaling: boolean; /** * If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to * fit one em. */ rubyAutoTcyAutoScale: boolean; /** * The number of digits included in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyDigits: number; /** * If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyIncludeRoman: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby * characters. Can return: Swatch or String. */ rubyFill: Swatch | string; /** * If true, ruby is on. */ rubyFlag: boolean; /** * The font applied to ruby characters. Can return: Font or String. */ rubyFont: Font | string; /** * The size (in points) of ruby characters. */ rubyFontSize: number; /** * The font style of ruby characters. Can return: String or NothingEnum * enumerator. */ rubyFontStyle: string | NothingEnum; /** * If true, uses OpenType Pro fonts for ruby. */ rubyOpenTypePro: boolean; /** * If true, constrains ruby overhang to the specified amount. For information * on specifying an amount, see ruby parent overhang amount. */ rubyOverhang: boolean; /** * The method of overprinting the ruby fill. */ rubyOverprintFill: AdornmentOverprint; /** * The method of overprinting the ruby stroke. */ rubyOverprintStroke: AdornmentOverprint; /** * The amount by which ruby characters can overhang the parent text. */ rubyParentOverhangAmount: RubyOverhang; /** * The amount (as a percentage) to scale the parent text size to determine the * ruby text size. */ rubyParentScalingPercent: number; /** * The ruby spacing relative to the parent text. */ rubyParentSpacing: RubyParentSpacing; /** * The position of ruby characters relative to the parent text. */ rubyPosition: RubyKentenPosition; /** * The ruby string contents. */ rubyString: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * ruby characters. Can return: Swatch or String. */ rubyStroke: Swatch | string; /** * The stroke tint (as a percentage) of ruby characters. */ rubyStrokeTint: number; /** * The tint (as a percentage) of the ruby fill color. (Range: 0 to 100) * @remarks Range: 0 to 100 */ rubyTint: number; /** * The ruby type. */ rubyType: RubyTypes; /** * The stroke weight (in points) of ruby characters. */ rubyWeight: number; /** * The amount of horizontal space between ruby and parent characters. */ rubyXOffset: number; /** * The horizontal size of ruby characters, specified as a percent of the * original size. */ rubyXScale: number; /** * The amount of vertical space between ruby and parent characters. */ rubyYOffset: number; /** * The vertical size of ruby characters, specified as a percent of the original * size. */ rubyYScale: number; /** * If true, places a rule above the paragraph. */ ruleAbove: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule above. Can return: Swatch or String. */ ruleAboveColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule above. Note: Valid only when the paragraph rule above * type is not solid. Can return: Swatch or String. */ ruleAboveGapColor: Swatch | string; /** * If true, the stroke gap of the paragraph rule above will overprint. Note: * Valid only the rule above type is not solid. */ ruleAboveGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule. * (Range: 0 to 100) Note: Valid only when the rule above type is not solid. * @remarks Range: 0 to 100 */ ruleAboveGapTint: number; /** * The distance to indent the left edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLeftIndent: number | string; /** * The line weight of the rule above. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLineWeight: number | string; /** * The amount to offset the paragraph rule above from the baseline of the first * line the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveOffset: number | string; /** * If true, the paragraph rule above will overprint. */ ruleAboveOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleAboveTint: number; /** * The stroke type of the rule above the paragraph. Can return: StrokeStyle or * String. */ ruleAboveType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule above. */ ruleAboveWidth: RuleWidth; /** * If true, applies a paragraph rule below. */ ruleBelow: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule below. Can return: Swatch or String. */ ruleBelowColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule below. Note: Valid only when the paragraph rule below * type is not solid. Can return: Swatch or String. */ ruleBelowGapColor: Swatch | string; /** * If true, the gap color of the rule below will overprint. */ ruleBelowGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule * below. (Range: 0 to 100) Note: Valid only when the paragraph rule below type * is not solid. * @remarks Range: 0 to 100 */ ruleBelowGapTint: number; /** * The distance to indent the left edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLeftIndent: number | string; /** * The line weight of the rule below. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLineWeight: number | string; /** * The amount to offset the the paragraph rule below from the baseline of the * last line of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowOffset: number | string; /** * If true, the rule below will overprint. */ ruleBelowOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleBelowTint: number; /** * The stroke type of the rule below the paragraph. Can return: StrokeStyle or * String. */ ruleBelowType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule below. */ ruleBelowWidth: RuleWidth; /** * The space between paragraphs using same style. Can return: Unit or Spacing * enumerator. */ sameParaStyleSpacing: number | Spacing; /** * If true, the line changes size when characters are scaled. */ scaleAffectsLineHeight: boolean; /** * If true, applies shatai rotation. */ shataiAdjustRotation: boolean; /** * If true, adjusts shatai tsume. */ shataiAdjustTsume: boolean; /** * The shatai lens angle (in degrees). */ shataiDegreeAngle: number; /** * The amount (as a percentage) of shatai obliquing to apply. */ shataiMagnification: number; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * The alignment to use for lines that contain a single word. */ singleWordJustification: SingleWordJustification; /** * The skew angle of the Line. */ skew: number; /** * The height of the paragraph space below. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceAfter: number | string; /** * The height of the paragraph space above. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceBefore: number | string; /** * The minimum space after a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceAfter: number | string; /** * The minimum space before a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceBefore: number | string; /** * Whether a paragraph should be a single column, span columns or split columns */ spanColumnType: SpanColumnTypeOptions; /** * The number of columns a paragraph spans or the number of split columns. Can * return: Short Integer (1 - 40) or SpanColumnCountOptions enumerator. */ spanSplitColumnCount: number | SpanColumnCountOptions; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The inside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnInsideGutter: number | string; /** * The outside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnOutsideGutter: number | string; /** * The location at which to start the paragraph. */ startParagraph: StartParagraph; /** * The swatch (color, gradient, tint, or mixed ink) applied to the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughGapColor: Swatch | string; /** * If true, the gap color of the strikethrough stroke will overprint. Note: * Valid when strike through type is not solid. */ strikeThroughGapOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 * to 100) Note: Valid when strike through type is not solid. * @remarks Range: 0 to 100 */ strikeThroughGapTint: number; /** * The amount by which to offset the strikethrough stroke from the text * baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughOffset: number | string; /** * If true, the strikethrough stroke will overprint. */ strikeThroughOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ strikeThroughTint: number; /** * The stroke type of the strikethrough stroke. Can return: StrokeStyle or * String. */ strikeThroughType: StrokeStyle | string; /** * The stroke weight of the strikethrough stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughWeight: number | string; /** * If true, draws a strikethrough line through the text. */ strikeThru: boolean; /** * The stroke alignment applied to the text. */ strokeAlignment: TextStrokeAlign; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the Line. Can also accept: String. */ strokeColor: Swatch | string; /** * The tint (as a percentage) of the stroke color of the Line. (To specify a * tint percentage, use a number in the range of 0 to 100; to use the inherited * or overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * The stroke weight applied to the characters of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * If true, the applied style has been overridden with additional attributes. */ readonly styleOverridden: boolean; /** * A list of the tab stops in the paragraph. Can return: Array of Arrays of * Property Name/Value Pairs. */ tabList: any[][][]; /** * A collection of tab stops. */ readonly tabStops: TabStops; /** * A collection of tables. */ readonly tables: Tables; /** * If true, makes the character horizontal in vertical text. */ tatechuyoko: boolean; /** * The horizontal offset for horizontal characters in vertical text. */ tatechuyokoXOffset: number; /** * The vertical offset for horizontal characters in vertical text. */ tatechuyokoYOffset: number; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text columns. */ readonly textColumns: TextColumns; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * A collection of text style ranges. */ readonly textStyleRanges: TextStyleRanges; /** * A collection of text variable instances. */ readonly textVariableInstances: TextVariableInstances; /** * A collection of text objects. */ readonly texts: Texts; /** * The amount by which to loosen or tighten a block of text, specified in * thousands of an em. */ tracking: number; /** * The amount of space after each character. */ trailingAki: number; /** * If true, ideographic spaces will not wrap to the next line like text * characters. */ treatIdeographicSpaceAsSpace: boolean; /** * The amount of horizontal character compression. */ tsume: number; /** * If true, underlines the text. */ underline: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the underline * stroke. . Can return: Swatch or String. */ underlineColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * underline stroke. Note: Valid when underline type is not solid. Can return: * Swatch or String. */ underlineGapColor: Swatch | string; /** * If true, the gap color of the underline stroke will overprint. */ underlineGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of the underline stroke. (Range: * 0 to 100) Note: Valid when underline type is not solid. * @remarks Range: 0 to 100 */ underlineGapTint: number; /** * The amount by which to offset the underline from the text baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineOffset: number | string; /** * If true, the underline stroke color will overprint. */ underlineOverprint: boolean; /** * The underline stroke tint (as a percentage). (Range: 0 to 100) * @remarks Range: 0 to 100 */ underlineTint: number; /** * The stroke type of the underline stroke. Can return: StrokeStyle or String. */ underlineType: StrokeStyle | string; /** * The stroke weight of the underline stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineWeight: number | string; /** * The vertical scaling applied to the Line. */ verticalScale: number; /** * If true, turns on warichu. */ warichu: boolean; /** * The warichu alignment. */ warichuAlignment: WarichuAlignment; /** * The minimum number of characters allowed after a line break. */ warichuCharsAfterBreak: number; /** * The minimum number of characters allowed before a line break. */ warichuCharsBeforeBreak: number; /** * The gap between lines of warichu characters. */ warichuLineSpacing: number; /** * The number of lines of warichu within a single normal line. */ warichuLines: number; /** * The amount (as a percentage) to scale parent text size to determine warichu * size. */ warichuSize: number; /** * A collection of words. */ readonly words: Words; /** * The x (horizontal) offset for diacritic adjustment. */ xOffsetDiacritic: number; /** * The y (vertical) offset for diacritic adjustment. */ yOffsetDiacritic: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Apply a character style. * @param using The character style to apply. */ applyCharacterStyle(using: CharacterStyle): void; /** * Apply one or more conditions. * @param using The condition(s) to apply * @param removeExisting If true, remove existing conditions. (Optional) */ applyConditions(using: Condition[], removeExisting?: boolean): void; /** * Apply a paragraph style. * @param using The paragraph style to apply. * @param clearingOverrides If true, clear any text attributes before applying the style. (Optional) */ applyParagraphStyle(using: ParagraphStyle, clearingOverrides?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds glyphs that match the find what value and replaces the glyphs with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value and replaces the text * with the change character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeTransliterate(reverseOrder?: boolean): Text[]; /** * Sets the case of the text. * @param using The text case option. */ changecase(using: ChangecaseMode): void; /** * Clears the specified types of override. * @param overridesToClear The types of override to clear. (Optional) */ clearOverrides(overridesToClear?: OverrideType): void; /** * Convert bullets and numbering to text. */ convertBulletsAndNumberingToText(): void; /** * Converts the text to a note. */ convertToNote(): Note; /** * Converts the text to a table. * @param columnSeparator The character that starts a new column in the new table. (Optional) * @param rowSeparator The character starts a new row in the new table. (Optional) * @param numberOfColumns The number of columns in the table. Note: Valid only when the column and row separator characters are the same. (Optional) */ convertToTable(columnSeparator?: string, rowSeparator?: string, numberOfColumns?: number): Table; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Line. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Line. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Converts text to outlines. Each line of text becomes a polygon object. When * the converted text is a single letter that has no internal spaces or * detached parts, the polygon contains only a single path. Note: To determine * whether a font allows the creation of outlines, see allow outlines. * @param deleteOriginal If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) */ createOutlines(deleteOriginal?: boolean): PageItem[]; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Line. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create thumbnail for selected text using the applied style and overrides * with the given properties. * @param previewText Text to use as sample * @param pointSize Text font size (in points) * @param space Color space RGB, CMYK or LAB * @param colorValue Color values * @param to The path to the export file. * @param charOrParaStyle The applied style type to use. */ createStyleThumbnailWithProperties(previewText: string, pointSize: number, space: ColorSpace, colorValue: number[], to: File, charOrParaStyle: StyleType): boolean; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Line. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create thumbnail for selected text with the given properties. * @param previewText Text to use as sample * @param pointSize Text font size (in points) * @param space Color space RGB, CMYK or LAB * @param colorValue Color values * @param to The path to the export file. */ createThumbnailWithProperties(previewText: string, pointSize: number, space: ColorSpace, colorValue: number[], to: File): boolean; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Line. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Duplicates the text in the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional) */ duplicate(to: LocationOptions, reference?: Cell | Column | Row | Story | Table | Text | PageItem): Text; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Finds glyphs that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGrep(reverseOrder?: boolean): Text[]; /** * Finds hyperlink sources that intersecting with specified text range. * @param sortOrder The sort order of found ranges. (Optional) */ findHyperlinks(sortOrder?: RangeSortOrder): HyperlinkTextSource[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findTransliterate(reverseOrder?: boolean): Text[]; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Line[]; /** * If true, Nth design axis of variable font is hidden. * @param nthAxisIndex Index of design axis. */ isNthDesignAxisHidden(nthAxisIndex: number): boolean; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the text to the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional) */ move(to: LocationOptions, reference?: Cell | Column | Row | Story | Table | Text | PageItem): Text; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Recomposes the text in the Line. */ recompose(): void; /** * Deletes the Line. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Selects the object. * @param existingSelection The selection status of the Line in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Set Nth design axis of a variable font. * @param nthAxisIndex Index of design axis. * @param nthAxisValue Value of nth design axis. */ setNthDesignAxis(nthAxisIndex: number, nthAxisValue: number): void; /** * Jump to the text range. */ showText(): void; /** * If true, text has local overrides * @param charOrParaStyle Style type to look at. * @param charStyleAsOverride Whether to consider character styles as overrides or not (Optional) */ textHasOverrides(charOrParaStyle: StyleType, charStyleAsOverride?: boolean): boolean; /** * Generates a string which, if executed, will return the Line. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Line justification options. */ declare enum LineAlignment { /** * Center aligns the text. */ CENTER_LINE_ALIGN = 1818321774, /** * Justifies horizontal text on both the right and left and center aligns the * last line or justifies vertical text on both the top and bottom and center * aligns the last line. */ CENTER_LINE_JUSTIFY = 1818455658, /** * Justifies horizontal text on both the right and left or justifies vertical * text on both the top and bottom and gives all lines a uniform length. */ FULL_LINE_JUSTIFY = 1818651754, /** * Left aligns horizontal text or top aligns vertical text. */ LEFT_OR_TOP_LINE_ALIGN = 1818324084, /** * Justifies horizontal text on both the right and left and left aligns the * last line or justifies vertical text on both the top and bottom and top * aligns the last line. */ LEFT_OR_TOP_LINE_JUSTIFY = 1819047018, /** * Right aligns horizontal text or bottom aligns vertical text. */ RIGHT_OR_BOTTOM_LINE_ALIGN = 1818325602, /** * Justifies horizontal text on both the right and left and right aligns the * last line or justifies vertical text on both the top and bottom and bottom * aligns the last line. */ RIGHT_OR_BOTTOM_LINE_JUSTIFY = 1819435626, } /** * Line spacing type. */ declare enum LineSpacingType { /** * Double space */ DOUBLE_SPACE = 1682068336, /** * One and half space */ ONE_AND_HALF_SPACE = 1866549363, /** * Single space */ SINGLE_SPACE = 1936282480, /** * Triple space */ TRIPLE_SPACE = 1951552368, } /** * A collection of lines. */ declare class Lines { /** Returns the Line with the specified index or name. */ [index: number]: Line; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Line in the collection. */ anyItem(): Line; /** * Displays the number of elements in the Line. */ count(): number; /** * Returns every Line in the collection. */ everyItem(): Line; /** * Returns the first Line in the collection. */ firstItem(): Line; /** * Returns the Line with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Line; /** * Returns the Lines within the specified range. * @param from The Line, index, or name at the beginning of the range. Can accept: Line, Long Integer or String. * @param to The Line, index, or name at the end of the range. Can accept: Line, Long Integer or String. */ itemByRange(from: Line | number | string, to: Line | number | string): Line[]; /** * Returns the last Line in the collection. */ lastItem(): Line; /** * Returns the middle Line in the collection. */ middleItem(): Line; /** * Returns the Line whose index follows the specified Line in the collection. * @param obj The Line whose index comes before the desired Line. */ nextItem(obj: Line): Line; /** * Returns the Line with the index previous to the specified index. * @param obj The index of the Line that follows the desired Line. */ previousItem(obj: Line): Line; /** * Generates a string which, if executed, will return the Line. */ toSource(): string; } /** * A link to a placed file. */ declare class Link { /** * The asset ID of the linked object. */ readonly assetID: string; /** * The asset URL of the linked object. */ readonly assetURL: string; /** * The date and time the Link was created. */ readonly date: Date; /** * If true, indicates the linked object has been edited in the current document * but the source file has not been updated. */ readonly edited: boolean; /** * The Version Cue editing state of the file. */ readonly editingState: EditingState; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The file path (colon delimited on the Mac OS). Can also accept: File. */ readonly filePath: string | File; /** * The unique ID of the Link. */ readonly id: number; /** * The index of the link in the links collection. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The URI of the linked resource. */ readonly linkResourceURI: string; /** * The file type of the linked object. */ readonly linkType: string; /** * XMP data for the link source file. */ readonly linkXmp: LinkMetadata; /** * A collection of links. */ readonly links: Links; /** * The name of the Link. */ readonly name: string; /** * If true, indicates a link to a full-resolution version of the source file is * needed. If false, indicates the object is embedded. */ readonly needed: boolean; /** * The linked object. Can return: Story, Graphic, Movie or Sound. */ readonly parent: Graphic | Movie | Story | Sound; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The rendition data of the link resource. */ readonly renditionData: LinkResourceRenditionType; /** * The size of the Link file. */ readonly size: number; /** * The status of the link. */ readonly status: LinkStatus; /** * The Version Cue version state of the file. */ readonly versionState: VersionState; /** * Dispatched when the value of a property changes on this Link. This event * bubbles. This event is not cancelable. */ static readonly AFTER_ATTRIBUTE_CHANGED: string; /** * Dispatched after a Link is deleted. This event bubbles. This event is not * cancelable. */ static readonly AFTER_DELETE: string; /** * Dispatched after a Link is embedded. This event bubbles. This event is not * cancelable. */ static readonly AFTER_EMBED: string; /** * Dispatched after a Link is relocated from one object to another. This event * bubbles. This event is not cancelable. */ static readonly AFTER_MOVE: string; /** * Dispatched after a Link is created. This event bubbles. This event is not * cancelable. */ static readonly AFTER_NEW: string; /** * Dispatched after a Link is unembedded. This event bubbles. This event is not * cancelable. */ static readonly AFTER_UNEMBED: string; /** * Dispatched after a Link is updated. This event bubbles. This event is not * cancelable. */ static readonly AFTER_UPDATE: string; /** * Dispatched before a Link is deleted. This event bubbles. This event is * cancelable. */ static readonly BEFORE_DELETE: string; /** * Dispatched before a Link is embedded. This event bubbles. This event is * cancelable. */ static readonly BEFORE_EMBED: string; /** * Dispatched before a Link is relocated from one object to another. This event * bubbles. This event is cancelable. */ static readonly BEFORE_MOVE: string; /** * Dispatched before a Link is unembedded. This event bubbles. This event is * cancelable. */ static readonly BEFORE_UNEMBED: string; /** * Dispatched before a Link is updated. This event bubbles. This event is * cancelable. */ static readonly BEFORE_UPDATE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Check in to Version Cue. * @param versionComments The comment for this version (Optional) * @param forceSave Forcibly save a version (Optional) */ checkIn(versionComments?: string, forceSave?: boolean): void; /** * Copies the link file to the specified location. * @param to The file or folder to which to copy the file. * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ copyLink(to: File, versionComments?: string, forceSave?: boolean): void; /** * Opens the source file of the link in the default editor for the source file * type. */ editOriginal(): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Link[]; /** * Opens the source file of the link in InDesign for SharedContent links. */ goToSource(): void; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Experimental: Reinitialize the link to a new uri * @param linkResourceURI Resource URI to relink. */ reinitLink(linkResourceURI: string): void; /** * Points the link to a new source file. * @param to The full path name of the new source file. Can accept: File or String. */ relink(to: File | string): void; /** * Experimental: Relink the text fragment link to a new uri * @param linkResourceURI Resource URI to relink to. * @param name The tag name for the key. (Optional) */ relinkTextFragmentLink(linkResourceURI: string, name?: string): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Experimental: Download the original asset and replace FPO with it. */ replaceWithOriginal(): void; /** * Opens Adobe Bridge and selects the source file of the link. */ revealInBridge(): void; /** * Opens the file system to the folder that contains the source file of the * link, and selects the file. */ revealInSystem(): void; /** * Selects the link. */ show(): void; /** * Generates a string which, if executed, will return the Link. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Unembeds the source file. If no folder is specified, creates a link to the * original source file; if a folder is specified, copies the file to the * folder and creates a link to the copied file. * @param to The folder to which to copy the unembedded file. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ unembed(to?: File, versionComments?: string, forceSave?: boolean): void; /** * Embeds the source file in the document. */ unlink(): void; /** * Updates the link if the source file has been changed. */ update(): Link; } /** * MetaData properties for the link source file. */ declare class LinkMetadata extends Preference { /** * The author of the document. */ readonly author: string; /** * The URL of the file that contains the linked copyright statement. */ readonly copyrightInfoURL: string; /** * The text to use as a copyright notice. */ readonly copyrightNotice: string; /** * The copyright status of the document. */ readonly copyrightStatus: CopyrightStatus; /** * The creation date of the document. */ readonly creationDate: Date; /** * The name of the application used to create the document. */ readonly creator: string; /** * The description of the LinkMetadata. */ readonly description: string; /** * The title of the document. */ readonly documentTitle: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The format of the document. */ readonly format: string; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The job name. */ readonly jobName: string; /** * The list of keywords associated with the document. */ readonly keywords: string[]; /** * The most recent modification date of the document. */ readonly modificationDate: Date; /** * The parent of the LinkMetadata (a Link). */ readonly parent: Link; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The location of the document on the asset management server. */ readonly serverURL: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Counts the number of items in the container. * @param namespace The namespace of the container. * @param path The path to the container. */ countContainer(namespace: string, path: string): number; /** * Resolves the object specifier, creating an array of object references. */ getElements(): LinkMetadata[]; /** * Gets the XMP property value associated with the specified path. * @param namespace The namespace of the property. * @param path The specified path. */ getProperty(namespace: string, path: string): string; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the LinkMetadata. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * The rendition type of the link resource. */ declare enum LinkResourceRenditionType { /** * The link resource has original rendition. */ ACTUAL = 1282372201, /** * The link resource has FPO rendition. */ FPO = 1281781871, } /** * Link status options. */ declare enum LinkStatus { /** * The file is embedded in the document. */ LINK_EMBEDDED = 1282237028, /** * The url link is inaccessible. */ LINK_INACCESSIBLE = 1818848865, /** * The linked file has been moved, renamed, or deleted. */ LINK_MISSING = 1819109747, /** * A more recent version of the file exists on the disk. */ LINK_OUT_OF_DATE = 1819242340, /** * The link is a normal link. */ NORMAL = 1852797549, } /** * The link options for a linked Page Item. */ declare class LinkedPageItemOption extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the LinkedPageItemOption (a Application, Document, PageItem, * HtmlItem, FlexObject, FormField, SignatureField, TextBox, RadioButton, * ListBox, ComboBox, CheckBox, MultiStateObject, Button, MediaItem, Sound, * Movie, EPSText, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Graphic, * SVG, ImportedPage, PICT, WMF, PDF, EPS, Image, Group, TextFrame or * EndnoteTextFrame). */ readonly parent: Button | CheckBox | ComboBox | Document | EPS | EPSText | FlexObject | FormField | Graphic | GraphicLine | Group | HtmlItem | Image | ImportedPage | ListBox | MediaItem | Movie | MultiStateObject | Oval | PDF | PICT | PageItem | Polygon | RadioButton | Rectangle | SVG | SignatureField | Sound | SplineItem | TextBox | TextFrame | WMF | Application | EndnoteTextFrame; /** * If true, appearance edits will be preserved during update. */ preserveAppearance: boolean; /** * If true, frame content edits will be preserved during update. */ preserveFrameContent: boolean; /** * If true, interactivity edits will be preserved during update. */ preserveInteractivity: boolean; /** * If true, text wrap, hyperLinks, text frame options, object export settings * will be preserved during update. */ preserveOthers: boolean; /** * If true, size and shape edits will be preserved during update. */ preserveSizeAndShape: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, the linked Page Item will be updated while saving. */ updateLinkWhileSaving: boolean; /** * If true, a warning will be shown if the update link operation will override * local edits. */ warnOnUpdateOfEditedPageItem: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): LinkedPageItemOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the LinkedPageItemOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * The link options for a linked story. */ declare class LinkedStoryOption extends Preference { /** * If true, style mappings will be applied during linked story creation or * update. */ applyStyleMappings: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the LinkedStoryOption (a Application, Document, Story or * XmlStory). */ readonly parent: Document | Story | Application | XmlStory; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, forced line breaks will be removed during story creation or update. */ removeForcedLineBreaks: boolean; /** * If true, the linked story will be updated while saving. */ updateWhileSaving: boolean; /** * If true, a warning will be shown if the update link operation will override * local edits. */ warnOnUpdateOfEditedStory: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): LinkedStoryOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the LinkedStoryOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Linking preferences. */ declare class LinkingPreference extends Preference { /** * If true, link states will be checked at document open time */ checkLinksAtOpen: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, missing links will be searched for at document open time */ findMissingLinksAtOpen: boolean; /** * Experimental: The preference for enabling auto tagging of items created * through http based links. */ httpLinksAutoTagAssetsPreference: boolean; /** * Experimental: The rendition type for http link. */ httpLinksRenditionType: LinkResourceRenditionType; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the LinkingPreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): LinkingPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the LinkingPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of links. */ declare class Links { /** Returns the Link with the specified index or name. */ [index: number]: Link; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Link in the collection. */ anyItem(): Link; /** * Displays the number of elements in the Link. */ count(): number; /** * Returns every Link in the collection. */ everyItem(): Link; /** * Returns the first Link in the collection. */ firstItem(): Link; /** * Returns the Link with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Link; /** * Returns the Link with the specified ID. * @param id The ID. */ itemByID(id: number): Link; /** * Returns the Link with the specified name. * @param name The name. */ itemByName(name: string): Link; /** * Returns the Links within the specified range. * @param from The Link, index, or name at the beginning of the range. Can accept: Link, Long Integer or String. * @param to The Link, index, or name at the end of the range. Can accept: Link, Long Integer or String. */ itemByRange(from: Link | number | string, to: Link | number | string): Link[]; /** * Returns the last Link in the collection. */ lastItem(): Link; /** * Returns the middle Link in the collection. */ middleItem(): Link; /** * Returns the Link whose index follows the specified Link in the collection. * @param obj The Link whose index comes before the desired Link. */ nextItem(obj: Link): Link; /** * Returns the Link with the index previous to the specified index. * @param obj The index of the Link that follows the desired Link. */ previousItem(obj: Link): Link; /** * Generates a string which, if executed, will return the Link. */ toSource(): string; } /** * List alignment options. */ declare enum ListAlignment { /** * Align center. */ CENTER_ALIGN = 1667591796, /** * Align left. */ LEFT_ALIGN = 1818584692, /** * Align right. */ RIGHT_ALIGN = 1919379572, } /** * A listbox. */ declare class ListBox extends FormField { /** * Indicates whether the ListBox has been flipped independently of its parent * object and, if yes, the direction in which the ListBox was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the ListBox relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the ListBox relative to its containing object. (Range: * -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the ListBox relative to its containing object. (Range: * -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the ListBox relative to its containing object. */ absoluteVerticalScale: number; /** * The index of the active state in the object's states collection. */ activeStateIndex: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the ListBox. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the ListBox. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * Anchored object settings. */ readonly anchoredObjectSettings: AnchoredObjectSetting; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The font family for the form field in the exported PDF. */ appliedFont: string; /** * The object style applied to the ListBox. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the ListBox. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the ListBox. */ readonly associatedXMLElement: XMLItem; /** * A collection of behavior objects. */ readonly behaviors: Behaviors; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * The list of choices for combo and list boxes in the exported PDF. */ choiceList: string[]; /** * A collection of clear form behavior objects. */ readonly clearFormBehaviors: ClearFormBehaviors; /** * Transparency settings for the content of the ListBox. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The description of the ListBox. */ description: string; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the ListBox. */ endJoin: EndJoin; /** * A collection of EPS files. */ readonly epss: EPSs; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * ListBox. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the ListBox's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the ListBox. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * The font size for the form field in the exported PDF. */ fontSize: number; /** * The font style for the form field in the exported PDF. */ fontStyle: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the ListBox excluding the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * A collection of goto anchor behavior objects. */ readonly gotoAnchorBehaviors: GotoAnchorBehaviors; /** * A collection of goto first page behavior objects. */ readonly gotoFirstPageBehaviors: GotoFirstPageBehaviors; /** * A collection of goto last page behavior objects. */ readonly gotoLastPageBehaviors: GotoLastPageBehaviors; /** * A collection of goto next page behavior objects. */ readonly gotoNextPageBehaviors: GotoNextPageBehaviors; /** * A collection of goto next view behavior objects. */ readonly gotoNextViewBehaviors: GotoNextViewBehaviors; /** * A collection of goto previous page behavior objects. */ readonly gotoPreviousPageBehaviors: GotoPreviousPageBehaviors; /** * A collection of goto previous view behavior objects. */ readonly gotoPreviousViewBehaviors: GotoPreviousViewBehaviors; /** * A collection of goto URL behavior objects. */ readonly gotoURLBehaviors: GotoURLBehaviors; /** * The angle of a linear gradient applied to the fill of the ListBox. (Range: * -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the ListBox. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the ListBox, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the ListBox. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the ListBox. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the ListBox, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * A collection of groups. */ readonly groups: Groups; /** * If true, the form field/push button is hidden until triggered in the * exported PDF. */ hiddenUntilTriggered: boolean; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the ListBox. */ horizontalScale: number; /** * The unique ID of the ListBox. */ readonly id: number; /** * A collection of bitmap images in any bitmap file format (including TIFF, * JPEG, or GIF). */ readonly images: Images; /** * The index of the ListBox within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the ListBox is on. */ itemLayer: Layer; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the ListBox. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the ListBox is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * A collection of movie behavior objects. */ readonly movieBehaviors: MovieBehaviors; /** * If true, the list box can have multiple items selected simultaneously in the * exported PDF. */ multipleSelection: boolean; /** * The name of the ListBox. */ name: string; /** * If true, the ListBox does not print. */ nonprinting: boolean; /** * A collection of open file behavior objects. */ readonly openFileBehaviors: OpenFileBehaviors; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the ListBox's fill color overprints any underlying objects. If * false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the ListBox's stroke color overprints any underlying objects. If * false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the ListBox (a Snippet, PlaceGun, FlexObject, Character, * Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval or * Group). */ readonly parent: Character | FlexObject | GraphicLine | MasterSpread | Oval | PlaceGun | Polygon | Rectangle | SplineItem | Spread | Group | Snippet; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of PDF files. */ readonly pdfs: PDFs; /** * A collection of PICT graphics. */ readonly picts: PICTs; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A collection of print form behavior objects. */ readonly printFormBehaviors: PrintFormBehaviors; /** * If true, the form field/push button is printable in the exported PDF. */ printableInPdf: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, the form field is read only in the exported PDF. */ readOnly: boolean; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * If true, the form field is required in the exported PDF. */ required: boolean; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * If true, the form field has right to left text enabled in the exported PDF. */ rightToLeftField: boolean; /** * The rotatation angle of the ListBox. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the ListBox. (Range: -360 to 360) */ shearAngle: number; /** * A collection of show/hide fields behavior objects. */ readonly showHideFieldsBehaviors: ShowHideFieldsBehaviors; /** * If true, the choices would be sorted in the exported PDF. */ sortChoices: boolean; /** * A collection of sound behavior objects. */ readonly soundBehaviors: SoundBehaviors; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The stroke alignment applied to the ListBox. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the ListBox. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the ListBox. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the ListBox's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of submit form behavior objects. */ readonly submitFormBehaviors: SubmitFormBehaviors; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the ListBox. */ verticalScale: number; /** * A collection of view zoom behavior objects. */ readonly viewZoomBehaviors: ViewZoomBehaviors; /** * If true, the ListBox is visible. */ visible: boolean; /** * The bounds of the ListBox including the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * A collection of WMF graphics. */ readonly wmfs: WMFs; /** * Dispatched after a ListBox is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a ListBox is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the ListBox's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the ListBox that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Brings the ListBox forward one level in its layer. */ bringForward(): void; /** * Brings the ListBox to the front of its layer or in front of a particular * item. * @param reference The reference object to bring the object in front of (must have same parent) (Optional) */ bringToFront(reference?: PageItem): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the ListBox. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the ListBox to a different shape. * @param given The ListBox's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Converts the button object to the page item currently in the active state. * Page items from other states will be lost. */ convertToObject(): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new ListBox. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new ListBox. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new ListBox. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new ListBox. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new ListBox. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the ListBox at the specified location or offset. * @param to The location of the new ListBox, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new ListBox from the original ListBox's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the ListBox. * @param given The axis around which to flip the ListBox. * @param around The point around which to flip the ListBox. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ListBox[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the ListBox to a new location. Note: Either the 'to' or 'by' parameter * is required; if both parameters are defined, only the to value is used. * @param to The new location of the ListBox,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the ListBox relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the ListBox. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the ListBox in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Sends the ListBox back one level in its layer. */ sendBackward(): void; /** * Sends the ListBox to the back of its layer or behind a particular item (must * have same parent). * @param reference The reference object to send the object behind (Optional) */ sendToBack(reference?: PageItem): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new ListBox (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the ListBox. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the ListBox using the last transformation performed on any * object. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgain(): string[]; /** * Transforms the ListBox using the last transformation performed on any * ListBox. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgainIndividually(): string[]; /** * Transforms the ListBox using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the ListBox using the last sequence of transformations performed * on any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * A collection of listboxes. */ declare class ListBoxes { /** Returns the ListBox with the specified index or name. */ [index: number]: ListBox; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new ListBox * @param layer The layer on which to create the ListBox. (Optional) * @param at The location at which to insert the ListBox relative to the reference object or within the container object. (Optional) * @param reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) * @param withProperties Initial values for properties of the new ListBox (Optional) */ add(layer?: Layer, at?: LocationOptions, reference?: Document | Layer | MasterSpread | Page | Spread | PageItem, withProperties?: Object): ListBox; /** * Returns any ListBox in the collection. */ anyItem(): ListBox; /** * Displays the number of elements in the ListBox. */ count(): number; /** * Returns every ListBox in the collection. */ everyItem(): ListBox; /** * Returns the first ListBox in the collection. */ firstItem(): ListBox; /** * Returns the ListBox with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): ListBox; /** * Returns the ListBox with the specified ID. * @param id The ID. */ itemByID(id: number): ListBox; /** * Returns the ListBox with the specified name. * @param name The name. */ itemByName(name: string): ListBox; /** * Returns the ListBoxes within the specified range. * @param from The ListBox, index, or name at the beginning of the range. Can accept: ListBox, Long Integer or String. * @param to The ListBox, index, or name at the end of the range. Can accept: ListBox, Long Integer or String. */ itemByRange(from: ListBox | number | string, to: ListBox | number | string): ListBox[]; /** * Returns the last ListBox in the collection. */ lastItem(): ListBox; /** * Returns the middle ListBox in the collection. */ middleItem(): ListBox; /** * Returns the ListBox whose index follows the specified ListBox in the * collection. * @param obj The ListBox whose index comes before the desired ListBox. */ nextItem(obj: ListBox): ListBox; /** * Returns the ListBox with the index previous to the specified index. * @param obj The index of the ListBox that follows the desired ListBox. */ previousItem(obj: ListBox): ListBox; /** * Generates a string which, if executed, will return the ListBox. */ toSource(): string; } /** * List type options. */ declare enum ListType { /** * Bullet list. */ BULLET_LIST = 1280598644, /** * No list. */ NO_LIST = 1280601711, /** * Numbered list. */ NUMBERED_LIST = 1280601709, } /** * Live drawing options for when user mouse actions trigger live screen drawing * of page items. */ declare enum LiveDrawingOptions { /** * Use live screen drawing during mouse operations after a delay if user pauses * before the mouse moves. */ DELAYED = 1347765349, /** * Use live screen drawing during mouse operations. */ IMMEDIATELY = 1347766637, /** * Never use live screen drawing during mouse operations, use sprite mode. */ NEVER = 1347767926, } /** * The locale. */ declare enum Locale { /** * Arabic */ ARABIC_LOCALE = 1279476082, /** * Czech */ CZECH_LOCALE = 1279476602, /** * Danish. */ DANISH_LOCALE = 1279476846, /** * English. */ ENGLISH_LOCALE = 1279477102, /** * Finnish. */ FINNISH_LOCALE = 1279477358, /** * French. */ FRENCH_LOCALE = 1279477362, /** * German. */ GERMAN_LOCALE = 1279477613, /** * Greek */ GREEK_LOCALE = 1279477618, /** * Hebrew */ HEBREW_LOCALE = 1279477858, /** * Hungarian */ HUNGARIAN_LOCALE = 1279477877, /** * International English. */ INTERNATIONAL_ENGLISH_LOCALE = 1279477097, /** * Italian. */ ITALIAN_LOCALE = 1279478132, /** * Japanese. */ JAPANESE_LOCALE = 1279478384, /** * en_KoreanLocale */ KOREAN_LOCALE = 1279478639, /** * Polish */ POLISH_LOCALE = 1279479916, /** * Portuguese. */ PORTUGUESE_LOCALE = 1279479911, /** * Romanian */ ROMANIAN_LOCALE = 1279480431, /** * Russian */ RUSSIAN_LOCALE = 1279480437, /** * simplified chinese */ SIMPLIFIED_CHINESE_LOCALE = 1279476590, /** * Spanish. */ SPANISH_LOCALE = 1279480688, /** * Swedish. */ SWEDISH_LOCALE = 1279480695, /** * traditional chinese */ TRADITIONAL_CHINESE_LOCALE = 1279480951, /** * Turkish */ TURKISH_LOCALE = 1279480946, /** * Ukrainian */ UKRAINIAN_LOCALE = 1279481195, } /** * Options for specifying location relative to the reference object or within * the containing object. */ declare enum LocationOptions { /** * Places the object after the reference object. */ AFTER = 1634104421, /** * Places the object at the beginning of the containing object. */ AT_BEGINNING = 1650945639, /** * Places the object at the end of the containing object. */ AT_END = 1701733408, /** * Places the object before the reference object. */ BEFORE = 1650812527, /** * No location specified. */ UNKNOWN = 1433299822, } /** * Lock state options. */ declare enum LockStateValues { /** * The story has been checked in. */ CHECKED_IN_STORY = 1112695657, /** * The story has been checked out. */ CHECKED_OUT_STORY = 1112695663, /** * The story is embedded. */ EMBEDDED_STORY = 1112696173, /** * The story is locked. */ LOCKED_STORY = 1112697963, /** * The story file is missing. */ MISSING_LOCK_STATE = 1112698227, /** * The stories have a mixed lock state. */ MIXED_LOCK_STATE = 1112698232, /** * No lock state. */ NONE = 1852796517, /** * The story is unmanaged. */ UNMANAGED_STORY = 1112700269, } /** * Mapping type for style mappings. */ declare enum MapType { /** * group to group mapping rule. */ GROUP_MAPPING_RULE = 1735681906, /** * group to style mapping rule. */ GROUP_TO_STYLE_MAPPING_RULE = 1735684978, /** * style to style mapping rule. */ STYLE_MAPPING_RULE = 1937011570, /** * style to group mapping rule. */ STYLE_TO_GROUP_MAPPING_RULE = 1937008498, } /** * Margin preferences. */ declare class MarginPreference extends Preference { /** * The bottom edge of the MarginPreference. * @remarks Measurement unit — also accepts a string such as "12mm". */ bottom: number | string; /** * The number of columns to place on the page. * @remarks Range: 1 to 216 */ columnCount: number; /** * The direction of text in the column. */ columnDirection: HorizontalOrVertical; /** * The distance between columns. * @remarks Measurement unit — also accepts a string such as "12mm". */ columnGutter: number | string; /** * The distance that each column guide is placed from the left margin, * formatted as an array in the format [guide1, guide2, guide3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ columnsPositions: (number | string)[]; /** * If false, columns are evenly spaced. If true, columns can have custom * widths. */ readonly customColumns: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The left edge of the MarginPreference. * @remarks Measurement unit — also accepts a string such as "12mm". */ left: number | string; /** * The parent of the MarginPreference (a Application, Document or Page). */ readonly parent: Document | Application | Page; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The right edge of the MarginPreference. * @remarks Measurement unit — also accepts a string such as "12mm". */ right: number | string; /** * The top edge of the MarginPreference. * @remarks Measurement unit — also accepts a string such as "12mm". */ top: number | string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): MarginPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the MarginPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Stroke weight options for printer marks. */ declare enum MarkLineWeight { /** * 05 mm. */ P05MM = 808807789, /** * 07 mm. */ P07MM = 808938861, /** * 10 mm. */ P10MM = 825257325, /** * 125 pt. */ P125PT = 825374064, /** * 15 mm. */ P15MM = 825585005, /** * 20 mm. */ P20MM = 842034541, /** * 25 pt. */ P25PT = 842346608, /** * 30 mm. */ P30MM = 858811757, /** * 50 pt. */ P50PT = 892350576, } /** * Options for printer marks formats. */ declare enum MarkTypes { /** * Uses the default format. */ DEFAULT_VALUE = 1147563124, /** * Uses J marks without a circle. */ J_MARK_WITHOUT_CIRCLE = 1785556579, /** * Uses J marks with a circle. */ J_MARK_WITH_CIRCLE = 1785558883, } /** * A master spread. */ declare class MasterSpread { /** * Lists all graphics contained by the MasterSpread. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the MasterSpread. */ readonly allPageItems: PageItem[]; /** * The master spread applied to the MasterSpread. Can also accept: NothingEnum * enumerator. */ appliedMaster: MasterSpread | NothingEnum; /** * The name of the master spread. */ baseName: string; /** * A collection of buttons. */ readonly buttons: Buttons; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * A collection of form fields. */ readonly formFields: FormFields; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of groups. */ readonly groups: Groups; /** * A collection of guides. */ readonly guides: Guides; /** * The unique ID of the MasterSpread. */ readonly id: number; /** * The IDML component name of the MasterSpread. */ idmlComponentName: string; /** * The index of the MasterSpread within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * The name of the MasterSpread. */ readonly name: string; /** * The prefix of the master spread name. */ namePrefix: string; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * The color label of the MasterSpread, specified either as an array of three * doubles, each in the range 0 to 255 and representing R, G, and B values, or * as a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator * or PageColorOptions enumerator. */ pageColor: (number[][] | PageColorOptions | UIColors)[]; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * A collection of pages. */ readonly pages: Pages; /** * The parent of the MasterSpread (a Document). */ readonly parent: Document; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * The primary text frame through which text flows on the MasterSpread. Must be * a text frame or a type on a path spline. Can also accept: NothingEnum * enumerator. */ primaryTextFrame: PageItem | NothingEnum; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * If true, displays master page items on document pages in the spread. */ showMasterItems: boolean; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicate an object and place it into the target. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param placePoint The point at which to place (Optional) * @param destinationLayer The layer on which to place (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, placePoint?: (number | string)[], destinationLayer?: Layer, showingOptions?: boolean): any[]; /** * Creates multiple guides on all pages of the spread. * @param numberOfRows The number of rows to create on each page. (Optional) * @param numberOfColumns The number of columns to create on each page. (Optional) * @param rowGutter The height of the gutter between rows. (Optional) * @param columnGutter The width of the gutter between columns. (Optional) * @param guideColor The color to make the guides, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Can accept: Array of 3 Reals (0 - 255) or UIColors enumerator. (Optional) * @param fitMargins If true, the row height and column width are calculated based on the space within the page margins. If false, row height and column width are calculated based on the full page. (Optional) * @param removeExisting If true, removes existing guides when creating new ones. (Optional) * @param layer The layer on which to create the guides. (Optional) */ createGuides(numberOfRows?: number, numberOfColumns?: number, rowGutter?: number | string, columnGutter?: number | string, guideColor?: (number[][] | UIColors)[], fitMargins?: boolean, removeExisting?: boolean, layer?: Layer): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the spread. * @param to The location of the spread relative to the reference object or within the document. (Optional) * @param reference The reference object. Note: Required only when the to parameter specifies before or after. Can accept: MasterSpread, Document or MasterSpread. (Optional) */ duplicate(to?: LocationOptions, reference?: Document | MasterSpread): any; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): MasterSpread[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Places the file. * @param fileName The file to place * @param placePoint The point at which to place (Optional) * @param destinationLayer The layer on which to place (Optional) * @param showingOptions Whether to display the import options dialog (Optional) * @param autoflowing Whether to autoflow placed text (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, placePoint?: (number | string)[], destinationLayer?: Layer, showingOptions?: boolean, autoflowing?: boolean, withProperties?: Object): any[]; /** * Deprecated: Use contentPlace method. Original Description: Create a linked * story and place it into the target. * @param parentStory The story to place and link from. * @param placePoint The point at which to place (Optional) * @param destinationLayer The layer on which to place (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ placeAndLink(parentStory: Story, placePoint?: (number | string)[], destinationLayer?: Layer, showingOptions?: boolean): Story; /** * Deletes the MasterSpread. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the MasterSpread in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Generates a string which, if executed, will return the MasterSpread. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * A collection of master spreads. */ declare class MasterSpreads { /** Returns the MasterSpread with the specified index or name. */ [index: number]: MasterSpread; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new master spread. * @param pagesPerSpread The number of pages to include in the master spread. (Optional) * @param withProperties Initial values for properties of the new MasterSpread (Optional) */ add(pagesPerSpread?: number, withProperties?: Object): MasterSpread; /** * Returns any MasterSpread in the collection. */ anyItem(): MasterSpread; /** * Displays the number of elements in the MasterSpread. */ count(): number; /** * Returns every MasterSpread in the collection. */ everyItem(): MasterSpread; /** * Returns the first MasterSpread in the collection. */ firstItem(): MasterSpread; /** * Returns the MasterSpread with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): MasterSpread; /** * Returns the MasterSpread with the specified ID. * @param id The ID. */ itemByID(id: number): MasterSpread; /** * Returns the MasterSpread with the specified name. * @param name The name. */ itemByName(name: string): MasterSpread; /** * Returns the MasterSpreads within the specified range. * @param from The MasterSpread, index, or name at the beginning of the range. Can accept: MasterSpread, Long Integer or String. * @param to The MasterSpread, index, or name at the end of the range. Can accept: MasterSpread, Long Integer or String. */ itemByRange(from: number | MasterSpread | string, to: number | MasterSpread | string): MasterSpread[]; /** * Returns the last MasterSpread in the collection. */ lastItem(): MasterSpread; /** * Returns the middle MasterSpread in the collection. */ middleItem(): MasterSpread; /** * Returns the MasterSpread whose index follows the specified MasterSpread in * the collection. * @param obj The MasterSpread whose index comes before the desired MasterSpread. */ nextItem(obj: MasterSpread): MasterSpread; /** * Returns the MasterSpread with the index previous to the specified index. * @param obj The index of the MasterSpread that follows the desired MasterSpread. */ previousItem(obj: MasterSpread): MasterSpread; /** * Generates a string which, if executed, will return the MasterSpread. */ toSource(): string; } /** * The preferences for a running header/footer (match character style) * variable. */ declare class MatchCharacterStylePreference extends Preference { /** * The character style applied to the text. Can also accept: String. */ appliedCharacterStyle: CharacterStyle | string; /** * The case of the matched text. */ changeCase: ChangeCaseOptions; /** * If true, deletes end punctuation from the matched text. */ deleteEndPunctuation: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the MatchCharacterStylePreference (a TextVariable). */ readonly parent: TextVariable; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The starting point and direction in which the search will be conducted. */ searchStrategy: SearchStrategies; /** * The text that follows the value of the variable. (Limit: 128 characters) */ textAfter: string; /** * The text that precedes the value of the variable. (Limit: 128 characters) */ textBefore: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): MatchCharacterStylePreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * MatchCharacterStylePreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * The preferences for a running header/footer (match paragraph style) * variable. */ declare class MatchParagraphStylePreference extends Preference { /** * The paragraph style applied to the text. Can also accept: String. */ appliedParagraphStyle: ParagraphStyle | string; /** * The case of the matched text. */ changeCase: ChangeCaseOptions; /** * If true, deletes end punctuation from the matched text. */ deleteEndPunctuation: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the MatchParagraphStylePreference (a TextVariable). */ readonly parent: TextVariable; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The starting point and direction in which the search will be conducted. */ searchStrategy: SearchStrategies; /** * The text that follows the value of the variable. (Limit: 128 characters) */ textAfter: string; /** * The text that precedes the value of the variable. (Limit: 128 characters) */ textBefore: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): MatchParagraphStylePreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * MatchParagraphStylePreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A math object. */ declare class MathObject { /** * The font size (in points) for Math objects */ appliedMathMLFontSize: number; /** * RGB Color applied on the math object specified in 0-255 range. */ appliedMathMLRgbColor: number[]; /** * The swatch used for math object color. Also accepts swatch name.(RGB, CMYK, * LAB and HSB swatches supported.). Can return: Swatch or NothingEnum * enumerator. Can also accept: String. */ appliedMathMLSwatch: string | Swatch | NothingEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the MathObject. */ readonly id: number; /** * The index of the MathObject within its containing object. */ readonly index: number; /** * Is the SVG Object a MathML object. */ readonly isMathMLObject: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * MathML Description of the SVG Object. Returns empty string if not a MathML * Object. */ mathmlDescription: string; /** * The name of the MathObject; this is an alias to the MathObject's label * property. */ name: string; /** * The parent of the MathObject (a Rectangle). */ readonly parent: Rectangle; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The percent of the base color. (Range: 0 to 100) * @remarks Range: 0 to 100 */ tintValue: number; /** * Dispatched after a MathObject is placed. This event bubbles. This event is * not cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a MathObject is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): MathObject[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the MathObject. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of math objects. */ declare class MathObjects { /** Returns the MathObject with the specified index or name. */ [index: number]: MathObject; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new math object. * @param mathmlDescription The MathML description to create the SVG from. (Optional) * @param mathmlDestinationPage The page on which to create the object. (Optional) * @param destinationLayer The layer on which to create the Object. Uses active document layer by default (Optional) * @param placePoint The point where to place the object (only applicable if page is provided) (Optional) * @param withProperties Initial values for properties of the new MathObject (Optional) */ add(mathmlDescription?: string, mathmlDestinationPage?: Page, destinationLayer?: Layer, placePoint?: (number | string)[], withProperties?: Object): MathObject; /** * Returns any MathObject in the collection. */ anyItem(): MathObject; /** * Displays the number of elements in the MathObject. */ count(): number; /** * Returns every MathObject in the collection. */ everyItem(): MathObject; /** * Returns the first MathObject in the collection. */ firstItem(): MathObject; /** * Returns the MathObject with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): MathObject; /** * Returns the MathObject with the specified ID. * @param id The ID. */ itemByID(id: number): MathObject; /** * Returns the MathObject with the specified name. * @param name The name. */ itemByName(name: string): MathObject; /** * Returns the MathObjects within the specified range. * @param from The MathObject, index, or name at the beginning of the range. Can accept: MathObject, Long Integer or String. * @param to The MathObject, index, or name at the end of the range. Can accept: MathObject, Long Integer or String. */ itemByRange(from: number | MathObject | string, to: number | MathObject | string): MathObject[]; /** * Returns the last MathObject in the collection. */ lastItem(): MathObject; /** * Returns the middle MathObject in the collection. */ middleItem(): MathObject; /** * Returns the MathObject whose index follows the specified MathObject in the * collection. * @param obj The MathObject whose index comes before the desired MathObject. */ nextItem(obj: MathObject): MathObject; /** * Returns the MathObject with the index previous to the specified index. * @param obj The index of the MathObject that follows the desired MathObject. */ previousItem(obj: MathObject): MathObject; /** * Generates a string which, if executed, will return the MathObject. */ toSource(): string; } /** * Matrix content. */ declare enum MatrixContent { /** * Rotation value */ ROTATION_VALUE = 1936746862, /** * Scale values */ SCALE_VALUES = 1735552887, /** * Shear value */ SHEAR_VALUE = 1936486004, /** * Translation values */ TRANSLATION_VALUES = 1936484720, } /** * A measurement entry control featuring both a pop-up menu and an entry field. */ declare class MeasurementCombobox extends Widget { /** * The default value in an editbox control. Note: Do not specify both edit * contents and edit value. If both are specified, the one that occurs later in * the script is used. */ editContents: string; /** * The measurement units to display in the measurement control. */ editUnits: MeasurementUnits; /** * The real number default value of the editbox or combobox. Note: For * measurement controls, the value is interpreted in points. The points value * is converted to edit units when the dialog opens. Note: Do not specify both * edit value and edit contents. If both are specified, the one that occurs * later in the script is used. */ editValue: number; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the MeasurementCombobox. */ readonly id: number; /** * The index of the MeasurementCombobox within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The amount to increment/decrement the value when a user selects the control * and holds down the Shift key while pressing an arrow key on the keyboard. */ largeNudge: number; /** * The maximum value that a user is allowed to type in a numeric editbox or * combobox. Note: The value for a measurement editbox or combobox is * interpreted in points, regardless of the edit units specified for the * control. The points value is converted automatically to the edit unit when * the dialog is opened. */ maximumValue: number; /** * The width of the control. For an editbox or combobox, specifies the minimum * width of the box. */ minWidth: number; /** * The minumim value that a user is allowed to type in a numeric editbox or * combobox. Note: The value for a measurement editbox or combobox is * interpreted in points, regardless of the edit units specified for the * control. The points value is converted automatically to the edit unit when * the dialog is opened. */ minimumValue: number; /** * The parent of the MeasurementCombobox (a DialogColumn, DialogRow, * EnablingGroup or BorderPanel). */ readonly parent: DialogRow | EnablingGroup | BorderPanel | DialogColumn; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The amount to increment/decrement the value when the user selects the * control and presses an arrow key on the keyboard. */ smallNudge: number; /** * The menu items on a dropdown or combobox control, as an array of strings. */ stringList: string[]; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): MeasurementCombobox[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the MeasurementCombobox. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of measurement comboboxes. */ declare class MeasurementComboboxes { /** Returns the MeasurementCombobox with the specified index or name. */ [index: number]: MeasurementCombobox; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new MeasurementCombobox. * @param withProperties Initial values for properties of the new MeasurementCombobox (Optional) */ add(withProperties?: Object): MeasurementCombobox; /** * Returns any MeasurementCombobox in the collection. */ anyItem(): MeasurementCombobox; /** * Displays the number of elements in the MeasurementCombobox. */ count(): number; /** * Returns every MeasurementCombobox in the collection. */ everyItem(): MeasurementCombobox; /** * Returns the first MeasurementCombobox in the collection. */ firstItem(): MeasurementCombobox; /** * Returns the MeasurementCombobox with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): MeasurementCombobox; /** * Returns the MeasurementCombobox with the specified ID. * @param id The ID. */ itemByID(id: number): MeasurementCombobox; /** * Returns the MeasurementComboboxes within the specified range. * @param from The MeasurementCombobox, index, or name at the beginning of the range. Can accept: MeasurementCombobox, Long Integer or String. * @param to The MeasurementCombobox, index, or name at the end of the range. Can accept: MeasurementCombobox, Long Integer or String. */ itemByRange(from: number | MeasurementCombobox | string, to: number | MeasurementCombobox | string): MeasurementCombobox[]; /** * Returns the last MeasurementCombobox in the collection. */ lastItem(): MeasurementCombobox; /** * Returns the middle MeasurementCombobox in the collection. */ middleItem(): MeasurementCombobox; /** * Returns the MeasurementCombobox whose index follows the specified * MeasurementCombobox in the collection. * @param obj The MeasurementCombobox whose index comes before the desired MeasurementCombobox. */ nextItem(obj: MeasurementCombobox): MeasurementCombobox; /** * Returns the MeasurementCombobox with the index previous to the specified * index. * @param obj The index of the MeasurementCombobox that follows the desired MeasurementCombobox. */ previousItem(obj: MeasurementCombobox): MeasurementCombobox; /** * Generates a string which, if executed, will return the MeasurementCombobox. */ toSource(): string; } /** * A measurement entry field. */ declare class MeasurementEditbox extends Widget { /** * The default value in an editbox control. Note: Do not specify both edit * contents and edit value. If both are specified, the one that occurs later in * the script is used. */ editContents: string; /** * The measurement units to display in the measurement control. */ editUnits: MeasurementUnits; /** * The real number default value of the editbox or combobox. Note: For * measurement controls, the value is interpreted in points. The points value * is converted to edit units when the dialog opens. Note: Do not specify both * edit value and edit contents. If both are specified, the one that occurs * later in the script is used. */ editValue: number; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the MeasurementEditbox. */ readonly id: number; /** * The index of the MeasurementEditbox within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The amount to increment/decrement the value when a user selects the control * and holds down the Shift key while pressing an arrow key on the keyboard. */ largeNudge: number; /** * The maximum value that a user is allowed to type in a numeric editbox or * combobox. Note: The value for a measurement editbox or combobox is * interpreted in points, regardless of the edit units specified for the * control. The points value is converted automatically to the edit unit when * the dialog is opened. */ maximumValue: number; /** * The width of the control. For an editbox or combobox, specifies the minimum * width of the box. */ minWidth: number; /** * The minumim value that a user is allowed to type in a numeric editbox or * combobox. Note: The value for a measurement editbox or combobox is * interpreted in points, regardless of the edit units specified for the * control. The points value is converted automatically to the edit unit when * the dialog is opened. */ minimumValue: number; /** * The parent of the MeasurementEditbox (a DialogColumn, DialogRow, * EnablingGroup or BorderPanel). */ readonly parent: DialogRow | EnablingGroup | BorderPanel | DialogColumn; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The amount to increment/decrement the value when the user selects the * control and presses an arrow key on the keyboard. */ smallNudge: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): MeasurementEditbox[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the MeasurementEditbox. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of measurement editboxes. */ declare class MeasurementEditboxes { /** Returns the MeasurementEditbox with the specified index or name. */ [index: number]: MeasurementEditbox; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new MeasurementEditbox. * @param withProperties Initial values for properties of the new MeasurementEditbox (Optional) */ add(withProperties?: Object): MeasurementEditbox; /** * Returns any MeasurementEditbox in the collection. */ anyItem(): MeasurementEditbox; /** * Displays the number of elements in the MeasurementEditbox. */ count(): number; /** * Returns every MeasurementEditbox in the collection. */ everyItem(): MeasurementEditbox; /** * Returns the first MeasurementEditbox in the collection. */ firstItem(): MeasurementEditbox; /** * Returns the MeasurementEditbox with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): MeasurementEditbox; /** * Returns the MeasurementEditbox with the specified ID. * @param id The ID. */ itemByID(id: number): MeasurementEditbox; /** * Returns the MeasurementEditboxes within the specified range. * @param from The MeasurementEditbox, index, or name at the beginning of the range. Can accept: MeasurementEditbox, Long Integer or String. * @param to The MeasurementEditbox, index, or name at the end of the range. Can accept: MeasurementEditbox, Long Integer or String. */ itemByRange(from: number | MeasurementEditbox | string, to: number | MeasurementEditbox | string): MeasurementEditbox[]; /** * Returns the last MeasurementEditbox in the collection. */ lastItem(): MeasurementEditbox; /** * Returns the middle MeasurementEditbox in the collection. */ middleItem(): MeasurementEditbox; /** * Returns the MeasurementEditbox whose index follows the specified * MeasurementEditbox in the collection. * @param obj The MeasurementEditbox whose index comes before the desired MeasurementEditbox. */ nextItem(obj: MeasurementEditbox): MeasurementEditbox; /** * Returns the MeasurementEditbox with the index previous to the specified * index. * @param obj The index of the MeasurementEditbox that follows the desired MeasurementEditbox. */ previousItem(obj: MeasurementEditbox): MeasurementEditbox; /** * Generates a string which, if executed, will return the MeasurementEditbox. */ toSource(): string; } /** * The unit of measurement. */ declare enum MeasurementUnits { /** * Agates */ AGATES = 2051106676, /** * American points. */ AMERICAN_POINTS = 1514238068, /** * Bai */ BAI = 2051170665, /** * Centimeters. */ CENTIMETERS = 2053336435, /** * Ciceros. */ CICEROS = 2053335395, /** * Uses points as the unit of measurement and specifies the number of points * between major tick marks on the specified ruler. For information, see * horizontal custom points and vertical custom points. */ CUSTOM = 1131639917, /** * Ha. */ HA = 1516790048, /** * Inches. */ INCHES = 2053729891, /** * Decimal inches. */ INCHES_DECIMAL = 2053729892, /** * Millimeters. */ MILLIMETERS = 2053991795, /** * Mils */ MILS = 2051893612, /** * Picas. */ PICAS = 2054187363, /** * Pixels. */ PIXELS = 2054187384, /** * Points. */ POINTS = 2054188905, /** * Q. */ Q = 2054255973, /** * U */ U = 2051691808, } /** * An sound or movie page item. */ declare class MediaItem extends PageItem { /** * Indicates whether the MediaItem has been flipped independently of its parent * object and, if yes, the direction in which the MediaItem was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the MediaItem relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the MediaItem relative to its containing object. * (Range: -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the MediaItem relative to its containing object. * (Range: -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the MediaItem relative to its containing object. */ absoluteVerticalScale: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the MediaItem. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the MediaItem. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the MediaItem. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the MediaItem. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the MediaItem. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * Transparency settings for the content of the MediaItem. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the MediaItem. */ endJoin: EndJoin; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * MediaItem. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the MediaItem's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the MediaItem. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the MediaItem excluding the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the MediaItem. (Range: * -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the MediaItem. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the MediaItem, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the MediaItem. * (Range: -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the MediaItem. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the MediaItem, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the MediaItem. */ horizontalScale: number; /** * The unique ID of the MediaItem. */ readonly id: number; /** * The index of the MediaItem within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the MediaItem is on. */ itemLayer: Layer; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the MediaItem. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the MediaItem is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * The name of the MediaItem. */ name: string; /** * If true, the MediaItem does not print. */ nonprinting: boolean; /** * If true, the MediaItem's fill color overprints any underlying objects. If * false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the MediaItem's stroke color overprints any underlying objects. If * false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the MediaItem (a Polygon, GraphicLine, Rectangle, Oval or * SplineItem). */ readonly parent: GraphicLine | Oval | Rectangle | Polygon | SplineItem; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of paths. */ readonly paths: Paths; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the MediaItem. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the MediaItem. (Range: -360 to 360) */ shearAngle: number; /** * The stroke alignment applied to the MediaItem. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the MediaItem. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the MediaItem. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the MediaItem's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the MediaItem. */ verticalScale: number; /** * If true, the MediaItem is visible. */ visible: boolean; /** * The bounds of the MediaItem including the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * Dispatched when the value of a property changes on this MediaItem. This * event bubbles. This event is not cancelable. */ static readonly AFTER_ATTRIBUTE_CHANGED: string; /** * Dispatched after a MediaItem is placed. This event bubbles. This event is * not cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a MediaItem is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the MediaItem's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the MediaItem that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the MediaItem. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the MediaItem to a different shape. * @param given The MediaItem's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new MediaItem. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new MediaItem. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new MediaItem. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new MediaItem. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new MediaItem. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the MediaItem at the specified location or offset. * @param to The location of the new MediaItem, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new MediaItem from the original MediaItem's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the MediaItem. * @param given The axis around which to flip the MediaItem. * @param around The point around which to flip the MediaItem. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): MediaItem[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the MediaItem to a new location. Note: Either the 'to' or 'by' * parameter is required; if both parameters are defined, only the to value is * used. * @param to The new location of the MediaItem,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the MediaItem relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the MediaItem. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the MediaItem in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new MediaItem (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the MediaItem. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the MediaItem using the last transformation performed on any * object. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgain(): string[]; /** * Transforms the MediaItem using the last transformation performed on any * MediaItem. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgainIndividually(): string[]; /** * Transforms the MediaItem using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the MediaItem using the last sequence of transformations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * The media items collection. */ declare class MediaItems { /** Returns the MediaItem with the specified index or name. */ [index: number]: MediaItem; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any MediaItem in the collection. */ anyItem(): MediaItem; /** * Displays the number of elements in the MediaItem. */ count(): number; /** * Returns every MediaItem in the collection. */ everyItem(): MediaItem; /** * Returns the first MediaItem in the collection. */ firstItem(): MediaItem; /** * Returns the MediaItem with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): MediaItem; /** * Returns the MediaItem with the specified ID. * @param id The ID. */ itemByID(id: number): MediaItem; /** * Returns the MediaItem with the specified name. * @param name The name. */ itemByName(name: string): MediaItem; /** * Returns the MediaItems within the specified range. * @param from The MediaItem, index, or name at the beginning of the range. Can accept: MediaItem, Long Integer or String. * @param to The MediaItem, index, or name at the end of the range. Can accept: MediaItem, Long Integer or String. */ itemByRange(from: number | MediaItem | string, to: number | MediaItem | string): MediaItem[]; /** * Returns the last MediaItem in the collection. */ lastItem(): MediaItem; /** * Returns the middle MediaItem in the collection. */ middleItem(): MediaItem; /** * Returns the MediaItem whose index follows the specified MediaItem in the * collection. * @param obj The MediaItem whose index comes before the desired MediaItem. */ nextItem(obj: MediaItem): MediaItem; /** * Returns the MediaItem with the index previous to the specified index. * @param obj The index of the MediaItem that follows the desired MediaItem. */ previousItem(obj: MediaItem): MediaItem; /** * Generates a string which, if executed, will return the MediaItem. */ toSource(): string; } /** * A menu. */ declare class Menu { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the Menu within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A collection of menu elements. */ readonly menuElements: MenuElements; /** * A collection of menu items. */ readonly menuItems: MenuItems; /** * A collection of menu separators. */ readonly menuSeparators: MenuSeparators; /** * The name of the Menu. */ readonly name: string; /** * The parent of the Menu (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of submenus. */ readonly submenus: Submenus; /** * The name of the Menu for display in the user interface. The title includes * any ampersand characters (&), which are used to tell the Windows OS to * underline the following character in the name for use with the Alt key to * navigate to a menu item. Double ampersands are used to display an actual * ampersand character in the name. The Mac OS ignores and removes the extra * ampersand characters. */ readonly title: string; /** * Dispatched before the Menu is displayed. This event does not bubble. This * event is not cancelable. */ static readonly BEFORE_DISPLAY: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Menu[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Menu. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A menu action. */ declare class MenuAction { /** * The menu action area. */ readonly area: string; /** * If true, the menu item associated with the menu action is checked. */ readonly checked: boolean; /** * If true, the MenuAction is enabled. */ readonly enabled: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the MenuAction. */ readonly id: number; /** * The index of the MenuAction within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the MenuAction. */ readonly name: string; /** * The parent of the MenuAction (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The name of the MenuAction for display in the user interface. The title * includes any ampersand characters (&), which are used to tell the Windows OS * to underline the following character in the name for use with the Alt key to * navigate to a menu item. Double ampersands are used to display an actual * ampersand character in the name. The Mac OS ignores and removes the extra * ampersand characters. */ readonly title: string; /** * Dispatched after the MenuAction is invoked. This event does not bubble. This * event is not cancelable. */ static readonly AFTER_INVOKE: string; /** * Dispatched before the MenuAction is invoked. This event does not bubble. * This event is cancelable. */ static readonly BEFORE_INVOKE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): MenuAction[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Invoke the action. */ invoke(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the MenuAction. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of menu actions. */ declare class MenuActions { /** Returns the MenuAction with the specified index or name. */ [index: number]: MenuAction; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any MenuAction in the collection. */ anyItem(): MenuAction; /** * Displays the number of elements in the MenuAction. */ count(): number; /** * Returns every MenuAction in the collection. */ everyItem(): MenuAction; /** * Returns the first MenuAction in the collection. */ firstItem(): MenuAction; /** * Returns the MenuAction with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): MenuAction; /** * Returns the MenuAction with the specified ID. * @param id The ID. */ itemByID(id: number): MenuAction; /** * Returns the MenuAction with the specified name. * @param name The name. */ itemByName(name: string): MenuAction; /** * Returns the MenuActions within the specified range. * @param from The MenuAction, index, or name at the beginning of the range. Can accept: MenuAction, Long Integer or String. * @param to The MenuAction, index, or name at the end of the range. Can accept: MenuAction, Long Integer or String. */ itemByRange(from: number | MenuAction | string, to: number | MenuAction | string): MenuAction[]; /** * Returns the last MenuAction in the collection. */ lastItem(): MenuAction; /** * Returns the middle MenuAction in the collection. */ middleItem(): MenuAction; /** * Returns the MenuAction whose index follows the specified MenuAction in the * collection. * @param obj The MenuAction whose index comes before the desired MenuAction. */ nextItem(obj: MenuAction): MenuAction; /** * Returns the MenuAction with the index previous to the specified index. * @param obj The index of the MenuAction that follows the desired MenuAction. */ previousItem(obj: MenuAction): MenuAction; /** * Generates a string which, if executed, will return the MenuAction. */ toSource(): string; } /** * A menu elements */ declare class MenuElement { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the MenuElement within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the MenuElement (a Menu or Submenu). */ readonly parent: Menu | Submenu; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): MenuElement[]; /** * Deletes the MenuElement. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the MenuElement. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of menu elements. */ declare class MenuElements { /** Returns the MenuElement with the specified index or name. */ [index: number]: MenuElement; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any MenuElement in the collection. */ anyItem(): MenuElement; /** * Displays the number of elements in the MenuElement. */ count(): number; /** * Returns every MenuElement in the collection. */ everyItem(): MenuElement; /** * Returns the first MenuElement in the collection. */ firstItem(): MenuElement; /** * Returns the MenuElement with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): MenuElement; /** * Returns the MenuElements within the specified range. * @param from The MenuElement, index, or name at the beginning of the range. Can accept: MenuElement, Long Integer or String. * @param to The MenuElement, index, or name at the end of the range. Can accept: MenuElement, Long Integer or String. */ itemByRange(from: number | MenuElement | string, to: number | MenuElement | string): MenuElement[]; /** * Returns the last MenuElement in the collection. */ lastItem(): MenuElement; /** * Returns the middle MenuElement in the collection. */ middleItem(): MenuElement; /** * Returns the MenuElement whose index follows the specified MenuElement in the * collection. * @param obj The MenuElement whose index comes before the desired MenuElement. */ nextItem(obj: MenuElement): MenuElement; /** * Returns the MenuElement with the index previous to the specified index. * @param obj The index of the MenuElement that follows the desired MenuElement. */ previousItem(obj: MenuElement): MenuElement; /** * Generates a string which, if executed, will return the MenuElement. */ toSource(): string; } /** * A menu item. */ declare class MenuItem extends MenuElement { /** * The menu action that implements the menu item. */ readonly associatedMenuAction: MenuAction; /** * If true, the menu item associated with the menu action is checked. */ readonly checked: boolean; /** * If true, the MenuItem is enabled. */ readonly enabled: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the MenuItem. */ readonly id: number; /** * The index of the MenuItem within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the MenuItem. */ readonly name: string; /** * The parent of the MenuItem (a Menu or Submenu). */ readonly parent: Menu | Submenu; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The name of the MenuItem for display in the user interface. The title * includes any ampersand characters (&), which are used to tell the Windows OS * to underline the following character in the name for use with the Alt key to * navigate to a menu item. Double ampersands are used to display an actual * ampersand character in the name. The Mac OS ignores and removes the extra * ampersand characters. */ readonly title: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): MenuItem[]; /** * Deletes the MenuItem. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Selects the MenuItem. */ select(): void; /** * Generates a string which, if executed, will return the MenuItem. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of menu items. */ declare class MenuItems { /** Returns the MenuItem with the specified index or name. */ [index: number]: MenuItem; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new menu item. * @param associatedMenuAction The menu action that implements the menu item. * @param at The location of the menu item relative to the reference object or within the containing object. (Optional) * @param reference The reference object. Note: Required when the at parameter specifies before or after. (Optional) * @param withProperties Initial values for properties of the new MenuItem (Optional) */ add(associatedMenuAction: MenuAction, at?: LocationOptions, reference?: MenuElement, withProperties?: Object): MenuItem; /** * Returns any MenuItem in the collection. */ anyItem(): MenuItem; /** * Displays the number of elements in the MenuItem. */ count(): number; /** * Returns every MenuItem in the collection. */ everyItem(): MenuItem; /** * Returns the first MenuItem in the collection. */ firstItem(): MenuItem; /** * Returns the MenuItem with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): MenuItem; /** * Returns the MenuItem with the specified ID. * @param id The ID. */ itemByID(id: number): MenuItem; /** * Returns the MenuItem with the specified name. * @param name The name. */ itemByName(name: string): MenuItem; /** * Returns the MenuItems within the specified range. * @param from The MenuItem, index, or name at the beginning of the range. Can accept: MenuItem, Long Integer or String. * @param to The MenuItem, index, or name at the end of the range. Can accept: MenuItem, Long Integer or String. */ itemByRange(from: number | MenuItem | string, to: number | MenuItem | string): MenuItem[]; /** * Returns the last MenuItem in the collection. */ lastItem(): MenuItem; /** * Returns the middle MenuItem in the collection. */ middleItem(): MenuItem; /** * Returns the MenuItem whose index follows the specified MenuItem in the * collection. * @param obj The MenuItem whose index comes before the desired MenuItem. */ nextItem(obj: MenuItem): MenuItem; /** * Returns the MenuItem with the index previous to the specified index. * @param obj The index of the MenuItem that follows the desired MenuItem. */ previousItem(obj: MenuItem): MenuItem; /** * Generates a string which, if executed, will return the MenuItem. */ toSource(): string; } /** * A menu separator. */ declare class MenuSeparator extends MenuElement { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the MenuSeparator. */ readonly id: number; /** * The index of the MenuSeparator within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the MenuSeparator (a Menu or Submenu). */ readonly parent: Menu | Submenu; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): MenuSeparator[]; /** * Deletes the MenuSeparator. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the MenuSeparator. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of menu separators. */ declare class MenuSeparators { /** Returns the MenuSeparator with the specified index or name. */ [index: number]: MenuSeparator; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new menu separator. * @param at The location of the menu separator relative to the reference object or within the containing object. (Optional) * @param reference The reference object. Note: Required when the at parameter specifies before or after. (Optional) * @param withProperties Initial values for properties of the new MenuSeparator (Optional) */ add(at?: LocationOptions, reference?: MenuElement, withProperties?: Object): MenuSeparator; /** * Returns any MenuSeparator in the collection. */ anyItem(): MenuSeparator; /** * Displays the number of elements in the MenuSeparator. */ count(): number; /** * Returns every MenuSeparator in the collection. */ everyItem(): MenuSeparator; /** * Returns the first MenuSeparator in the collection. */ firstItem(): MenuSeparator; /** * Returns the MenuSeparator with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): MenuSeparator; /** * Returns the MenuSeparator with the specified ID. * @param id The ID. */ itemByID(id: number): MenuSeparator; /** * Returns the MenuSeparators within the specified range. * @param from The MenuSeparator, index, or name at the beginning of the range. Can accept: MenuSeparator, Long Integer or String. * @param to The MenuSeparator, index, or name at the end of the range. Can accept: MenuSeparator, Long Integer or String. */ itemByRange(from: number | MenuSeparator | string, to: number | MenuSeparator | string): MenuSeparator[]; /** * Returns the last MenuSeparator in the collection. */ lastItem(): MenuSeparator; /** * Returns the middle MenuSeparator in the collection. */ middleItem(): MenuSeparator; /** * Returns the MenuSeparator whose index follows the specified MenuSeparator in * the collection. * @param obj The MenuSeparator whose index comes before the desired MenuSeparator. */ nextItem(obj: MenuSeparator): MenuSeparator; /** * Returns the MenuSeparator with the index previous to the specified index. * @param obj The index of the MenuSeparator that follows the desired MenuSeparator. */ previousItem(obj: MenuSeparator): MenuSeparator; /** * Generates a string which, if executed, will return the MenuSeparator. */ toSource(): string; } /** * A collection of menus. */ declare class Menus { /** Returns the Menu with the specified index or name. */ [index: number]: Menu; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Menu in the collection. */ anyItem(): Menu; /** * Displays the number of elements in the Menu. */ count(): number; /** * Returns every Menu in the collection. */ everyItem(): Menu; /** * Returns the first Menu in the collection. */ firstItem(): Menu; /** * Returns the Menu with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Menu; /** * Returns the Menu with the specified name. * @param name The name. */ itemByName(name: string): Menu; /** * Returns the Menus within the specified range. * @param from The Menu, index, or name at the beginning of the range. Can accept: Menu, Long Integer or String. * @param to The Menu, index, or name at the end of the range. Can accept: Menu, Long Integer or String. */ itemByRange(from: number | Menu | string, to: number | Menu | string): Menu[]; /** * Returns the last Menu in the collection. */ lastItem(): Menu; /** * Returns the middle Menu in the collection. */ middleItem(): Menu; /** * Returns the Menu whose index follows the specified Menu in the collection. * @param obj The Menu whose index comes before the desired Menu. */ nextItem(obj: Menu): Menu; /** * Returns the Menu with the index previous to the specified index. * @param obj The index of the Menu that follows the desired Menu. */ previousItem(obj: Menu): Menu; /** * Generates a string which, if executed, will return the Menu. */ toSource(): string; } /** * Metadata preferences. */ declare class MetadataPreference extends Preference { /** * The author of the document. */ author: string; /** * The URL of the file that contains the linked copyright statement. */ copyrightInfoURL: string; /** * The text to use as a copyright notice. */ copyrightNotice: string; /** * The copyright status of the document. */ copyrightStatus: CopyrightStatus; /** * The creation date of the document. */ readonly creationDate: Date; /** * The name of the application used to create the document. */ readonly creator: string; /** * The description of the MetadataPreference. */ description: string; /** * The title of the document. */ documentTitle: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The format of the document. */ readonly format: string; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The job name. */ jobName: string; /** * The list of keywords associated with the document. */ keywords: string[]; /** * The most recent modification date of the document. */ readonly modificationDate: Date; /** * The parent of the MetadataPreference (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The location of the document on the asset management server. */ readonly serverURL: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Uses metadata from the specified external file to define any undefined * metadata properties in the document. * @param from The path to the external file that contains the metadata. * @param affectAll If true, also replaces existing metadata with data from the external file. If false, does not replace existing metadata. Note: Defaults to false. (Optional) */ append(from: File, affectAll?: boolean): void; /** * Counts the number of items in the container. * @param namespace The namespace of the container. * @param path The path to the container. */ countContainer(namespace: string, path: string): number; /** * Creates an empty container. * @param namespace The namespace of the container. * @param path The path to the container. * @param index The index of the item within the container. Specified values must be 1 or greater. To append the item to the end of the index and allow the next available value to be assigned, use 0. (Optional) * @param container The container type. Note: Required when the new item is the first item added to the container. (Optional) */ createContainerItem(namespace: string, path: string, index?: number, container?: ContainerType): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): MetadataPreference[]; /** * Gets the XMP property value associated with the specified path. * @param namespace The namespace of the property. * @param path The specified path. */ getProperty(namespace: string, path: string): string; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Replaces the current metadata in the document with metadata from the * specified file. * @param using The full path to the file that contains the replacement metadata. * @param affectAll If true, treats all properties as external. Note: Defaults to false. (Optional) */ replace(using: File, affectAll?: boolean): void; /** * Saves the metadata in the document to an external file. * @param to The path to the external file. */ save(to: File): void; /** * Sets the XMP property associated with the specified path. * @param namespace The namespace of the property. * @param path The specified path(s). * @param value The value to assign to the property. Note: To remove the property, pass an empty string. */ setProperty(namespace: string, path: string, value: string): void; /** * Generates a string which, if executed, will return the MetadataPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A mixed ink swatch. */ declare class MixedInk extends Swatch { /** * The mixed ink group that a mixed ink swatch is based on. */ readonly baseColor: MixedInkGroup; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the MixedInk. */ readonly id: number; /** * The index of the MixedInk within its containing object. */ readonly index: number; /** * The component inks. */ readonly inkList: Ink[]; /** * The array of tint percentages for inks in the ink list. Note: Specify a * value for each ink. */ inkPercentages: number[]; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The color model. */ model: ColorModel; /** * The name of the MixedInk. */ name: string; /** * The parent of the MixedInk (a Application or Document). */ readonly parent: Application | Document; /** * The color group that a swatch belongs to */ readonly parentColorGroup: ColorGroup; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The color space. */ space: ColorSpace; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the MixedInk. */ duplicate(): MixedInk; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): MixedInk[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Merges the specified swatches with the swatch. * @param with_ The swatches to merge. Can accept: Array of Swatches, Swatch or String. */ merge(with_: (Swatches | Swatch | string)[]): Swatch; /** * Deletes the swatch. * @param replacingWith The swatch to apply in place of the deleted swatch. (Optional) */ remove(replacingWith?: Swatch): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the MixedInk. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A mixed ink group. */ declare class MixedInkGroup extends Swatch { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the MixedInkGroup. */ readonly id: number; /** * The index of the MixedInkGroup within its containing object. */ readonly index: number; /** * The component inks. */ readonly inkList: Ink[]; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The color model. */ model: ColorModel; /** * The name of the MixedInkGroup. */ name: string; /** * The parent of the MixedInkGroup (a Application or Document). */ readonly parent: Application | Document; /** * The color group that a swatch belongs to */ readonly parentColorGroup: ColorGroup; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the MixedInkGroup. */ duplicate(): MixedInkGroup; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): MixedInkGroup[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Merges the specified swatches with the swatch. * @param with_ The swatches to merge. Can accept: Array of Swatches, Swatch or String. */ merge(with_: (Swatches | Swatch | string)[]): Swatch; /** * Deletes the swatch. * @param replacingWith The swatch to apply in place of the deleted swatch. (Optional) */ remove(replacingWith?: Swatch): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the MixedInkGroup. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of mixed ink groups. */ declare class MixedInkGroups { /** Returns the MixedInkGroup with the specified index or name. */ [index: number]: MixedInkGroup; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new mixed ink group. * @param inkList The inks to include in the mix. * @param inkPercentages The percent of each ink in the ink list. (Range: 0 to 100 for each ink) (Optional) * @param repeatValues The number of repetitions for each ink in the ink list. (Range: 0 to 100 for each ink) (Optional) * @param incrementValues The increment percent per repetition for each ink. (Range: 0 to 100) Note: The cumulative ink percentage per ink cannot exceed 100.) (Optional) * @param withProperties Initial values for properties of the new MixedInkGroup (Optional) */ add(inkList: Ink[], inkPercentages?: number[], repeatValues?: number[], incrementValues?: number[], withProperties?: Object): MixedInkGroup; /** * Returns any MixedInkGroup in the collection. */ anyItem(): MixedInkGroup; /** * Displays the number of elements in the MixedInkGroup. */ count(): number; /** * Returns every MixedInkGroup in the collection. */ everyItem(): MixedInkGroup; /** * Returns the first MixedInkGroup in the collection. */ firstItem(): MixedInkGroup; /** * Returns the MixedInkGroup with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): MixedInkGroup; /** * Returns the MixedInkGroup with the specified ID. * @param id The ID. */ itemByID(id: number): MixedInkGroup; /** * Returns the MixedInkGroup with the specified name. * @param name The name. */ itemByName(name: string): MixedInkGroup; /** * Returns the MixedInkGroups within the specified range. * @param from The MixedInkGroup, index, or name at the beginning of the range. Can accept: MixedInkGroup, Long Integer or String. * @param to The MixedInkGroup, index, or name at the end of the range. Can accept: MixedInkGroup, Long Integer or String. */ itemByRange(from: number | MixedInkGroup | string, to: number | MixedInkGroup | string): MixedInkGroup[]; /** * Returns the last MixedInkGroup in the collection. */ lastItem(): MixedInkGroup; /** * Returns the middle MixedInkGroup in the collection. */ middleItem(): MixedInkGroup; /** * Returns the MixedInkGroup whose index follows the specified MixedInkGroup in * the collection. * @param obj The MixedInkGroup whose index comes before the desired MixedInkGroup. */ nextItem(obj: MixedInkGroup): MixedInkGroup; /** * Returns the MixedInkGroup with the index previous to the specified index. * @param obj The index of the MixedInkGroup that follows the desired MixedInkGroup. */ previousItem(obj: MixedInkGroup): MixedInkGroup; /** * Generates a string which, if executed, will return the MixedInkGroup. */ toSource(): string; } /** * A collection of mixed inks. */ declare class MixedInks { /** Returns the MixedInk with the specified index or name. */ [index: number]: MixedInk; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new mixed ink swatch. * @param inkList The inks to mix. Note: Must contain at least two process inks and one spot ink. Can accept: Array of Inks or MixedInkGroup. * @param inkPercentages The percent to use of each ink in the ink list. (Range: 0 to 100 for each ink) * @param withProperties Initial values for properties of the new MixedInk (Optional) */ add(inkList: (Inks | MixedInkGroup)[], inkPercentages: number[], withProperties?: Object): MixedInk; /** * Returns any MixedInk in the collection. */ anyItem(): MixedInk; /** * Displays the number of elements in the MixedInk. */ count(): number; /** * Returns every MixedInk in the collection. */ everyItem(): MixedInk; /** * Returns the first MixedInk in the collection. */ firstItem(): MixedInk; /** * Returns the MixedInk with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): MixedInk; /** * Returns the MixedInk with the specified ID. * @param id The ID. */ itemByID(id: number): MixedInk; /** * Returns the MixedInk with the specified name. * @param name The name. */ itemByName(name: string): MixedInk; /** * Returns the MixedInks within the specified range. * @param from The MixedInk, index, or name at the beginning of the range. Can accept: MixedInk, Long Integer or String. * @param to The MixedInk, index, or name at the end of the range. Can accept: MixedInk, Long Integer or String. */ itemByRange(from: number | MixedInk | string, to: number | MixedInk | string): MixedInk[]; /** * Returns the last MixedInk in the collection. */ lastItem(): MixedInk; /** * Returns the middle MixedInk in the collection. */ middleItem(): MixedInk; /** * Returns the MixedInk whose index follows the specified MixedInk in the * collection. * @param obj The MixedInk whose index comes before the desired MixedInk. */ nextItem(obj: MixedInk): MixedInk; /** * Returns the MixedInk with the index previous to the specified index. * @param obj The index of the MixedInk that follows the desired MixedInk. */ previousItem(obj: MixedInk): MixedInk; /** * Generates a string which, if executed, will return the MixedInk. */ toSource(): string; } /** * The mojikumi table. */ declare class MojikumiTable { /** * The existing mojikumi set on which to base the new mojikumi set. */ basedOnMojikumiSet: MojikumiTableDefaults; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the MojikumiTable. */ readonly id: number; /** * The index of the MojikumiTable within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the MojikumiTable. */ name: string; /** * The mojikumi overrides for aki. Can return: Ordered array containing * targetMojikumiClass:Short Integer, sideMojikumiClass:Short Integer, * sideIsAfterTarget:Boolean, minimum:Real, desired:Real, maximum:Real, * compressionPriority:Short Integer, akiDoesNotFloat:Boolean. */ overrideMojikumiAkiList: (any[] | boolean | number)[]; /** * The parent of the MojikumiTable (a Document or Application). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): MojikumiTable[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the MojikumiTable. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the MojikumiTable. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Mojikumi table options. */ declare enum MojikumiTableDefaults { /** * Uses full-width spacing for all characters. */ LINE_END_ALL_ONE_EM_ENUM = 1246572848, /** * Uses half-width spacing for all characters. */ LINE_END_ALL_ONE_HALF_EM_ENUM = 1246572593, /** * Uses full-width spacing for punctuation. */ LINE_END_PERIOD_ONE_EM_ENUM = 1246572852, /** * Uses line end uke no float. */ LINE_END_UKE_NO_FLOAT_ENUM = 1246572849, /** * Turns off mojikumi. */ NOTHING = 1851876449, /** * Indents lines one full space and uses no float for all characters. */ ONE_EM_INDENT_LINE_END_ALL_NO_FLOAT_ENUM = 1246572598, /** * Indents lines one full space and uses full-width spacing for all characters. */ ONE_EM_INDENT_LINE_END_ALL_ONE_EM_ENUM = 1246572597, /** * Indents lines one full space and uses half-width spacing for all characters. */ ONE_EM_INDENT_LINE_END_ALL_ONE_HALF_EM_ENUM = 1246572601, /** * Indents lines one full space and uses full-width spacing for punctuation and * for the last character in the line. */ ONE_EM_INDENT_LINE_END_PERIOD_ONE_EM_ENUM = 1246572851, /** * Indents lines one full space and uses line end uke no float. */ ONE_EM_INDENT_LINE_END_UKE_NO_FLOAT_ENUM = 1246572599, /** * Indents lines one space and uses line end uke one half space. */ ONE_EM_INDENT_LINE_END_UKE_ONE_HALF_EM_ENUM = 1246572594, /** * Uses full-witdh spacing for all characters except the last character in the * line, which uses either full- or half-width spacing. */ ONE_OR_ONE_HALF_EM_INDENT_LINE_END_ALL_ONE_EM_ENUM = 1246572596, /** * Indents lines one or one-half space and uses full-width spacing for * punctuation and for the last character in the line. */ ONE_OR_ONE_HALF_EM_INDENT_LINE_END_PERIOD_ONE_EM_ENUM = 1246572850, /** * Indents lines one half space or one full space and uses line end uke no * float. */ ONE_OR_ONE_HALF_EM_INDENT_LINE_END_UKE_NO_FLOAT_ENUM = 1246572600, /** * Indents lines one full or half space and uses line end uke one half space. */ ONE_OR_ONE_HALF_EM_INDENT_LINE_END_UKE_ONE_HALF_EM_ENUM = 1246572595, /** * Uses mojikumi tsume and aki optimized for Simplified Chinese punctuation * glyphs. */ SIMP_CHINESE_DEFAULT = 1246572854, /** * Uses mojikumi tsume and aki optimized for Traditional Chinese centered * punctuation glyphs. */ TRAD_CHINESE_DEFAULT = 1246572853, } /** * A collection of mojikumi tables. */ declare class MojikumiTables { /** Returns the MojikumiTable with the specified index or name. */ [index: number]: MojikumiTable; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new mojikumi table. * @param name The name of the new mojikumi table. * @param withProperties Initial values for properties of the new MojikumiTable (Optional) */ add(name: string, withProperties?: Object): MojikumiTable; /** * Returns any MojikumiTable in the collection. */ anyItem(): MojikumiTable; /** * Displays the number of elements in the MojikumiTable. */ count(): number; /** * Returns every MojikumiTable in the collection. */ everyItem(): MojikumiTable; /** * Returns the first MojikumiTable in the collection. */ firstItem(): MojikumiTable; /** * Returns the MojikumiTable with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): MojikumiTable; /** * Returns the MojikumiTable with the specified ID. * @param id The ID. */ itemByID(id: number): MojikumiTable; /** * Returns the MojikumiTable with the specified name. * @param name The name. */ itemByName(name: string): MojikumiTable; /** * Returns the MojikumiTables within the specified range. * @param from The MojikumiTable, index, or name at the beginning of the range. Can accept: MojikumiTable, Long Integer or String. * @param to The MojikumiTable, index, or name at the end of the range. Can accept: MojikumiTable, Long Integer or String. */ itemByRange(from: number | MojikumiTable | string, to: number | MojikumiTable | string): MojikumiTable[]; /** * Returns the last MojikumiTable in the collection. */ lastItem(): MojikumiTable; /** * Returns the middle MojikumiTable in the collection. */ middleItem(): MojikumiTable; /** * Returns the MojikumiTable whose index follows the specified MojikumiTable in * the collection. * @param obj The MojikumiTable whose index comes before the desired MojikumiTable. */ nextItem(obj: MojikumiTable): MojikumiTable; /** * Returns the MojikumiTable with the index previous to the specified index. * @param obj The index of the MojikumiTable that follows the desired MojikumiTable. */ previousItem(obj: MojikumiTable): MojikumiTable; /** * Generates a string which, if executed, will return the MojikumiTable. */ toSource(): string; } /** * Mojikumi UI preferences. */ declare class MojikumiUiPreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * If true, uses full-width spacing for all characters. */ lineEndAllOneEm: boolean; /** * If true, uses half-width spacing for all characters. */ lineEndAllOneHalfEm: boolean; /** * If true, uses full-width spacing for punctuation and for the last character * in the line. */ lineEndPeriodOneEm: boolean; /** * If true, uses line end uke no float. */ lineEndUkeNoFloat: boolean; /** * If true, indents lines one full space and uses no float for all characters. */ oneEmIndentLineEndAllNoFloat: boolean; /** * If true, indents lines one full space and uses full-width spacing for all * characters. */ oneEmIndentLineEndAllOneEm: boolean; /** * If true, indents lines one full space and uses half-width spacing for all * characters. */ oneEmIndentLineEndAllOneHalfEm: boolean; /** * If true, indents lines one space and uses full-width spacing for punctuation * and for the last character in the line. */ oneEmIndentLineEndPeriodOneEm: boolean; /** * If true, indents lines one full space and uses line end uke no float. */ oneEmIndentLineEndUkeNoFloat: boolean; /** * If true, indents lines one space and uses line end uke one half space. */ oneEmIndentLineEndUkeOneHalfEm: boolean; /** * If true, Uses full-witdh spacing for all characters except the last * character in the line, which uses either full- or half-width spacing. */ oneOrOneHalfEmIndentLineEndAllOneEm: boolean; /** * If true, indents lines one or one-half space and uses full-width spacing for * punctuation and for the last character in the line. */ oneOrOneHalfEmIndentLineEndPeriodOneEm: boolean; /** * If true, indents lines one half space or one full space and uses line end * uke no float. */ oneOrOneHalfEmIndentLineEndUkeNoFloat: boolean; /** * If true, indents lines one full or half space and uses line end uke one half * space. */ oneOrOneHalfEmIndentLineEndUkeOneHalfEm: boolean; /** * The parent of the MojikumiUiPreference (a Document or Application). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): MojikumiUiPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the MojikumiUiPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * The amount and type of compression to apply to monochrome bitmap images. */ declare enum MonoBitmapCompression { /** * Uses CCITT Group 3 compression. */ CCIT3 = 1128879155, /** * Uses CCITT Group 4 compression. */ CCIT4 = 1128879156, /** * Uses no compression. */ NONE = 1852796517, /** * Uses Run Length compression. */ RUN_LENGTH = 1919839299, /** * Uses ZIP compression. */ ZIP = 2053730371, } /** * A Motion preset Object. */ declare class MotionPreset { /** * Motion preset raw data */ contents: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the MotionPreset. */ readonly id: number; /** * The index of the MotionPreset within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the MotionPreset. */ name: string; /** * The parent of the MotionPreset (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the motion preset. * @param name The name for the duplicated motion preset. (Optional) */ duplicate(name?: string): MotionPreset; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): MotionPreset[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the MotionPreset. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Save a copy of this motion preset to a InDesign motion preset file. * @param to The Flash motion preset file to export to. */ saveACopy(to: File): void; /** * Generates a string which, if executed, will return the MotionPreset. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of Motion presets. */ declare class MotionPresets { /** Returns the MotionPreset with the specified index or name. */ [index: number]: MotionPreset; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new MotionPreset. * @param withProperties Initial values for properties of the new MotionPreset (Optional) */ add(withProperties?: Object): MotionPreset; /** * Returns any MotionPreset in the collection. */ anyItem(): MotionPreset; /** * Displays the number of elements in the MotionPreset. */ count(): number; /** * Returns every MotionPreset in the collection. */ everyItem(): MotionPreset; /** * Returns the first MotionPreset in the collection. */ firstItem(): MotionPreset; /** * Returns the MotionPreset with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): MotionPreset; /** * Returns the MotionPreset with the specified ID. * @param id The ID. */ itemByID(id: number): MotionPreset; /** * Returns the MotionPreset with the specified name. * @param name The name. */ itemByName(name: string): MotionPreset; /** * Returns the MotionPresets within the specified range. * @param from The MotionPreset, index, or name at the beginning of the range. Can accept: MotionPreset, Long Integer or String. * @param to The MotionPreset, index, or name at the end of the range. Can accept: MotionPreset, Long Integer or String. */ itemByRange(from: number | MotionPreset | string, to: number | MotionPreset | string): MotionPreset[]; /** * Returns the last MotionPreset in the collection. */ lastItem(): MotionPreset; /** * Returns the middle MotionPreset in the collection. */ middleItem(): MotionPreset; /** * Returns the MotionPreset whose index follows the specified MotionPreset in * the collection. * @param obj The MotionPreset whose index comes before the desired MotionPreset. */ nextItem(obj: MotionPreset): MotionPreset; /** * Returns the MotionPreset with the index previous to the specified index. * @param obj The index of the MotionPreset that follows the desired MotionPreset. */ previousItem(obj: MotionPreset): MotionPreset; /** * Generates a string which, if executed, will return the MotionPreset. */ toSource(): string; } /** * A movie. */ declare class Movie extends MediaItem { /** * Indicates whether the Movie has been flipped independently of its parent * object and, if yes, the direction in which the Movie was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the Movie relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the Movie relative to its containing object. (Range: * -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the Movie relative to its containing object. (Range: * -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the Movie relative to its containing object. */ absoluteVerticalScale: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the Movie. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the Movie. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the Movie. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the Movie. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the Movie. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * Transparency settings for the content of the Movie. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The video controller skin name. */ controllerSkin: string; /** * The description of the Movie. */ description: string; /** * If true, the file is embedded in the PDF. If false, the file is linked to * the PDF. Note: To embed movie files, acrobat compatibility must be acrobat 6 * or higher. */ embedInPDF: boolean; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the Movie. */ endJoin: EndJoin; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The file path (colon delimited on the Mac OS). Can also accept: File. */ filePath: string | File; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * Movie. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the Movie's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the Movie. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * If true, opens a new window to play the movie. If false, plays the movie in * the poster frame on the PDF document page. */ floatingWindow: boolean; /** * The position of the floating window that displays the movie. */ floatingWindowPosition: FloatingWindowPosition; /** * The size of the floating window that displays the movie. */ floatingWindowSize: FloatingWindowSize; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the Movie excluding the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the Movie. (Range: * -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the Movie. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the Movie, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the Movie. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the Movie. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the Movie, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the Movie. */ horizontalScale: number; /** * The unique ID of the Movie. */ readonly id: number; /** * A collection of bitmap images in any bitmap file format (including TIFF, * JPEG, or GIF). */ readonly images: Images; /** * The index of the Movie within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the Movie is on. */ itemLayer: Layer; /** * The source file of the link. */ readonly itemLink: Link; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the Movie. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the Movie is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * If true, movie loops forever. */ movieLoop: boolean; /** * The type of poster for the movie. */ moviePosterType: MoviePosterTypes; /** * The name of the Movie. */ name: string; /** * A collection of navigation points. */ readonly navigationPoints: NavigationPoints; /** * If true, the Movie does not print. */ nonprinting: boolean; /** * If true, the Movie's fill color overprints any underlying objects. If false, * the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the Movie's stroke color overprints any underlying objects. If * false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the Movie (a SplineItem, Polygon, GraphicLine, Rectangle or * Oval). */ readonly parent: GraphicLine | Polygon | Rectangle | Oval | SplineItem; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of paths. */ readonly paths: Paths; /** * If true, the movie plays automatically when a user views the page that * contains the movie poster in the PDF document. */ playOnPageTurn: boolean; /** * The poster file. */ posterFile: string; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the Movie. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the Movie. (Range: -360 to 360) */ shearAngle: number; /** * If true, displays controller skin with mouse rollover. */ showController: boolean; /** * If true, displays playback controls at the bottom of the movie display * window. */ showControls: boolean; /** * The stroke alignment applied to the Movie. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the Movie. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the Movie. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the Movie's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The URL. */ url: string; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the Movie. */ verticalScale: number; /** * If true, the Movie is visible. */ visible: boolean; /** * The bounds of the Movie including the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * Dispatched when the value of a property changes on this Movie. This event * bubbles. This event is not cancelable. */ static readonly AFTER_ATTRIBUTE_CHANGED: string; /** * Dispatched after a Movie is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a Movie is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the Movie's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the Movie that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Brings the Movie forward one level in its layer. */ bringForward(): void; /** * Brings the Movie to the front of its layer or in front of a particular item. * @param reference The reference object to bring the object in front of (must have same parent) (Optional) */ bringToFront(reference?: PageItem): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the Movie. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the Movie to a different shape. * @param given The Movie's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Movie. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Movie. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Movie. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Movie. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Movie. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the Movie. */ duplicate(): Movie; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the Movie. * @param given The axis around which to flip the Movie. * @param around The point around which to flip the Movie. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Movie[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the Movie to a new location. Note: Either the 'to' or 'by' parameter * is required; if both parameters are defined, only the to value is used. * @param to The new location of the Movie,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the Movie relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the Movie. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the Movie in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Sends the Movie back one level in its layer. */ sendBackward(): void; /** * Sends the Movie to the back of its layer or behind a particular item (must * have same parent). * @param reference The reference object to send the object behind (Optional) */ sendToBack(reference?: PageItem): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new Movie (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the Movie. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the Movie using the last transformation performed on any object. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformAgain(): string[]; /** * Transforms the Movie using the last transformation performed on any Movie. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformAgainIndividually(): string[]; /** * Transforms the Movie using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the Movie using the last sequence of transformations performed on * any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; /** * Verifies that the specified URL is valid and contains the specified movie * file. Valid only when the movie file is specified by a URL rather than a * file path. */ verifyURL(): boolean; } /** * A movie behavior object. */ declare class MovieBehavior extends Behavior { /** * The event which triggers the behavior. */ behaviorEvent: BehaviorEvents; /** * If true, the behavior is enabled. */ enableBehavior: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the MovieBehavior. */ readonly id: number; /** * The index of the MovieBehavior within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The movie page item. */ movieItem: Movie; /** * The name of the MovieBehavior. */ readonly name: string; /** * The id of the navigation point to play from. This property is ignored for * all operations other than Play From Navigation Point. */ navigationPointID: number; /** * The playback mode. */ operation: MoviePlayOperations; /** * The parent of the MovieBehavior (a Button, CheckBox, ComboBox, ListBox, * RadioButton, TextBox or SignatureField). */ readonly parent: CheckBox | ComboBox | ListBox | RadioButton | TextBox | Button | SignatureField; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): MovieBehavior[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the MovieBehavior. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the MovieBehavior. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of movie behavior objects. */ declare class MovieBehaviors { /** Returns the MovieBehavior with the specified index or name. */ [index: number]: MovieBehavior; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new MovieBehavior. * @param withProperties Initial values for properties of the new MovieBehavior (Optional) */ add(withProperties?: Object): MovieBehavior; /** * Returns any MovieBehavior in the collection. */ anyItem(): MovieBehavior; /** * Displays the number of elements in the MovieBehavior. */ count(): number; /** * Returns every MovieBehavior in the collection. */ everyItem(): MovieBehavior; /** * Returns the first MovieBehavior in the collection. */ firstItem(): MovieBehavior; /** * Returns the MovieBehavior with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): MovieBehavior; /** * Returns the MovieBehavior with the specified ID. * @param id The ID. */ itemByID(id: number): MovieBehavior; /** * Returns the MovieBehavior with the specified name. * @param name The name. */ itemByName(name: string): MovieBehavior; /** * Returns the MovieBehaviors within the specified range. * @param from The MovieBehavior, index, or name at the beginning of the range. Can accept: MovieBehavior, Long Integer or String. * @param to The MovieBehavior, index, or name at the end of the range. Can accept: MovieBehavior, Long Integer or String. */ itemByRange(from: number | MovieBehavior | string, to: number | MovieBehavior | string): MovieBehavior[]; /** * Returns the last MovieBehavior in the collection. */ lastItem(): MovieBehavior; /** * Returns the middle MovieBehavior in the collection. */ middleItem(): MovieBehavior; /** * Returns the MovieBehavior whose index follows the specified MovieBehavior in * the collection. * @param obj The MovieBehavior whose index comes before the desired MovieBehavior. */ nextItem(obj: MovieBehavior): MovieBehavior; /** * Returns the MovieBehavior with the index previous to the specified index. * @param obj The index of the MovieBehavior that follows the desired MovieBehavior. */ previousItem(obj: MovieBehavior): MovieBehavior; /** * Generates a string which, if executed, will return the MovieBehavior. */ toSource(): string; } /** * Playback options. */ declare enum MoviePlayOperations { /** * Pauses playback. */ PAUSE = 1885435251, /** * Starts playback. */ PLAY = 1886151033, /** * Starts playback from the specified navigation point. */ PLAY_FROM_NAVIGATION_POINT = 1886154358, /** * Resumes playback. */ RESUME = 1919251317, /** * Stops playback. */ STOP = 1937010544, /** * Stops all playback (SWF only). */ STOP_ALL = 1937010785, } /** * The type of graphic for the movie poster. */ declare enum MoviePosterTypes { /** * Uses an image from the movie file. */ FROM_MOVIE = 1298558310, /** * None. */ NONE = 1852796517, /** * (Read-only) Indicates whether the movie poster is not the standard, generic * image. */ PROXY_IMAGE = 1299216505, /** * Uses the generic movie poster image file. */ STANDARD = 2020623970, } /** * A collection of movies. */ declare class Movies { /** Returns the Movie with the specified index or name. */ [index: number]: Movie; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new Movie * @param layer The layer on which to create the Movie. (Optional) * @param at The location at which to insert the Movie relative to the reference object or within the container object. (Optional) * @param reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) * @param withProperties Initial values for properties of the new Movie (Optional) */ add(layer?: Layer, at?: LocationOptions, reference?: Document | Layer | MasterSpread | Page | Spread | PageItem, withProperties?: Object): Movie; /** * Returns any Movie in the collection. */ anyItem(): Movie; /** * Displays the number of elements in the Movie. */ count(): number; /** * Returns every Movie in the collection. */ everyItem(): Movie; /** * Returns the first Movie in the collection. */ firstItem(): Movie; /** * Returns the Movie with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Movie; /** * Returns the Movie with the specified ID. * @param id The ID. */ itemByID(id: number): Movie; /** * Returns the Movie with the specified name. * @param name The name. */ itemByName(name: string): Movie; /** * Returns the Movies within the specified range. * @param from The Movie, index, or name at the beginning of the range. Can accept: Movie, Long Integer or String. * @param to The Movie, index, or name at the end of the range. Can accept: Movie, Long Integer or String. */ itemByRange(from: number | Movie | string, to: number | Movie | string): Movie[]; /** * Returns the last Movie in the collection. */ lastItem(): Movie; /** * Returns the middle Movie in the collection. */ middleItem(): Movie; /** * Returns the Movie whose index follows the specified Movie in the collection. * @param obj The Movie whose index comes before the desired Movie. */ nextItem(obj: Movie): Movie; /** * Returns the Movie with the index previous to the specified index. * @param obj The index of the Movie that follows the desired Movie. */ previousItem(obj: Movie): Movie; /** * Generates a string which, if executed, will return the Movie. */ toSource(): string; } /** * A multi-state object. */ declare class MultiStateObject extends FormField { /** * Indicates whether the MultiStateObject has been flipped independently of its * parent object and, if yes, the direction in which the MultiStateObject was * flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the MultiStateObject relative to its containing * object. */ absoluteHorizontalScale: number; /** * The rotation angle of the MultiStateObject relative to its containing * object. (Range: -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the MultiStateObject relative to its containing object. * (Range: -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the MultiStateObject relative to its containing * object. */ absoluteVerticalScale: number; /** * The index of the active state in the object's states collection. */ activeStateIndex: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the MultiStateObject. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the MultiStateObject. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * Anchored object settings. */ readonly anchoredObjectSettings: AnchoredObjectSetting; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the MultiStateObject. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the MultiStateObject. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the MultiStateObject. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * Transparency settings for the content of the MultiStateObject. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The description of the MultiStateObject. */ description: string; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the MultiStateObject. */ endJoin: EndJoin; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * A collection of EPS files. */ readonly epss: EPSs; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * MultiStateObject. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the MultiStateObject's fill color. (To specify * a tint percent, use a number in the range of 0 to 100; to use the inherited * or overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the MultiStateObject. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the MultiStateObject excluding the stroke width, in the format * [y1, x1, y2, x2], which give the coordinates of the top-left and * bottom-right corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the MultiStateObject. * (Range: -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the MultiStateObject. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the MultiStateObject, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the * MultiStateObject. (Range: -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the MultiStateObject. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the MultiStateObject, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * A collection of groups. */ readonly groups: Groups; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the MultiStateObject. */ horizontalScale: number; /** * The unique ID of the MultiStateObject. */ readonly id: number; /** * A collection of bitmap images in any bitmap file format (including TIFF, * JPEG, or GIF). */ readonly images: Images; /** * The index of the MultiStateObject within its containing object. */ readonly index: number; /** * Determines if this object is initially hidden when displayed in an exported * file. */ initiallyHidden: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the MultiStateObject is on. */ itemLayer: Layer; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the MultiStateObject. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the MultiStateObject is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * The name of the MultiStateObject. */ name: string; /** * If true, the MultiStateObject does not print. */ nonprinting: boolean; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the MultiStateObject's fill color overprints any underlying * objects. If false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the MultiStateObject's stroke color overprints any underlying * objects. If false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the MultiStateObject (a Snippet, PlaceGun, FlexObject, Spread, * MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group or * Character). */ readonly parent: FlexObject | GraphicLine | Group | MasterSpread | Oval | PlaceGun | Polygon | Rectangle | SplineItem | Spread | Character | Snippet; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of paths. */ readonly paths: Paths; /** * A collection of PDF files. */ readonly pdfs: PDFs; /** * A collection of PICT graphics. */ readonly picts: PICTs; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the MultiStateObject. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the MultiStateObject. (Range: -360 to 360) */ shearAngle: number; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * A collection of states. */ readonly states: States; /** * The stroke alignment applied to the MultiStateObject. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the MultiStateObject. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the MultiStateObject. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the MultiStateObject's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the MultiStateObject. */ verticalScale: number; /** * If true, the MultiStateObject is visible. */ visible: boolean; /** * The bounds of the MultiStateObject including the stroke width, in the format * [y1, x1, y2, x2], which give the coordinates of the top-left and * bottom-right corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * A collection of WMF graphics. */ readonly wmfs: WMFs; /** * Dispatched after a MultiStateObject is placed. This event bubbles. This * event is not cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a MultiStateObject is placed. This event bubbles. This * event is cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Adds items to a specific appearance state of this object. * @param pageitems One or more page items to add as a state. */ addItemsAsState(pageitems: PageItem[]): void; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the MultiStateObject's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the MultiStateObject that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Brings the MultiStateObject forward one level in its layer. */ bringForward(): void; /** * Brings the MultiStateObject to the front of its layer or in front of a * particular item. * @param reference The reference object to bring the object in front of (must have same parent) (Optional) */ bringToFront(reference?: PageItem): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the MultiStateObject. Transformations include * rotation, scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the MultiStateObject to a different shape. * @param given The MultiStateObject's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new MultiStateObject. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new MultiStateObject. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new MultiStateObject. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new MultiStateObject. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new MultiStateObject. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the MultiStateObject at the specified location or offset. * @param to The location of the new MultiStateObject, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new MultiStateObject from the original MultiStateObject's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the MultiStateObject. * @param given The axis around which to flip the MultiStateObject. * @param around The point around which to flip the MultiStateObject. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): MultiStateObject[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the MultiStateObject to a new location. Note: Either the 'to' or 'by' * parameter is required; if both parameters are defined, only the to value is * used. * @param to The new location of the MultiStateObject,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the MultiStateObject relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Releases all the states associated with this object and then destroys the * parent object. */ releaseAsObjects(): void; /** * Deletes the MultiStateObject. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the MultiStateObject in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Sends the MultiStateObject back one level in its layer. */ sendBackward(): void; /** * Sends the MultiStateObject to the back of its layer or behind a particular * item (must have same parent). * @param reference The reference object to send the object behind (Optional) */ sendToBack(reference?: PageItem): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new MultiStateObject (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the MultiStateObject. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the MultiStateObject using the last transformation performed on * any object. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgain(): string[]; /** * Transforms the MultiStateObject using the last transformation performed on * any MultiStateObject. Transformations include moving, rotating, shearing, * scaling, and flipping. */ transformAgainIndividually(): string[]; /** * Transforms the MultiStateObject using the last sequence of transform * operations performed on any single object or performed at the same time on * any group of objects. Transformations include moving, rotating, shearing, * scaling, and flipping. */ transformSequenceAgain(): string[]; /** * Transforms the MultiStateObject using the last sequence of transformations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * A collection of multi-state objects. */ declare class MultiStateObjects { /** Returns the MultiStateObject with the specified index or name. */ [index: number]: MultiStateObject; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new MultiStateObject * @param layer The layer on which to create the MultiStateObject. (Optional) * @param at The location at which to insert the MultiStateObject relative to the reference object or within the container object. (Optional) * @param reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) * @param withProperties Initial values for properties of the new MultiStateObject (Optional) */ add(layer?: Layer, at?: LocationOptions, reference?: Document | Layer | MasterSpread | Page | Spread | PageItem, withProperties?: Object): MultiStateObject; /** * Returns any MultiStateObject in the collection. */ anyItem(): MultiStateObject; /** * Displays the number of elements in the MultiStateObject. */ count(): number; /** * Returns every MultiStateObject in the collection. */ everyItem(): MultiStateObject; /** * Returns the first MultiStateObject in the collection. */ firstItem(): MultiStateObject; /** * Returns the MultiStateObject with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): MultiStateObject; /** * Returns the MultiStateObject with the specified ID. * @param id The ID. */ itemByID(id: number): MultiStateObject; /** * Returns the MultiStateObject with the specified name. * @param name The name. */ itemByName(name: string): MultiStateObject; /** * Returns the MultiStateObjects within the specified range. * @param from The MultiStateObject, index, or name at the beginning of the range. Can accept: MultiStateObject, Long Integer or String. * @param to The MultiStateObject, index, or name at the end of the range. Can accept: MultiStateObject, Long Integer or String. */ itemByRange(from: number | MultiStateObject | string, to: number | MultiStateObject | string): MultiStateObject[]; /** * Returns the last MultiStateObject in the collection. */ lastItem(): MultiStateObject; /** * Returns the middle MultiStateObject in the collection. */ middleItem(): MultiStateObject; /** * Returns the MultiStateObject whose index follows the specified * MultiStateObject in the collection. * @param obj The MultiStateObject whose index comes before the desired MultiStateObject. */ nextItem(obj: MultiStateObject): MultiStateObject; /** * Returns the MultiStateObject with the index previous to the specified index. * @param obj The index of the MultiStateObject that follows the desired MultiStateObject. */ previousItem(obj: MultiStateObject): MultiStateObject; /** * Generates a string which, if executed, will return the MultiStateObject. */ toSource(): string; } /** * A mutation event is dispatched for attribute changes. */ declare class MutationEvent extends Event { /** * The name of the property that changed. */ readonly attributeName: string; /** * The current value of the property that changed. */ readonly attributeValue: any; /** * If true, the event supports the bubbling phase of propagation. */ readonly bubbles: boolean; /** * If true, the default behavior of the event on its target can be canceled. */ readonly cancelable: boolean; /** * The current propagation target of the event. */ readonly currentTarget: any; /** * If true, the default behavior of the event on its target has been canceled. */ readonly defaultPrevented: boolean; /** * The current propagation phase of the event. */ readonly eventPhase: EventPhases; /** * The name of the event. */ readonly eventType: string; /** * The unique ID of the MutationEvent. */ readonly id: number; /** * The index of the MutationEvent within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the MutationEvent (a Object, UIDBasedObject, CellStyleGroup, * CellStyle, TableStyleGroup, Article, ConditionSet, HiddenText, Condition, * MotionPreset, AssignedStory, Assignment, ObjectStyleGroup, ObjectStyle, * NumberingList, Snippet, Dialog, ColorGroup, Swatch, Color, Tint, Gradient, * MixedInkGroup, MixedInk, Behavior, SubmitFormBehavior, PrintFormBehavior, * ClearFormBehavior, GotoPageBehavior, GotoAnchorBehavior, SoundBehavior, * ViewZoomBehavior, GotoStateBehavior, GotoPreviousStateBehavior, * GotoNextStateBehavior, OpenFileBehavior, AnimationBehavior, * ShowHideFieldsBehavior, MovieBehavior, GotoURLBehavior, * GotoPreviousViewBehavior, GotoNextViewBehavior, GotoPreviousPageBehavior, * GotoNextPageBehavior, GotoLastPageBehavior, GotoFirstPageBehavior, * PreflightProfileRule, PreflightRuleInstance, PreflightProfile, * CrossReferenceFormat, HyperlinkURLDestination, * HyperlinkExternalPageDestination, HyperlinkPageDestination, * HyperlinkTextDestination, ParagraphDestination, HyperlinkTextSource, * CrossReferenceSource, HyperlinkPageItemSource, Bookmark, Hyperlink, * IndexSection, PageReference, CrossReference, Index, TOCStyle, * FlattenerPreset, BookContent, MenuAction, ScriptMenuAction, NamedGrid, * CompositeFontEntry, CompositeFont, CharacterStyleGroup, ParagraphStyleGroup, * TextVariableInstance, Footnote, XMLRuleProcessor, XMLTag, Note, TableStyle, * TextPath, Asset, Link, MathObject, Section, MojikumiTable, KinsokuTable, * Guide, LanguageWithVendors, Language, PageItem, HtmlItem, FlexObject, * FormField, SignatureField, TextBox, RadioButton, ListBox, ComboBox, * CheckBox, MultiStateObject, Button, MediaItem, Sound, Movie, EPSText, * SplineItem, Polygon, GraphicLine, Rectangle, Oval, Graphic, SVG, * ImportedPage, PICT, WMF, PDF, EPS, Image, Group, TextFrame, * EndnoteTextFrame, EndnoteRange, Endnote, Reply, PDFComment, MasterSpread, * TrapPreset, Ink, DocumentPreset, Page, Spread, Layer, CharacterStyle, * ParagraphStyle, Story, XmlStory, IDBasedObject, ArticleChild, ArticleMember, * DialogRow, DialogColumn, Widget, BorderPanel, MeasurementEditbox, * MeasurementCombobox, RealCombobox, AngleEditbox, PercentEditbox, * RealEditbox, PercentCombobox, AngleCombobox, EnablingGroup, IntegerCombobox, * IntegerEditbox, RadiobuttonControl, RadiobuttonGroup, CheckboxControl, * Dropdown, StaticText, TextEditbox, ColorGroupSwatch, BackgroundTask, State, * RuleDataObject, XMLItem, DTD, XMLInstruction, XMLComment, XMLElement, Table, * Cell, IdleTask, Event, ImportExportEvent, DocumentEvent, MutationEvent, * IdleEvent, PrintEvent, EventListener, StrokeStyle, StripedStrokeStyle, * DottedStrokeStyle, DashedStrokeStyle, GraphicLayer, NonIDBasedObject, * TableStyleMapping, CharStyleMapping, CellStyleMapping, ParaStyleMapping, * TimingTarget, TimingGroup, TimingList, OpacityGradientStop, * ObjectStyleExportTagMap, DataMergeQrcodePlaceholder, DataMergeField, * DataMergeImagePlaceholder, DataMergeTextPlaceholder, Panel, LibraryPanel, * PagesPanel, Window, StoryWindow, LayoutWindow, NavigationPoint, * PreflightProcess, PreflightRule, BuildingBlock, IndexingSortOption, Topic, * TOCStyleEntry, MenuElement, MenuSeparator, MenuItem, Submenu, Menu, * StyleExportTagMap, TextVariable, XMLRuleMatchData, ValidationError, * XMLExportMap, XMLImportMap, XMLAttribute, PrinterPreset, Row, Column, * Change, HttpLinkConnectionManagerObject, RootObject, Document, Application, * Book, Library, Preference, ContentPlacerObject, LinkedPageItemOption, * LinkedStoryOption, Html5ExportPreference, PublishExportPreference, * HTMLFXLExportPreference, EPubExportPreviewAppPreference, * EPubFixedLayoutExportPreference, HTMLExportPreference, EPubExportPreference, * ConditionalTextPreference, TimingSetting, AnimationSetting, * TransformAttributeOption, AlignDistributePreference, * TypeContextualUiPreference, GrabberPreference, FlexLayoutAttributeOption, * ObjectStyleContentEffectsCategorySettings, * ObjectStyleFillEffectsCategorySettings, * ObjectStyleStrokeEffectsCategorySettings, * ObjectStyleObjectEffectsCategorySettings, ChapterNumberPreference, * NumberingRestartPolicy, Bullet, DataMerge, DataMergeOption, * DataMergePreference, JPEGExportPreference, TrackChangesPreference, * NotePreference, TransformPreference, ClipboardPreference, GeneralPreference, * WatermarkPreference, ButtonPreference, PNGExportPreference, * PreflightBookOption, PreflightOption, XMLViewPreference, * GpuPerformancePreference, DisplaySetting, DisplayPerformancePreference, * IndexOptions, LinkMetadata, MetadataPreference, ExcelImportPreference, * TaggedTextImportPreference, TaggedTextExportPreference, * WordRTFImportPreference, TextExportPreference, TextImportPreference, * FindChangeContentTransparencySetting, FindChangeFillTransparencySetting, * FindChangeStrokeTransparencySetting, FindChangeTransparencySetting, * GradientFeatherSetting, FindChangeGradientFeatherSetting, * DirectionalFeatherSetting, FindChangeDirectionalFeatherSetting, * ContentTransparencySetting, SatinSetting, FindChangeSatinSetting, * BevelAndEmbossSetting, FindChangeBevelAndEmbossSetting, InnerGlowSetting, * FindChangeInnerGlowSetting, OuterGlowSetting, FindChangeOuterGlowSetting, * InnerShadowSetting, FindChangeInnerShadowSetting, FeatherSetting, * FindChangeFeatherSetting, DropShadowSetting, FindChangeDropShadowSetting, * BlendingSetting, FindChangeBlendingSetting, FillTransparencySetting, * StrokeTransparencySetting, TransparencySetting, TransparencyPreference, * FlattenerPreference, GalleyPreference, GridPrintingPreference, * CjkGridPreference, StoryGridDataInformation, LayoutGridDataInformation, * GridDataInformation, CaptionMetadataVariablePreference, * CustomTextVariablePreference, MatchParagraphStylePreference, * MatchCharacterStylePreference, FileNameVariablePreference, * DateVariablePreference, ChapterNumberVariablePreference, * PageNumberVariablePreference, FootnoteOption, BaselineFrameGridOption, * AnchoredObjectSetting, AnchoredObjectDefault, ExportForWebPreference, * XMLPreference, XMLExportPreference, XMLImportPreference, InCopyExportOption, * LinkingPreference, ChangeColorPreference, FindColorPreference, * FindChangeColorOption, ChangeTransliteratePreference, * ChangeObjectPreference, ChangeGlyphPreference, ChangeGrepPreference, * ChangeTextPreference, FindTransliteratePreference, FindObjectPreference, * FindGlyphPreference, FindGrepPreference, FindTextPreference, * FindChangeTransliterateOption, FindChangeObjectOption, * FindChangeGlyphOption, FindChangeGrepOption, FindChangeTextOption, * ColorSetting, ScriptArg, ScriptPreference, PlaceGun, AdjustLayoutPreference, * StrokeFillProxySetting, ImportedPageAttribute, EPSImportPreference, * SmartGuidePreference, AutoCorrectPreference, SpellPreference, * PolygonPreference, DictionaryPreference, FontLockingPreference, * MojikumiUiPreference, ContourOption, TextWrapPreference, * TextEditingPreference, FrameFittingOption, ObjectExportOption, * PageItemDefault, FontSyncPreference, EndnoteOption, TaggedPDFPreference, * InteractivePDFExportPreference, PDFAttribute, PDFPlacePreference, * PDFExportPreference, IMEPreference, GraphicLayerOption, * ClippingPathSettings, ImageIOPreference, ImagePreference, ToolBox, * EPSExportPreference, PrintBookletPrintPreference, PrintBookletOption, * PrintPreference, ViewPreference, PasteboardPreference, MarginPreference, * GuidePreference, GridPreference, DocumentPreference, TextDefault, * TextPreference, TextFramePreference, StoryPreference, PathPoint, Path, * GradientStop, AutoCorrectTable, UserDictionary, HyphenationException, Font, * TransformationMatrix, PDFExportPreset, NestedStyle, TabStop, Text, * InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, * Character, NestedGrepStyle or NestedLineStyle). */ // @ts-ignore Adobe widens the type inherited from Event. readonly parent: AdjustLayoutPreference | AlignDistributePreference | AnchoredObjectDefault | AnchoredObjectSetting | AngleCombobox | AngleEditbox | AnimationBehavior | AnimationSetting | Application | Article | ArticleChild | ArticleMember | Asset | AssignedStory | Assignment | AutoCorrectPreference | AutoCorrectTable | BackgroundTask | BaselineFrameGridOption | Behavior | BevelAndEmbossSetting | BlendingSetting | Book | BookContent | Bookmark | BorderPanel | BuildingBlock | Bullet | Button | ButtonPreference | CaptionMetadataVariablePreference | Cell | CellStyle | CellStyleGroup | CellStyleMapping | Change | ChangeColorPreference | ChangeGlyphPreference | ChangeGrepPreference | ChangeObjectPreference | ChangeTextPreference | ChangeTransliteratePreference | ChapterNumberPreference | ChapterNumberVariablePreference | CharStyleMapping | Character | CharacterStyle | CharacterStyleGroup | CheckBox | CheckboxControl | CjkGridPreference | ClearFormBehavior | ClipboardPreference | ClippingPathSettings | Color | ColorGroup | ColorGroupSwatch | ColorSetting | Column | ComboBox | CompositeFont | CompositeFontEntry | Condition | ConditionSet | ConditionalTextPreference | ContentPlacerObject | ContentTransparencySetting | ContourOption | CrossReference | CrossReferenceFormat | CrossReferenceSource | CustomTextVariablePreference | DTD | DashedStrokeStyle | DataMerge | DataMergeField | DataMergeImagePlaceholder | DataMergeOption | DataMergePreference | DataMergeQrcodePlaceholder | DataMergeTextPlaceholder | DateVariablePreference | Dialog | DialogColumn | DialogRow | DictionaryPreference | DirectionalFeatherSetting | DisplayPerformancePreference | DisplaySetting | Document | DocumentEvent | DocumentPreference | DocumentPreset | DottedStrokeStyle | DropShadowSetting | Dropdown | EPS | EPSExportPreference | EPSImportPreference | EPSText | EPubExportPreference | EPubExportPreviewAppPreference | EPubFixedLayoutExportPreference | EnablingGroup | Endnote | EndnoteOption | EndnoteRange | EndnoteTextFrame | Event | EventListener | ExcelImportPreference | ExportForWebPreference | FeatherSetting | FileNameVariablePreference | FillTransparencySetting | FindChangeBevelAndEmbossSetting | FindChangeBlendingSetting | FindChangeColorOption | FindChangeContentTransparencySetting | FindChangeDirectionalFeatherSetting | FindChangeDropShadowSetting | FindChangeFeatherSetting | FindChangeFillTransparencySetting | FindChangeGlyphOption | FindChangeGradientFeatherSetting | FindChangeGrepOption | FindChangeInnerGlowSetting | FindChangeInnerShadowSetting | FindChangeObjectOption | FindChangeOuterGlowSetting | FindChangeSatinSetting | FindChangeStrokeTransparencySetting | FindChangeTextOption | FindChangeTransliterateOption | FindChangeTransparencySetting | FindColorPreference | FindGlyphPreference | FindGrepPreference | FindObjectPreference | FindTextPreference | FindTransliteratePreference | FlattenerPreference | FlattenerPreset | FlexLayoutAttributeOption | FlexObject | Font | FontLockingPreference | FontSyncPreference | Footnote | FootnoteOption | FormField | FrameFittingOption | GalleyPreference | GeneralPreference | GotoAnchorBehavior | GotoFirstPageBehavior | GotoLastPageBehavior | GotoNextPageBehavior | GotoNextStateBehavior | GotoNextViewBehavior | GotoPageBehavior | GotoPreviousPageBehavior | GotoPreviousStateBehavior | GotoPreviousViewBehavior | GotoStateBehavior | GotoURLBehavior | GpuPerformancePreference | GrabberPreference | Gradient | GradientFeatherSetting | GradientStop | Graphic | GraphicLayer | GraphicLayerOption | GraphicLine | GridDataInformation | GridPreference | GridPrintingPreference | Group | Guide | GuidePreference | HTMLExportPreference | HTMLFXLExportPreference | HiddenText | Html5ExportPreference | HtmlItem | HttpLinkConnectionManagerObject | Hyperlink | HyperlinkExternalPageDestination | HyperlinkPageDestination | HyperlinkPageItemSource | HyperlinkTextDestination | HyperlinkTextSource | HyperlinkURLDestination | HyphenationException | any | IMEPreference | IdleEvent | IdleTask | Image | ImageIOPreference | ImagePreference | ImportExportEvent | ImportedPage | ImportedPageAttribute | InCopyExportOption | Index_ | IndexOptions | IndexSection | IndexingSortOption | Ink | InnerGlowSetting | InnerShadowSetting | InsertionPoint | IntegerCombobox | IntegerEditbox | InteractivePDFExportPreference | JPEGExportPreference | KinsokuTable | Language | LanguageWithVendors | Layer | LayoutGridDataInformation | LayoutWindow | Library | LibraryPanel | Line | Link | LinkMetadata | LinkedPageItemOption | LinkedStoryOption | LinkingPreference | ListBox | MarginPreference | MasterSpread | MatchCharacterStylePreference | MatchParagraphStylePreference | MathObject | MeasurementCombobox | MeasurementEditbox | MediaItem | Menu | MenuAction | MenuElement | MenuItem | MenuSeparator | MetadataPreference | MixedInk | MixedInkGroup | MojikumiTable | MojikumiUiPreference | MotionPreset | Movie | MovieBehavior | MultiStateObject | MutationEvent | NamedGrid | NavigationPoint | NestedGrepStyle | NestedStyle | Note | NotePreference | NumberingList | NumberingRestartPolicy | ObjectExportOption | ObjectStyle | ObjectStyleContentEffectsCategorySettings | ObjectStyleExportTagMap | ObjectStyleFillEffectsCategorySettings | ObjectStyleGroup | ObjectStyleObjectEffectsCategorySettings | ObjectStyleStrokeEffectsCategorySettings | OpacityGradientStop | OpenFileBehavior | OuterGlowSetting | Oval | PDF | PDFAttribute | PDFComment | PDFExportPreference | PDFExportPreset | PDFPlacePreference | PICT | PNGExportPreference | Page | PageItem | PageItemDefault | PageNumberVariablePreference | PageReference | PagesPanel | Panel | ParaStyleMapping | Paragraph | ParagraphDestination | ParagraphStyle | ParagraphStyleGroup | PasteboardPreference | Path | PathPoint | PercentCombobox | PercentEditbox | PlaceGun | Polygon | PolygonPreference | Preference | PreflightBookOption | PreflightOption | PreflightProcess | PreflightProfile | PreflightProfileRule | PreflightRule | PreflightRuleInstance | PrintBookletOption | PrintBookletPrintPreference | PrintEvent | PrintFormBehavior | PrintPreference | PrinterPreset | PublishExportPreference | RadioButton | RadiobuttonControl | RadiobuttonGroup | RealCombobox | RealEditbox | Rectangle | Reply | Row | RuleDataObject | SVG | SatinSetting | ScriptArg | ScriptMenuAction | ScriptPreference | Section | ShowHideFieldsBehavior | SignatureField | SmartGuidePreference | Snippet | Sound | SoundBehavior | SpellPreference | SplineItem | Spread | State | StaticText | Story | StoryGridDataInformation | StoryPreference | StoryWindow | StripedStrokeStyle | StrokeFillProxySetting | StrokeStyle | StrokeTransparencySetting | StyleExportTagMap | Submenu | SubmitFormBehavior | Swatch | TOCStyle | TOCStyleEntry | TabStop | Table | TableStyle | TableStyleGroup | TableStyleMapping | TaggedPDFPreference | TaggedTextExportPreference | TaggedTextImportPreference | Text | TextBox | TextColumn | TextDefault | TextEditbox | TextEditingPreference | TextExportPreference | TextFrame | TextFramePreference | TextImportPreference | TextPath | TextPreference | TextStyleRange | TextVariable | TextVariableInstance | TextWrapPreference | TimingGroup | TimingList | TimingSetting | TimingTarget | Tint | ToolBox | Topic | TrackChangesPreference | TransformAttributeOption | TransformPreference | TransformationMatrix | TransparencyPreference | TransparencySetting | TrapPreset | TypeContextualUiPreference | UserDictionary | ValidationError | ViewPreference | ViewZoomBehavior | WMF | WatermarkPreference | Widget | Window | Word | WordRTFImportPreference | XMLAttribute | XMLComment | XMLElement | XMLExportMap | XMLExportPreference | XMLImportMap | XMLImportPreference | XMLInstruction | XMLItem | XMLPreference | XMLRuleMatchData | XMLRuleProcessor | XMLTag | XMLViewPreference | XmlStory | NestedLineStyle | Object; /** * If true, propagation of the event beyond the current target has been * stopped. */ readonly propagationStopped: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The target of the event. */ readonly target: any; /** * The time the event was initialized. */ readonly timeStamp: Date; /** * Dispatched when the value of a property changes on this MutationEvent. This * event bubbles. This event is not cancelable. */ static readonly AFTER_ATTRIBUTE_CHANGED: string; /** * Resolves the object specifier, creating an array of object references. */ // @ts-ignore Adobe widens the type inherited from Event. getElements(): MutationEvent[]; /** * Cancels the default behavior of the event on its target. */ preventDefault(): void; /** * Stops propagation of the event beyond the current target. */ stopPropagation(): void; /** * Generates a string which, if executed, will return the MutationEvent. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A named grid. */ declare class NamedGrid { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Default grid properties. Note: Applies to named, layout, and frame (story) * grids. */ readonly gridData: GridDataInformation; /** * The unique ID of the NamedGrid. */ readonly id: number; /** * The index of the NamedGrid within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the NamedGrid. */ name: string; /** * The parent of the NamedGrid (a Document or Application). */ readonly parent: Application | Document; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): NamedGrid[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the NamedGrid. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the NamedGrid. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of named grids. */ declare class NamedGrids { /** Returns the NamedGrid with the specified index or name. */ [index: number]: NamedGrid; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new NamedGrid. * @param withProperties Initial values for properties of the new NamedGrid (Optional) */ add(withProperties?: Object): NamedGrid; /** * Returns any NamedGrid in the collection. */ anyItem(): NamedGrid; /** * Displays the number of elements in the NamedGrid. */ count(): number; /** * Returns every NamedGrid in the collection. */ everyItem(): NamedGrid; /** * Returns the first NamedGrid in the collection. */ firstItem(): NamedGrid; /** * Returns the NamedGrid with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): NamedGrid; /** * Returns the NamedGrid with the specified ID. * @param id The ID. */ itemByID(id: number): NamedGrid; /** * Returns the NamedGrid with the specified name. * @param name The name. */ itemByName(name: string): NamedGrid; /** * Returns the NamedGrids within the specified range. * @param from The NamedGrid, index, or name at the beginning of the range. Can accept: NamedGrid, Long Integer or String. * @param to The NamedGrid, index, or name at the end of the range. Can accept: NamedGrid, Long Integer or String. */ itemByRange(from: number | NamedGrid | string, to: number | NamedGrid | string): NamedGrid[]; /** * Returns the last NamedGrid in the collection. */ lastItem(): NamedGrid; /** * Returns the middle NamedGrid in the collection. */ middleItem(): NamedGrid; /** * Returns the NamedGrid whose index follows the specified NamedGrid in the * collection. * @param obj The NamedGrid whose index comes before the desired NamedGrid. */ nextItem(obj: NamedGrid): NamedGrid; /** * Returns the NamedGrid with the index previous to the specified index. * @param obj The index of the NamedGrid that follows the desired NamedGrid. */ previousItem(obj: NamedGrid): NamedGrid; /** * Generates a string which, if executed, will return the NamedGrid. */ toSource(): string; } /** * A XML namespace object. */ declare class Namespace { /** * The named prefix. */ readonly prefix: string; /** * The URI. */ readonly uri: string; /** * Creates a Namespace object. * @param prefix The URI prefix, specified as an existing Namespace object, QName object, or string. * @param uri The URI if the prefix is specified as a string. */ constructor(prefix: any, uri?: string); } /** * A navigation point. */ declare class NavigationPoint { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Unique internally-generated identifier (read only). */ readonly id: number; /** * The index of the NavigationPoint within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The UI display name. */ name: string; /** * The parent of the NavigationPoint (a Movie). */ readonly parent: Movie; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The time in seconds rounded up to two decimal places (e.g., 3.115 rounded to * 3.12). */ time: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): NavigationPoint[]; /** * Deletes the NavigationPoint. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the NavigationPoint. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of navigation points. */ declare class NavigationPoints { /** Returns the NavigationPoint with the specified index or name. */ [index: number]: NavigationPoint; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new NavigationPoint. * @param withProperties Initial values for properties of the new NavigationPoint (Optional) */ add(withProperties?: Object): NavigationPoint; /** * Returns any NavigationPoint in the collection. */ anyItem(): NavigationPoint; /** * Displays the number of elements in the NavigationPoint. */ count(): number; /** * Returns every NavigationPoint in the collection. */ everyItem(): NavigationPoint; /** * Returns the first NavigationPoint in the collection. */ firstItem(): NavigationPoint; /** * Returns the NavigationPoint with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): NavigationPoint; /** * Returns the NavigationPoint with the specified ID. * @param id The ID. */ itemByID(id: number): NavigationPoint; /** * Returns the NavigationPoint with the specified name. * @param name The name. */ itemByName(name: string): NavigationPoint; /** * Returns the NavigationPoints within the specified range. * @param from The NavigationPoint, index, or name at the beginning of the range. Can accept: NavigationPoint, Long Integer or String. * @param to The NavigationPoint, index, or name at the end of the range. Can accept: NavigationPoint, Long Integer or String. */ itemByRange(from: number | NavigationPoint | string, to: number | NavigationPoint | string): NavigationPoint[]; /** * Returns the last NavigationPoint in the collection. */ lastItem(): NavigationPoint; /** * Returns the middle NavigationPoint in the collection. */ middleItem(): NavigationPoint; /** * Returns the NavigationPoint whose index follows the specified * NavigationPoint in the collection. * @param obj The NavigationPoint whose index comes before the desired NavigationPoint. */ nextItem(obj: NavigationPoint): NavigationPoint; /** * Returns the NavigationPoint with the index previous to the specified index. * @param obj The index of the NavigationPoint that follows the desired NavigationPoint. */ previousItem(obj: NavigationPoint): NavigationPoint; /** * Generates a string which, if executed, will return the NavigationPoint. */ toSource(): string; } /** * A nested GREP style. */ declare class NestedGrepStyle { /** * The character style applied to the text. Can also accept: String. */ appliedCharacterStyle: CharacterStyle | string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The GREP expression used to apply automatic styling. */ grepExpression: string; /** * The index of the NestedGrepStyle within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the NestedGrepStyle (a TextDefault, Paragraph, ParagraphStyle, * Text, InsertionPoint, TextStyleRange, TextColumn, Line, Word, Character, * Story or XmlStory). */ readonly parent: Character | InsertionPoint | Line | Paragraph | ParagraphStyle | Story | Text | TextColumn | TextStyleRange | Word | TextDefault | XmlStory; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): NestedGrepStyle[]; /** * Deletes the NestedGrepStyle. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the NestedGrepStyle. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of nested GREP styles. */ declare class NestedGrepStyles { /** Returns the NestedGrepStyle with the specified index or name. */ [index: number]: NestedGrepStyle; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new NestedGrepStyle. * @param withProperties Initial values for properties of the new NestedGrepStyle (Optional) */ add(withProperties?: Object): NestedGrepStyle; /** * Returns any NestedGrepStyle in the collection. */ anyItem(): NestedGrepStyle; /** * Displays the number of elements in the NestedGrepStyle. */ count(): number; /** * Returns every NestedGrepStyle in the collection. */ everyItem(): NestedGrepStyle; /** * Returns the first NestedGrepStyle in the collection. */ firstItem(): NestedGrepStyle; /** * Returns the NestedGrepStyle with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): NestedGrepStyle; /** * Returns the NestedGrepStyles within the specified range. * @param from The NestedGrepStyle, index, or name at the beginning of the range. Can accept: NestedGrepStyle, Long Integer or String. * @param to The NestedGrepStyle, index, or name at the end of the range. Can accept: NestedGrepStyle, Long Integer or String. */ itemByRange(from: number | NestedGrepStyle | string, to: number | NestedGrepStyle | string): NestedGrepStyle[]; /** * Returns the last NestedGrepStyle in the collection. */ lastItem(): NestedGrepStyle; /** * Returns the middle NestedGrepStyle in the collection. */ middleItem(): NestedGrepStyle; /** * Returns the NestedGrepStyle whose index follows the specified * NestedGrepStyle in the collection. * @param obj The NestedGrepStyle whose index comes before the desired NestedGrepStyle. */ nextItem(obj: NestedGrepStyle): NestedGrepStyle; /** * Returns the NestedGrepStyle with the index previous to the specified index. * @param obj The index of the NestedGrepStyle that follows the desired NestedGrepStyle. */ previousItem(obj: NestedGrepStyle): NestedGrepStyle; /** * Generates a string which, if executed, will return the NestedGrepStyle. */ toSource(): string; } /** * A nested line style. */ declare class NestedLineStyle { /** * The character style applied to the text. Can also accept: String. */ appliedCharacterStyle: CharacterStyle | string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the NestedLineStyle within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The number lines to which to apply the nested style. */ lineCount: number; /** * The parent of the NestedLineStyle (a TextDefault, Paragraph, ParagraphStyle, * Text, InsertionPoint, TextStyleRange, TextColumn, Line, Word, Character, * Story or XmlStory). */ readonly parent: Character | InsertionPoint | Line | Paragraph | ParagraphStyle | Story | Text | TextColumn | TextStyleRange | Word | TextDefault | XmlStory; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The number line-style rules to back up. */ repeatLast: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): NestedLineStyle[]; /** * Deletes the NestedLineStyle. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the NestedLineStyle. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of nested line styles. */ declare class NestedLineStyles { /** Returns the NestedLineStyle with the specified index or name. */ [index: number]: NestedLineStyle; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new NestedLineStyle. * @param withProperties Initial values for properties of the new NestedLineStyle (Optional) */ add(withProperties?: Object): NestedLineStyle; /** * Returns any NestedLineStyle in the collection. */ anyItem(): NestedLineStyle; /** * Displays the number of elements in the NestedLineStyle. */ count(): number; /** * Returns every NestedLineStyle in the collection. */ everyItem(): NestedLineStyle; /** * Returns the first NestedLineStyle in the collection. */ firstItem(): NestedLineStyle; /** * Returns the NestedLineStyle with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): NestedLineStyle; /** * Returns the NestedLineStyles within the specified range. * @param from The NestedLineStyle, index, or name at the beginning of the range. Can accept: NestedLineStyle, Long Integer or String. * @param to The NestedLineStyle, index, or name at the end of the range. Can accept: NestedLineStyle, Long Integer or String. */ itemByRange(from: number | NestedLineStyle | string, to: number | NestedLineStyle | string): NestedLineStyle[]; /** * Returns the last NestedLineStyle in the collection. */ lastItem(): NestedLineStyle; /** * Returns the middle NestedLineStyle in the collection. */ middleItem(): NestedLineStyle; /** * Returns the NestedLineStyle whose index follows the specified * NestedLineStyle in the collection. * @param obj The NestedLineStyle whose index comes before the desired NestedLineStyle. */ nextItem(obj: NestedLineStyle): NestedLineStyle; /** * Returns the NestedLineStyle with the index previous to the specified index. * @param obj The index of the NestedLineStyle that follows the desired NestedLineStyle. */ previousItem(obj: NestedLineStyle): NestedLineStyle; /** * Generates a string which, if executed, will return the NestedLineStyle. */ toSource(): string; } /** * A nested style. */ declare class NestedStyle { /** * The character style applied to the text. Can also accept: String. */ appliedCharacterStyle: CharacterStyle | string; /** * The delimiting expression that indicates how deeply into the paragraph the * nested style is applied. Can return: String or NestedStyleDelimiters * enumerator. */ delimiter: string | NestedStyleDelimiters; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, the nested style is applied through the last delimiter. If false, * the nested style is applied up to the last delimiter. */ inclusive: boolean; /** * The index of the NestedStyle within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the NestedStyle (a TextDefault, Paragraph, ParagraphStyle, * Text, InsertionPoint, TextStyleRange, TextColumn, Line, Word, Character, * Story or XmlStory). */ readonly parent: Character | InsertionPoint | Line | Paragraph | ParagraphStyle | Story | Text | TextColumn | TextStyleRange | Word | TextDefault | XmlStory; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The number instances of the specified delimiter up to which, or through * which, to apply the nested style. */ repetition: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): NestedStyle[]; /** * Deletes the NestedStyle. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the NestedStyle. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Delimiter options for marking the end of the application of the nested * style. */ declare enum NestedStyleDelimiters { /** * Uses the first character or characters other than zero-width markers as the * nested style delimiter. Zero-width markers include anchors, index markers, * XML tags, and so on. */ ANY_CHARACTER = 1380541539, /** * Uses the first word or words in the paragraph as the nested style delimiter. * The first word is considered all characters preceding the first space or * white space character in the paragraph. */ ANY_WORD = 1380541559, /** * Uses the first automatic page number as the nested style delimiter. */ AUTO_PAGE_NUMBER = 1396797550, /** * Uses the first numeric character or characters as the nested style * delimiter. Note: To specify the number of digits, see repetition. */ DIGITS = 1380541540, /** * Uses the dropcap as the nested style delimiter. */ DROPCAP = 1380541507, /** * Uses the first em space as the nested style delimiter. */ EM_SPACE = 1397058899, /** * Uses the inserted end nested style here character as the nested style * delimiter. */ END_NESTED_STYLE = 1396855379, /** * Uses the first en space as the nested style delimiter. */ EN_SPACE = 1397059155, /** * Uses the first forced line break as the nested style delimiter. */ FORCED_LINE_BREAK = 1397124194, /** * Uses the first indent-to-here tab character as the nested style delimiter. * Note: Does not use the first indent-to-here tab stop. If no actual * indent-to-here tab character has been inserted in the paragraph, the nested * style is applied through the end of the paragraph. */ INDENT_HERE_TAB = 1397319796, /** * Uses the first inline graphic as the nested style delimiter. */ INLINE_GRAPHIC = 1380541545, /** * Uses the first alpha character or characters as the nested style delimiter. * Note: To specify the number of letters, see repetition. */ LETTERS = 1380541548, /** * Uses the first nonbreaking space as the nested style delimiter. */ NONBREAKING_SPACE = 1397645907, /** * Repeat */ REPEAT = 1380545132, /** * Uses the first section name marker as the nested style delimiter. */ SECTION_MARKER = 1400073805, /** * Uses the first sentence or sentences in the paragraph as the nested style * delimiter. The first sentence is considered all text preceding the first * period, question mark, or exclamation mark in the paragraph. */ SENTENCE = 1380541555, /** * Uses the first tab character as the nested style delimiter. Note: Does not * use the first tab stop. If no actual tab character has been inserted in the * paragraph, the nested style is applied through the end of the paragraph. */ TABS = 1380541556, } /** * A collection of nested styles. */ declare class NestedStyles { /** Returns the NestedStyle with the specified index or name. */ [index: number]: NestedStyle; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new NestedStyle. * @param withProperties Initial values for properties of the new NestedStyle (Optional) */ add(withProperties?: Object): NestedStyle; /** * Returns any NestedStyle in the collection. */ anyItem(): NestedStyle; /** * Displays the number of elements in the NestedStyle. */ count(): number; /** * Returns every NestedStyle in the collection. */ everyItem(): NestedStyle; /** * Returns the first NestedStyle in the collection. */ firstItem(): NestedStyle; /** * Returns the NestedStyle with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): NestedStyle; /** * Returns the NestedStyles within the specified range. * @param from The NestedStyle, index, or name at the beginning of the range. Can accept: NestedStyle, Long Integer or String. * @param to The NestedStyle, index, or name at the end of the range. Can accept: NestedStyle, Long Integer or String. */ itemByRange(from: number | NestedStyle | string, to: number | NestedStyle | string): NestedStyle[]; /** * Returns the last NestedStyle in the collection. */ lastItem(): NestedStyle; /** * Returns the middle NestedStyle in the collection. */ middleItem(): NestedStyle; /** * Returns the NestedStyle whose index follows the specified NestedStyle in the * collection. * @param obj The NestedStyle whose index comes before the desired NestedStyle. */ nextItem(obj: NestedStyle): NestedStyle; /** * Returns the NestedStyle with the index previous to the specified index. * @param obj The index of the NestedStyle that follows the desired NestedStyle. */ previousItem(obj: NestedStyle): NestedStyle; /** * Generates a string which, if executed, will return the NestedStyle. */ toSource(): string; } /** * A note in a story. */ declare class Note { /** * A collection of characters. */ readonly characters: Characters; /** * If true, the note is collapsed in galley view. */ collapsed: boolean; /** * The date and time the note was created. */ readonly creationDate: Date; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * A collection of hidden text objects. */ readonly hiddenTexts: HiddenTexts; /** * The unique ID of the Note. */ readonly id: number; /** * The index of the Note within its containing object. */ readonly index: number; /** * A collection of insertion points. */ readonly insertionPoints: InsertionPoints; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * A collection of lines. */ readonly lines: Lines; /** * The date and time the note was last modified. */ readonly modificationDate: Date; /** * The name of the Note; this is an alias to the Note's label property. */ name: string; /** * A collection of paragraphs. */ readonly paragraphs: Paragraphs; /** * The parent of the Note (a XmlStory, Story, TextFrame, EndnoteTextFrame, * InsertionPoint or Cell). */ readonly parent: EndnoteTextFrame | InsertionPoint | Story | TextFrame | Cell | XmlStory; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The insertion point before the table in the story containing the table. */ readonly storyOffset: InsertionPoint; /** * A collection of text columns. */ readonly textColumns: TextColumns; /** * A collection of text style ranges. */ readonly textStyleRanges: TextStyleRanges; /** * A collection of text variable instances. */ readonly textVariableInstances: TextVariableInstances; /** * A collection of text objects. */ readonly texts: Texts; /** * The user who made the note. */ readonly userName: string; /** * A collection of words. */ readonly words: Words; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Converts the note to story text. */ convertToText(): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Note[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Moves the note to the specified location. * @param to The new location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text or Story. (Optional) */ move(to: LocationOptions, reference?: Text | Story): Note; /** * Deletes the Note. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Note. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Note background color options. */ declare enum NoteBackgrounds { /** * Uses the galley background color. */ GALLEY_BACKGROUND_COLOR = 1699168839, /** * Uses the note color. */ USE_NOTE_COLOR = 1700020807, } /** * Note color options. */ declare enum NoteColorChoices { /** * Uses the note color. */ USE_NOTE_PREF_COLOR = 1700089923, /** * Uses the color assigned to the user. */ USE_USER_COLOR = 1700091203, } /** * Note preferences. */ declare class NotePreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, includes inline notes content when using Find/Change commands (in * Galley and Story views only). */ findAndReplaceNoteContents: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The background color for notes. */ noteBackgroundColor: NoteBackgrounds; /** * The note color, specified either as an array of three doubles, each in the * range 0 to 255 and representing R, G, and B values, or as an InCopy UI * color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator. */ noteColor: (number[][] | InCopyUIColors)[]; /** * The color to use for notes. */ noteColorChoices: NoteColorChoices; /** * The parent of the NotePreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, displays note information and some note content when the mouse * pointer hovers over a note anchor in layout view or a note bookend in galley * or story view. */ showNoteTips: boolean; /** * If true, includes inline notes content when using Spell Check (in Galley and * Story views only). */ spellCheckNotes: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): NotePreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the NotePreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of notes. */ declare class Notes { /** Returns the Note with the specified index or name. */ [index: number]: Note; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new note. * @param at The location relative to the reference object or within the containing object. (Optional) * @param reference The reference object. Note: Required when the at parameter specifies before or after. Can accept: Note or InsertionPoint. (Optional) * @param withProperties Initial values for properties of the new Note (Optional) */ add(at?: LocationOptions, reference?: Note | InsertionPoint, withProperties?: Object): Note; /** * Returns any Note in the collection. */ anyItem(): Note; /** * Displays the number of elements in the Note. */ count(): number; /** * Returns every Note in the collection. */ everyItem(): Note; /** * Returns the first Note in the collection. */ firstItem(): Note; /** * Returns the Note with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Note; /** * Returns the Note with the specified ID. * @param id The ID. */ itemByID(id: number): Note; /** * Returns the Note with the specified name. * @param name The name. */ itemByName(name: string): Note; /** * Returns the Notes within the specified range. * @param from The Note, index, or name at the beginning of the range. Can accept: Note, Long Integer or String. * @param to The Note, index, or name at the end of the range. Can accept: Note, Long Integer or String. */ itemByRange(from: number | Note | string, to: number | Note | string): Note[]; /** * Returns the last Note in the collection. */ lastItem(): Note; /** * Returns the middle Note in the collection. */ middleItem(): Note; /** * Returns the Note whose index follows the specified Note in the collection. * @param obj The Note whose index comes before the desired Note. */ nextItem(obj: Note): Note; /** * Returns the Note with the index previous to the specified index. * @param obj The index of the Note that follows the desired Note. */ previousItem(obj: Note): Note; /** * Generates a string which, if executed, will return the Note. */ toSource(): string; } /** * Nothing. */ declare enum NothingEnum { /** * Nothing */ NOTHING = 1851876449, } /** * Options for export order list. */ declare enum NumberedListExportOption { /** * convert to text. */ AS_TEXT = 1700946804, /** * map to html ordered list. */ ORDERED_LIST = 1700949359, } /** * Numbered paragraphs options. */ declare enum NumberedParagraphsOptions { /** * Excludes paragraph numbers. */ EXCLUDE_NUMBERS = 1952804469, /** * Includes the full paragraph text. */ INCLUDE_FULL_PARAGRAPH = 1953064560, /** * Includes only the paragraph number. */ INCLUDE_NUMBERS_ONLY = 1953066607, } /** * A numbered list. */ declare class NumberingList { /** * if true, numbering will continue across book documents. */ continueNumbersAcrossDocuments: boolean; /** * If true, numbering will continue across stories. */ continueNumbersAcrossStories: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the NumberingList. */ readonly id: number; /** * The index of the NumberingList within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the NumberingList. */ name: string; /** * The parent of the NumberingList (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): NumberingList[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Delete the NumberingList. * @param replacingWith The NumberingList to apply in place of this one. (Optional) */ remove(replacingWith?: NumberingList): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the NumberingList. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of numbered lists. */ declare class NumberingLists { /** Returns the NumberingList with the specified index or name. */ [index: number]: NumberingList; /** * The number of objects in the collection. */ readonly length: number; /** * Create a new list style. * @param name Name * @param continueNumbersAcrossStories If true, numbering will continue across stories. (Optional) * @param continueNumbersAcrossDocuments If true, numbering will continue across book documents. (Optional) * @param withProperties Initial values for properties of the new NumberingList (Optional) */ add(name: string, continueNumbersAcrossStories?: boolean, continueNumbersAcrossDocuments?: boolean, withProperties?: Object): NumberingList; /** * Returns any NumberingList in the collection. */ anyItem(): NumberingList; /** * Displays the number of elements in the NumberingList. */ count(): number; /** * Returns every NumberingList in the collection. */ everyItem(): NumberingList; /** * Returns the first NumberingList in the collection. */ firstItem(): NumberingList; /** * Returns the NumberingList with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): NumberingList; /** * Returns the NumberingList with the specified ID. * @param id The ID. */ itemByID(id: number): NumberingList; /** * Returns the NumberingList with the specified name. * @param name The name. */ itemByName(name: string): NumberingList; /** * Returns the NumberingLists within the specified range. * @param from The NumberingList, index, or name at the beginning of the range. Can accept: NumberingList, Long Integer or String. * @param to The NumberingList, index, or name at the end of the range. Can accept: NumberingList, Long Integer or String. */ itemByRange(from: number | NumberingList | string, to: number | NumberingList | string): NumberingList[]; /** * Returns the last NumberingList in the collection. */ lastItem(): NumberingList; /** * Returns the middle NumberingList in the collection. */ middleItem(): NumberingList; /** * Returns the NumberingList whose index follows the specified NumberingList in * the collection. * @param obj The NumberingList whose index comes before the desired NumberingList. */ nextItem(obj: NumberingList): NumberingList; /** * Returns the NumberingList with the index previous to the specified index. * @param obj The index of the NumberingList that follows the desired NumberingList. */ previousItem(obj: NumberingList): NumberingList; /** * Generates a string which, if executed, will return the NumberingList. */ toSource(): string; } /** * Numbering restart policy. */ declare class NumberingRestartPolicy extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The lower numbering level for a numbered list. */ numberingLowerLevel: number; /** * The numbering restart policy to use. */ numberingPolicy: RestartPolicy; /** * The upper numbering level for a numbered list. */ numberingUpperLevel: number; /** * The parent of the NumberingRestartPolicy (a TextDefault, ParagraphStyle, * Text, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, * Character, Story, XmlStory, FindTextPreference, ChangeTextPreference, * FindGrepPreference or ChangeGrepPreference). */ readonly parent: ChangeTextPreference | Character | FindGrepPreference | FindTextPreference | InsertionPoint | Line | Paragraph | ParagraphStyle | Story | Text | TextColumn | TextStyleRange | Word | XmlStory | ChangeGrepPreference | TextDefault; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): NumberingRestartPolicy[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * NumberingRestartPolicy. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Numbering style */ declare enum NumberingStyle { /** * Arabic */ ARABIC = 1298231906, /** * Uses Arabic Abjad */ ARABIC_ABJAD = 1296130410, /** * Uses Arabic Alif Ba Tah */ ARABIC_ALIF_BA_TAH = 1296130420, /** * Add double leading zeros. */ DOUBLE_LEADING_ZEROS = 1296329850, /** * Do not add characters. */ FORMAT_NONE = 1701733998, /** * Uses Hebrew Biblical */ HEBREW_BIBLICAL = 1296589410, /** * Uses Hebrew Non Standard */ HEBREW_NON_STANDARD = 1296589422, /** * Kanji */ KANJI = 1296788073, /** * Katakana (a, i, u, e, o...). */ KATAKANA_MODERN = 1265920877, /** * Katakana (i, ro, ha, ni...). */ KATAKANA_TRADITIONAL = 1265920884, /** * Lower letters */ LOWER_LETTERS = 1296855660, /** * Lower roman */ LOWER_ROMAN = 1297247596, /** * Add single leading zeros. */ SINGLE_LEADING_ZEROS = 1297312890, /** * Add triple leading zeros. */ TRIPLE_LEADING_ZEROS = 1297378426, /** * Upper letters */ UPPER_LETTERS = 1296855669, /** * Upper roman */ UPPER_ROMAN = 1297247605, } /** * Figure style options for OpenType fonts. */ declare enum OTFFigureStyle { /** * Use the default figure style for the font. */ DEFAULT_VALUE = 1147563124, /** * Use proportional width lining figures. */ PROPORTIONAL_LINING = 1330932848, /** * Use proportional width oldstyle figures. */ PROPORTIONAL_OLDSTYLE = 1330933619, /** * Use monspaced lining figures. */ TABULAR_LINING = 1330931316, /** * Use monospaced oldstyle figures. */ TABULAR_OLDSTYLE = 1330933620, } /** * Export options for the object */ declare class ObjectExportOption extends Preference { /** * The metadata property to use as source of actual text. Can return: Ordered * array containing namespacePrefix:String, propertyPath:String. */ actualMetadataProperty: any[] | string; /** * The source type of actual text */ actualTextSourceType: SourceType; /** * The metadata property to use as source of alternate text. Can return: * Ordered array containing namespacePrefix:String, propertyPath:String. */ altMetadataProperty: any[] | string; /** * Comma-separated left,top,right,bottom in image inner coordinates at last * successful GenAI alt sync; empty clears. */ altTextCropSyncRect: string; /** * If true, GenAI alt text generation failed for this object; the UI may show * Generate again. */ altTextGenerationError: boolean; /** * The source type of alternate text */ altTextSourceType: SourceType; /** * The tag type of page item */ applyTagType: TagType; /** * The custom actual text entered by the user */ customActualText: string; /** * The custom alternate text entered by the user */ customAltText: string; /** * If true, custom layout is enabled for object */ customLayout: boolean; /** * Custom Layout settings to be used for object */ customLayoutType: CustomLayoutTypeEnum; /** * Custom size applied to the object */ customSize: string; /** * The epub aria label as recommended by IDPF */ epubAriaLabel: string; /** * The source to use when generating the aria-label during EPUB export. */ epubAriaLabelSourceType: EpubAriaLabelSourceType; /** * The epub aria role as recommended by IDPF */ epubAriaRole: string; /** * The epub type as recommended by IDPF */ epubType: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, generates interlaced GIFs. Note: Not valid when image conversion is * JPEG. */ gifOptionsInterlaced: boolean; /** * The color palette for GIF conversion. Note: Not valid when image conversion * is JPEG. */ gifOptionsPalette: GIFOptionsPalette; /** * Alignment applied to images */ imageAlignment: ImageAlignmentType; /** * Allows user to select the image format for conversion */ imageConversionType: ImageFormat; /** * The export resolution */ imageExportResolution: ImageResolution; /** * Image page break settings to be used with objects */ imagePageBreak: ImagePageBreakType; /** * Space After applied to images * @remarks Range: 0 to 8640 */ imageSpaceAfter: number; /** * Space Before applied to images * @remarks Range: 0 to 8640 */ imageSpaceBefore: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The formatting method for converted JPEG images. Note: Not valid when image * conversion is GIF. */ jpegOptionsFormat: JPEGOptionsFormat; /** * The quality of converted JPEG images. Note: Not valid when image conversion * is GIF. */ jpegOptionsQuality: JPEGOptionsQuality; /** * The parent of the ObjectExportOption (a ObjectStyle, SplineItem, Polygon, * GraphicLine, Rectangle, Oval, Group, TextFrame or EndnoteTextFrame). */ readonly parent: GraphicLine | Group | Oval | Polygon | Rectangle | SplineItem | TextFrame | EndnoteTextFrame | ObjectStyle; /** * Preserve Appearance from Layout */ preserveAppearanceFromLayout: PreserveAppearanceFromLayoutEnum; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * size settings to be used for the object */ sizeType: SizeTypeEnum; /** * If true, image page break settings will be used in objects */ useImagePageBreak: boolean; /** * Provides the actual text for the object */ actualText(): string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Provides the alternate text for the object */ altText(): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ObjectExportOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ObjectExportOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * An object style. */ declare class ObjectStyle { /** * Anchored object settings. */ anchoredObjectSettings: AnchoredObjectSetting; /** * The paragraph style applied to the text. Can also accept: String. */ appliedParagraphStyle: ParagraphStyle | string; /** * If true, applies paragraph styles using Next Paragraph Style settings, * beginning with the Next Paragraph Style defined in the paragraph style * associated with the object style (if any). */ applyNextParagraphStyle: boolean; /** * The arrowhead alignment applied to the ObjectStyle. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The style that this style is based on. Can return: ObjectStyle or String. */ basedOn: ObjectStyle | string; /** * Baseline frame grid option settings. */ baselineFrameGridOptions: BaselineFrameGridOption; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * The content effects enabling settings. */ readonly contentEffectsEnablingSettings: ObjectStyleContentEffectsCategorySettings; /** * Transparency settings for the content of the ObjectStyle. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * Emit CSS */ emitCss: boolean; /** * If true, the object style will apply an anchored object setting. */ enableAnchoredObjectOptions: boolean; /** * If true, the object style will apply an epub tag and class. */ enableExportTagging: boolean; /** * If true, the object style will apply a fill. */ enableFill: boolean; /** * If true, enables the flex layout attributes */ enableFlexLayoutAttributes: boolean; /** * If true, the object style will apply frame fitting options. */ enableFrameFittingOptions: boolean; /** * If true, the object style will apply alt text export options. */ enableObjectExportAltTextOptions: boolean; /** * If true, the object style will apply epub export options. */ enableObjectExportEpubOptions: boolean; /** * If true, the object style will apply tagged pdf export options. */ enableObjectExportTaggedPdfOptions: boolean; /** * If true, the object style will apply a paragraph style. */ enableParagraphStyle: boolean; /** * If true, the object style will apply story options. */ enableStoryOptions: boolean; /** * If true, the object style will apply a stroke. */ enableStroke: boolean; /** * If true, the object style will apply stroke options and corner options. */ enableStrokeAndCornerOptions: boolean; /** * If true, the object style will apply auto-sizing text frame options. */ enableTextFrameAutoSizingOptions: boolean; /** * If true, the object style will apply baseline text frame options. */ enableTextFrameBaselineOptions: boolean; /** * Enable the text frame column rule options category of object style */ enableTextFrameColumnRuleOptions: boolean; /** * Enable the text frame footnote options category of object style */ enableTextFrameFootnoteOptions: boolean; /** * If true, the object style will apply general text frame options. */ enableTextFrameGeneralOptions: boolean; /** * If true, the object style will apply text wrap, contour, and non-printing * settings. */ enableTextWrapAndOthers: boolean; /** * If true, enables the Dimension and Position attributes */ enableTransformAttributes: boolean; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the ObjectStyle. */ endJoin: EndJoin; /** * The epub aria label as recommended by IDPF */ epubAriaLabel: string; /** * The source to use when generating the aria-label during EPUB export. */ epubAriaLabelSourceType: EpubAriaLabelSourceType; /** * The epub aria role as recommended by IDPF */ epubAriaRole: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * ObjectStyle. . Can also accept: String. */ fillColor: Swatch | string; /** * The fill effects enabling settings. */ readonly fillEffectsEnablingSettings: ObjectStyleFillEffectsCategorySettings; /** * The percent of tint to use in the ObjectStyle's fill color. (To specify a * tint percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the ObjectStyle. */ readonly fillTransparencySettings: FillTransparencySetting; /** * The flex layout attribute options to apply to any flex object. */ flexLayoutAttributeOptions: FlexLayoutAttributeOption; /** * The frame fitting option to apply to placed or pasted content. Can be * applied to a frame, object style, or document or to the application. */ frameFittingOptions: FrameFittingOption; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The angle of a linear gradient applied to the fill of the ObjectStyle. * (Range: -180 to 180) */ gradientFillAngle: number; /** * The angle of a linear gradient applied to the stroke of the ObjectStyle. * (Range: -180 to 180) */ gradientStrokeAngle: number; /** * The unique ID of the ObjectStyle. */ readonly id: number; /** * If true, class attribute will be generated for the style */ includeClass: boolean; /** * The index of the ObjectStyle within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * The name of the ObjectStyle. */ name: string; /** * If true, the ObjectStyle does not print. */ nonprinting: boolean; /** * The object effects enabling settings. */ readonly objectEffectsEnablingSettings: ObjectStyleObjectEffectsCategorySettings; /** * Export options for the object */ readonly objectExportOptions: ObjectExportOption; /** * A collection of object style export tag maps. */ readonly objectStyleExportTagMaps: ObjectStyleExportTagMaps; /** * If true, the ObjectStyle's fill color overprints any underlying objects. If * false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the ObjectStyle's stroke color overprints any underlying objects. * If false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * The parent of the ObjectStyle (a Document, Application or ObjectStyleGroup). */ readonly parent: Application | Document | ObjectStyleGroup; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * Story preference settings. */ storyPreferences: StoryPreference; /** * The stroke alignment applied to the ObjectStyle. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the ObjectStyle. Can also accept: String. */ strokeColor: Swatch | string; /** * The stroke effects enabling settings. */ readonly strokeEffectsEnablingSettings: ObjectStyleStrokeEffectsCategorySettings; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the ObjectStyle's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * Text frame preference settings. */ textFramePreferences: TextFramePreference; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ textWrapPreferences: TextWrapPreference; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * The layout attribute options to apply to any page item. */ transformAttributeOptions: TransformAttributeOption; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the ObjectStyle. */ duplicate(): ObjectStyle; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ObjectStyle[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Moves the ObjectStyle to the specified location. * @param to The new location relative to the reference object or within the container object. * @param reference The reference object. Note: Required when the to parameter is before or after. Can accept: ObjectStyle, ObjectStyleGroup, Document or Application. (Optional) */ move(to: LocationOptions, reference?: Document | ObjectStyle | ObjectStyleGroup | Application): ObjectStyle; /** * Deletes the style. * @param replacingWith The style to apply in place of the deleted style. (Optional) */ remove(replacingWith?: ObjectStyle): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Sets the given dimension attribute state to enabled or disabled state * @param whichAttributes Which dimension attributes do you want to enable or disable. * @param attributeState Attribute state to be set, set true to enable and false to disable the attributes */ setDimensionAttributeState(whichAttributes: DimensionAttributes, attributeState: boolean): boolean; /** * Sets the given position attribute state to enabled or disabled state * @param whichAttributes Which position attributes do you want to enable or disable. * @param attributeState Attribute state to be set, set true to enable and false to disable the attributes */ setPositionAttributeState(whichAttributes: PositionAttributes, attributeState: boolean): boolean; /** * Generates a string which, if executed, will return the ObjectStyle. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Object style content effects category settings. */ declare class ObjectStyleContentEffectsCategorySettings extends Preference { /** * If true, the object style will apply bevel emboss. */ enableBevelEmboss: boolean; /** * If true, the object style will apply directional feathering. */ enableDirectionalFeather: boolean; /** * If true, the object style will apply drop shadows. */ enableDropShadow: boolean; /** * If true, the object style will apply feathering. */ enableFeather: boolean; /** * If true, the object style will apply gradient feathering. */ enableGradientFeather: boolean; /** * If true, the object style will apply inner glow. */ enableInnerGlow: boolean; /** * If true, the object style will apply inner shadows. */ enableInnerShadow: boolean; /** * If true, the object style will apply outer glow. */ enableOuterGlow: boolean; /** * If true, the object style will apply satin. */ enableSatin: boolean; /** * If true, the object style will apply transparency settings. */ enableTransparency: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the ObjectStyleContentEffectsCategorySettings (a ObjectStyle). */ readonly parent: ObjectStyle; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ObjectStyleContentEffectsCategorySettings[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * ObjectStyleContentEffectsCategorySettings. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A mapping object that maps an object export type to an export tag. */ declare class ObjectStyleExportTagMap { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The attributes to map. */ exportAttributes: string; /** * The class to map. */ exportClass: string; /** * The tag to map. */ exportTag: string; /** * The type of export. */ readonly exportType: string; /** * The index of the ObjectStyleExportTagMap within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the ObjectStyleExportTagMap (a ObjectStyle). */ readonly parent: ObjectStyle; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ObjectStyleExportTagMap[]; /** * Deletes the ObjectStyleExportTagMap. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * ObjectStyleExportTagMap. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of object style export tag maps. */ declare class ObjectStyleExportTagMaps { /** Returns the ObjectStyleExportTagMap with the specified index or name. */ [index: number]: ObjectStyleExportTagMap; /** * The number of objects in the collection. */ readonly length: number; /** * Create a new mapping * @param exportType The type of export. * @param exportTag The tag to map. * @param exportClass The class to map. * @param exportAttributes The attributes to map. * @param withProperties Initial values for properties of the new ObjectStyleExportTagMap (Optional) */ add(exportType: string, exportTag: string, exportClass: string, exportAttributes: string, withProperties?: Object): ObjectStyleExportTagMap; /** * Returns any ObjectStyleExportTagMap in the collection. */ anyItem(): ObjectStyleExportTagMap; /** * Displays the number of elements in the ObjectStyleExportTagMap. */ count(): number; /** * Returns every ObjectStyleExportTagMap in the collection. */ everyItem(): ObjectStyleExportTagMap; /** * Returns the first ObjectStyleExportTagMap in the collection. */ firstItem(): ObjectStyleExportTagMap; /** * Returns the ObjectStyleExportTagMap with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): ObjectStyleExportTagMap; /** * Returns the ObjectStyleExportTagMaps within the specified range. * @param from The ObjectStyleExportTagMap, index, or name at the beginning of the range. Can accept: ObjectStyleExportTagMap, Long Integer or String. * @param to The ObjectStyleExportTagMap, index, or name at the end of the range. Can accept: ObjectStyleExportTagMap, Long Integer or String. */ itemByRange(from: number | ObjectStyleExportTagMap | string, to: number | ObjectStyleExportTagMap | string): ObjectStyleExportTagMap[]; /** * Returns the last ObjectStyleExportTagMap in the collection. */ lastItem(): ObjectStyleExportTagMap; /** * Returns the middle ObjectStyleExportTagMap in the collection. */ middleItem(): ObjectStyleExportTagMap; /** * Returns the ObjectStyleExportTagMap whose index follows the specified * ObjectStyleExportTagMap in the collection. * @param obj The ObjectStyleExportTagMap whose index comes before the desired ObjectStyleExportTagMap. */ nextItem(obj: ObjectStyleExportTagMap): ObjectStyleExportTagMap; /** * Returns the ObjectStyleExportTagMap with the index previous to the specified * index. * @param obj The index of the ObjectStyleExportTagMap that follows the desired ObjectStyleExportTagMap. */ previousItem(obj: ObjectStyleExportTagMap): ObjectStyleExportTagMap; /** * Generates a string which, if executed, will return the * ObjectStyleExportTagMap. */ toSource(): string; } /** * Object style fill effects category settings. */ declare class ObjectStyleFillEffectsCategorySettings extends Preference { /** * If true, the object style will apply bevel emboss. */ enableBevelEmboss: boolean; /** * If true, the object style will apply directional feathering. */ enableDirectionalFeather: boolean; /** * If true, the object style will apply drop shadows. */ enableDropShadow: boolean; /** * If true, the object style will apply feathering. */ enableFeather: boolean; /** * If true, the object style will apply gradient feathering. */ enableGradientFeather: boolean; /** * If true, the object style will apply inner glow. */ enableInnerGlow: boolean; /** * If true, the object style will apply inner shadows. */ enableInnerShadow: boolean; /** * If true, the object style will apply outer glow. */ enableOuterGlow: boolean; /** * If true, the object style will apply satin. */ enableSatin: boolean; /** * If true, the object style will apply transparency settings. */ enableTransparency: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the ObjectStyleFillEffectsCategorySettings (a ObjectStyle). */ readonly parent: ObjectStyle; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ObjectStyleFillEffectsCategorySettings[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * ObjectStyleFillEffectsCategorySettings. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * An object style group. */ declare class ObjectStyleGroup { /** * All object styles contained by the ObjectStyleGroup. */ readonly allObjectStyles: ObjectStyle[]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the ObjectStyleGroup. */ readonly id: number; /** * The index of the ObjectStyleGroup within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the ObjectStyleGroup. */ name: string; /** * A collection of object style groups. */ readonly objectStyleGroups: ObjectStyleGroups; /** * A collection of object styles. */ readonly objectStyles: ObjectStyles; /** * The parent of the ObjectStyleGroup (a Document, Application or * ObjectStyleGroup). */ readonly parent: Application | Document | ObjectStyleGroup; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the ObjectStyleGroup. */ duplicate(): ObjectStyleGroup; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ObjectStyleGroup[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Moves the ObjectStyleGroup to the specified location. * @param to The new location relative to the reference object or within the container object. * @param reference The reference object. Note: Required when the to parameter is before or after. Can accept: ObjectStyle, ObjectStyleGroup, Document or Application. (Optional) */ move(to: LocationOptions, reference?: Document | ObjectStyle | ObjectStyleGroup | Application): ObjectStyleGroup; /** * Deletes the ObjectStyleGroup. * @param replacingWith The ObjectStyleGroup to apply in place of the deleted ObjectStyleGroup. (Optional) */ remove(replacingWith?: ObjectStyle): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ObjectStyleGroup. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of object style groups. */ declare class ObjectStyleGroups { /** Returns the ObjectStyleGroup with the specified index or name. */ [index: number]: ObjectStyleGroup; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new ObjectStyleGroup. * @param withProperties Initial values for properties of the new ObjectStyleGroup (Optional) */ add(withProperties?: Object): ObjectStyleGroup; /** * Returns any ObjectStyleGroup in the collection. */ anyItem(): ObjectStyleGroup; /** * Displays the number of elements in the ObjectStyleGroup. */ count(): number; /** * Returns every ObjectStyleGroup in the collection. */ everyItem(): ObjectStyleGroup; /** * Returns the first ObjectStyleGroup in the collection. */ firstItem(): ObjectStyleGroup; /** * Returns the ObjectStyleGroup with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): ObjectStyleGroup; /** * Returns the ObjectStyleGroup with the specified ID. * @param id The ID. */ itemByID(id: number): ObjectStyleGroup; /** * Returns the ObjectStyleGroup with the specified name. * @param name The name. */ itemByName(name: string): ObjectStyleGroup; /** * Returns the ObjectStyleGroups within the specified range. * @param from The ObjectStyleGroup, index, or name at the beginning of the range. Can accept: ObjectStyleGroup, Long Integer or String. * @param to The ObjectStyleGroup, index, or name at the end of the range. Can accept: ObjectStyleGroup, Long Integer or String. */ itemByRange(from: number | ObjectStyleGroup | string, to: number | ObjectStyleGroup | string): ObjectStyleGroup[]; /** * Returns the last ObjectStyleGroup in the collection. */ lastItem(): ObjectStyleGroup; /** * Returns the middle ObjectStyleGroup in the collection. */ middleItem(): ObjectStyleGroup; /** * Returns the ObjectStyleGroup whose index follows the specified * ObjectStyleGroup in the collection. * @param obj The ObjectStyleGroup whose index comes before the desired ObjectStyleGroup. */ nextItem(obj: ObjectStyleGroup): ObjectStyleGroup; /** * Returns the ObjectStyleGroup with the index previous to the specified index. * @param obj The index of the ObjectStyleGroup that follows the desired ObjectStyleGroup. */ previousItem(obj: ObjectStyleGroup): ObjectStyleGroup; /** * Generates a string which, if executed, will return the ObjectStyleGroup. */ toSource(): string; } /** * Object style object effects category settings. */ declare class ObjectStyleObjectEffectsCategorySettings extends Preference { /** * If true, the object style will apply bevel emboss. */ enableBevelEmboss: boolean; /** * If true, the object style will apply directional feathering. */ enableDirectionalFeather: boolean; /** * If true, the object style will apply drop shadows. */ enableDropShadow: boolean; /** * If true, the object style will apply feathering. */ enableFeather: boolean; /** * If true, the object style will apply gradient feathering. */ enableGradientFeather: boolean; /** * If true, the object style will apply inner glow. */ enableInnerGlow: boolean; /** * If true, the object style will apply inner shadows. */ enableInnerShadow: boolean; /** * If true, the object style will apply outer glow. */ enableOuterGlow: boolean; /** * If true, the object style will apply satin. */ enableSatin: boolean; /** * If true, the object style will apply transparency settings. */ enableTransparency: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the ObjectStyleObjectEffectsCategorySettings (a ObjectStyle). */ readonly parent: ObjectStyle; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ObjectStyleObjectEffectsCategorySettings[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * ObjectStyleObjectEffectsCategorySettings. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Object style stroke effects category settings. */ declare class ObjectStyleStrokeEffectsCategorySettings extends Preference { /** * If true, the object style will apply bevel emboss. */ enableBevelEmboss: boolean; /** * If true, the object style will apply directional feathering. */ enableDirectionalFeather: boolean; /** * If true, the object style will apply drop shadows. */ enableDropShadow: boolean; /** * If true, the object style will apply feathering. */ enableFeather: boolean; /** * If true, the object style will apply gradient feathering. */ enableGradientFeather: boolean; /** * If true, the object style will apply inner glow. */ enableInnerGlow: boolean; /** * If true, the object style will apply inner shadows. */ enableInnerShadow: boolean; /** * If true, the object style will apply outer glow. */ enableOuterGlow: boolean; /** * If true, the object style will apply satin. */ enableSatin: boolean; /** * If true, the object style will apply transparency settings. */ enableTransparency: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the ObjectStyleStrokeEffectsCategorySettings (a ObjectStyle). */ readonly parent: ObjectStyle; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ObjectStyleStrokeEffectsCategorySettings[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * ObjectStyleStrokeEffectsCategorySettings. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of object styles. */ declare class ObjectStyles { /** Returns the ObjectStyle with the specified index or name. */ [index: number]: ObjectStyle; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new ObjectStyle. * @param withProperties Initial values for properties of the new ObjectStyle (Optional) */ add(withProperties?: Object): ObjectStyle; /** * Returns any ObjectStyle in the collection. */ anyItem(): ObjectStyle; /** * Displays the number of elements in the ObjectStyle. */ count(): number; /** * Returns every ObjectStyle in the collection. */ everyItem(): ObjectStyle; /** * Returns the first ObjectStyle in the collection. */ firstItem(): ObjectStyle; /** * Returns the ObjectStyle with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): ObjectStyle; /** * Returns the ObjectStyle with the specified ID. * @param id The ID. */ itemByID(id: number): ObjectStyle; /** * Returns the ObjectStyle with the specified name. * @param name The name. */ itemByName(name: string): ObjectStyle; /** * Returns the ObjectStyles within the specified range. * @param from The ObjectStyle, index, or name at the beginning of the range. Can accept: ObjectStyle, Long Integer or String. * @param to The ObjectStyle, index, or name at the end of the range. Can accept: ObjectStyle, Long Integer or String. */ itemByRange(from: number | ObjectStyle | string, to: number | ObjectStyle | string): ObjectStyle[]; /** * Returns the last ObjectStyle in the collection. */ lastItem(): ObjectStyle; /** * Returns the middle ObjectStyle in the collection. */ middleItem(): ObjectStyle; /** * Returns the ObjectStyle whose index follows the specified ObjectStyle in the * collection. * @param obj The ObjectStyle whose index comes before the desired ObjectStyle. */ nextItem(obj: ObjectStyle): ObjectStyle; /** * Returns the ObjectStyle with the index previous to the specified index. * @param obj The index of the ObjectStyle that follows the desired ObjectStyle. */ previousItem(obj: ObjectStyle): ObjectStyle; /** * Generates a string which, if executed, will return the ObjectStyle. */ toSource(): string; } /** * Object type options. */ declare enum ObjectTypes { /** * All frame types. */ ALL_FRAMES_TYPE = 1178682995, /** * Graphics frame. */ GRAPHIC_FRAMES_TYPE = 1179076211, /** * Text frame. */ TEXT_FRAMES_TYPE = 1179928178, /** * Unassigned frame. */ UNASSIGNED_FRAMES_TYPE = 1179993715, } /** * An opacity gradient stop. */ declare class OpacityGradientStop { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the OpacityGradientStop within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The location of the opacity gradient stop, as a percentage of the * OpacityGradientStop size. (Range: 0 to 100) * @remarks Range: 0 to 100 */ location: number; /** * The mid-point of the opacity gradient stop, as a percentage of the * OpacityGradientStop size. (Range: 13 to 87) * @remarks Range: 13 to 87 */ midpoint: number; /** * The opacity of the opacity gradient stop (as a percentage). (Range: 0 to * 100) * @remarks Range: 0 to 100 */ opacity: number; /** * The parent of the OpacityGradientStop (a GradientFeatherSetting or * FindChangeGradientFeatherSetting). */ readonly parent: FindChangeGradientFeatherSetting | GradientFeatherSetting; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): OpacityGradientStop[]; /** * Deletes the OpacityGradientStop. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the OpacityGradientStop. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of opacity gradient stops. */ declare class OpacityGradientStops { /** Returns the OpacityGradientStop with the specified index or name. */ [index: number]: OpacityGradientStop; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new OpacityGradientStop. * @param withProperties Initial values for properties of the new OpacityGradientStop (Optional) */ add(withProperties?: Object): OpacityGradientStop; /** * Returns any OpacityGradientStop in the collection. */ anyItem(): OpacityGradientStop; /** * Displays the number of elements in the OpacityGradientStop. */ count(): number; /** * Returns every OpacityGradientStop in the collection. */ everyItem(): OpacityGradientStop; /** * Returns the first OpacityGradientStop in the collection. */ firstItem(): OpacityGradientStop; /** * Returns the OpacityGradientStop with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): OpacityGradientStop; /** * Returns the OpacityGradientStops within the specified range. * @param from The OpacityGradientStop, index, or name at the beginning of the range. Can accept: OpacityGradientStop, Long Integer or String. * @param to The OpacityGradientStop, index, or name at the end of the range. Can accept: OpacityGradientStop, Long Integer or String. */ itemByRange(from: number | OpacityGradientStop | string, to: number | OpacityGradientStop | string): OpacityGradientStop[]; /** * Returns the last OpacityGradientStop in the collection. */ lastItem(): OpacityGradientStop; /** * Returns the middle OpacityGradientStop in the collection. */ middleItem(): OpacityGradientStop; /** * Returns the OpacityGradientStop whose index follows the specified * OpacityGradientStop in the collection. * @param obj The OpacityGradientStop whose index comes before the desired OpacityGradientStop. */ nextItem(obj: OpacityGradientStop): OpacityGradientStop; /** * Returns the OpacityGradientStop with the index previous to the specified * index. * @param obj The index of the OpacityGradientStop that follows the desired OpacityGradientStop. */ previousItem(obj: OpacityGradientStop): OpacityGradientStop; /** * Generates a string which, if executed, will return the OpacityGradientStop. */ toSource(): string; } /** * An open file behavior object. */ declare class OpenFileBehavior extends Behavior { /** * The event which triggers the behavior. */ behaviorEvent: BehaviorEvents; /** * If true, the behavior is enabled. */ enableBehavior: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The file path (colon delimited on the Mac OS). Can also accept: File. */ filePath: string | File; /** * The unique ID of the OpenFileBehavior. */ readonly id: number; /** * The index of the OpenFileBehavior within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the OpenFileBehavior. */ readonly name: string; /** * The parent of the OpenFileBehavior (a Button, CheckBox, ComboBox, ListBox, * RadioButton, TextBox or SignatureField). */ readonly parent: CheckBox | ComboBox | ListBox | RadioButton | TextBox | Button | SignatureField; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): OpenFileBehavior[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the OpenFileBehavior. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the OpenFileBehavior. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of open file behavior objects. */ declare class OpenFileBehaviors { /** Returns the OpenFileBehavior with the specified index or name. */ [index: number]: OpenFileBehavior; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new OpenFileBehavior. * @param withProperties Initial values for properties of the new OpenFileBehavior (Optional) */ add(withProperties?: Object): OpenFileBehavior; /** * Returns any OpenFileBehavior in the collection. */ anyItem(): OpenFileBehavior; /** * Displays the number of elements in the OpenFileBehavior. */ count(): number; /** * Returns every OpenFileBehavior in the collection. */ everyItem(): OpenFileBehavior; /** * Returns the first OpenFileBehavior in the collection. */ firstItem(): OpenFileBehavior; /** * Returns the OpenFileBehavior with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): OpenFileBehavior; /** * Returns the OpenFileBehavior with the specified ID. * @param id The ID. */ itemByID(id: number): OpenFileBehavior; /** * Returns the OpenFileBehavior with the specified name. * @param name The name. */ itemByName(name: string): OpenFileBehavior; /** * Returns the OpenFileBehaviors within the specified range. * @param from The OpenFileBehavior, index, or name at the beginning of the range. Can accept: OpenFileBehavior, Long Integer or String. * @param to The OpenFileBehavior, index, or name at the end of the range. Can accept: OpenFileBehavior, Long Integer or String. */ itemByRange(from: number | OpenFileBehavior | string, to: number | OpenFileBehavior | string): OpenFileBehavior[]; /** * Returns the last OpenFileBehavior in the collection. */ lastItem(): OpenFileBehavior; /** * Returns the middle OpenFileBehavior in the collection. */ middleItem(): OpenFileBehavior; /** * Returns the OpenFileBehavior whose index follows the specified * OpenFileBehavior in the collection. * @param obj The OpenFileBehavior whose index comes before the desired OpenFileBehavior. */ nextItem(obj: OpenFileBehavior): OpenFileBehavior; /** * Returns the OpenFileBehavior with the index previous to the specified index. * @param obj The index of the OpenFileBehavior that follows the desired OpenFileBehavior. */ previousItem(obj: OpenFileBehavior): OpenFileBehavior; /** * Generates a string which, if executed, will return the OpenFileBehavior. */ toSource(): string; } /** * Used to specify how to open a document. */ declare enum OpenOptions { /** * Default based on the file type or extension. */ DEFAULT_VALUE = 1147563124, /** * Open a copy of the document. */ OPEN_COPY = 1332757360, /** * Open the document itself. */ OPEN_ORIGINAL = 1332760434, } /** * Supported OpenType feature options. */ declare enum OpenTypeFeature { /** * Provides authentic small caps rather than scaled-down versions of the font's * regular caps. */ ALL_SMALL_CAPS_FEATURE = 1664250691, /** * Activates contextual ligatures and connecting alternates. */ CONTEXTUAL_ALTERNATES_FEATURE = 1330930497, /** * Applies the default figure style of the current font to figure glyphs. */ DEFAULT_FIGURE_STYLE_FEATURE = 1330931268, /** * In a series of two numbers separated by a slash that form a non-standard * fraction, such as 4/13, reformats the second number as a denominator. */ DENOMINATOR_FEATURE = 1884247108, /** * Allows the use of optional discretionary ligatures. */ DISCRETIONARY_LIGATURES_FEATURE = 1330930764, /** * Reformats numbers separated by a slash, such as 1/2, as fractions. Note: In * some fonts, the fractions feature reformats only standard fractions. For * information on reformatting non-standard fractions such as 4/13, see * denominator feature and numerator feature. */ FRACTIONS_FEATURE = 1330931282, /** * Justification alternate */ JUSTIFICATION_ALTERNATE = 1330932309, /** * Low. */ LOW = 1701727351, /** * In a series of two numbers separated by a slash that form a non-standard * fraction, such as 4/13, reformats the first number as a numerator. */ NUMERATOR_FEATURE = 1884247118, /** * Superscripts the alpha characters in ordinal numbers. */ ORDINAL_FEATURE = 1330933586, /** * Overlap swash */ OVERLAP_SWASH = 1330933590, /** * Gives full-height figures varying widths. */ PROPORTIONAL_LINING_FEATURE = 1330932816, /** * Gives varying-height figures varying widths. */ PROPORTIONAL_OLDSTYLE_FEATURE = 1330933587, /** * Stretched alternate */ STRETCHED_ALTERNATE = 1330934610, /** * Stylistic alternate */ STYLISTIC_ALTERNATE = 1330934612, /** * Sizes lowered glyphs correctly relative to the surrounding characters. */ SUBSCRIPT_FEATURE = 1884247106, /** * Sizes raised glyphs correctly relative to the surrounding characters. */ SUPERSCRIPT_FEATURE = 1884247123, /** * Provides regular and contextual swashes, which may include alternate caps * and end-of-word alternatives. */ SWASH_FEATURE = 1330934615, /** * Gives full-height figures fixed, equal width. */ TABULAR_LINING_FEATURE = 1330931284, /** * Gives varying-height figures fixed, equal widths. */ TABULAR_OLDSTYLE_FEATURE = 1330933588, /** * Activates alternative characters used for uppercase titles. */ TITLING_FEATURE = 1330934857, } /** * Outer glow effect settings. */ declare class OuterGlowSetting extends Preference { /** * If true, the outer glow effect is applied. */ applied: boolean; /** * The blending mode for the outer glow effect. */ blendMode: BlendMode; /** * The color applied to the outer glow, specified as a swatch (color, gradient, * tint, or mixed ink), or an array of color values. The color mode dictates * the array values: for RGB, specify three values, each in the range 0 to 255, * in the format [R,G,B]; for CMYK, specify four values, each as a percentage * and each in the range 0 to 100, in the format [C,M,Y,K]; for LAB, specify * three values in the format [L,A,B], with L in the range 0 to 100 and A and B * in the range -128 to 127. */ effectColor: Swatch; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The amount (as a percentage) of noise applied to the outer glow. (Range: 0 * to 100) * @remarks Range: 0 to 100 */ noise: number; /** * The opacity of the outer glow (as a percentage). (Range: 0 to 100) * @remarks Range: 0 to 100 */ opacity: number; /** * The parent of the OuterGlowSetting (a TransparencySetting, * StrokeTransparencySetting, FillTransparencySetting or * ContentTransparencySetting). */ readonly parent: FillTransparencySetting | StrokeTransparencySetting | ContentTransparencySetting | TransparencySetting; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The size of the outer glow. * @remarks Measurement unit — also accepts a string such as "12mm". */ size: number | string; /** * The amount of spread (as a percentage of the outer glow size). (Range: 0 to * 100) * @remarks Range: 0 to 100 */ spread: number; /** * The technique applied to the outer glow. */ technique: GlowTechnique; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): OuterGlowSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the OuterGlowSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * End join types. */ declare enum OutlineJoin { /** * Beveled end join. */ BEVEL_END_JOIN = 1651142510, /** * Miter end join. */ MITER_END_JOIN = 1835691886, /** * Rounded end join. */ ROUND_END_JOIN = 1919577966, } /** * An ellipse. */ declare class Oval extends SplineItem { /** * Indicates whether the Oval has been flipped independently of its parent * object and, if yes, the direction in which the Oval was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the Oval relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the Oval relative to its containing object. (Range: * -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the Oval relative to its containing object. (Range: * -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the Oval relative to its containing object. */ absoluteVerticalScale: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the Oval. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the Oval. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * Anchored object settings. */ readonly anchoredObjectSettings: AnchoredObjectSetting; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the Oval. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the Oval. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the Oval. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * A collection of buttons. */ readonly buttons: Buttons; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * Transparency settings for the content of the Oval. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The type of content that a frame can contain. */ contentType: ContentType; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the Oval. */ endJoin: EndJoin; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * A collection of EPS files. */ readonly epss: EPSs; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * Oval. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the Oval's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the Oval. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * A collection of form fields. */ readonly formFields: FormFields; /** * The frame fitting option to apply to placed or pasted content. Can be * applied to a frame, object style, or document or to the application. */ readonly frameFittingOptions: FrameFittingOption; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the Oval excluding the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the Oval. (Range: -180 * to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the Oval. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the Oval, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the Oval. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the Oval. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the Oval, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * A collection of groups. */ readonly groups: Groups; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the Oval. */ horizontalScale: number; /** * A collection of embedded HTML page items. */ readonly htmlItems: HtmlItems; /** * The unique ID of the Oval. */ readonly id: number; /** * A collection of bitmap images in any bitmap file format (including TIFF, * JPEG, or GIF). */ readonly images: Images; /** * Imported InDesign pages. */ readonly importedPages: ImportedPages; /** * Export options for InCopy INCX document format. */ readonly incopyExportOptions: InCopyExportOption; /** * The index of the Oval within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the Oval is on. */ itemLayer: Layer; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * Display performance options for the Oval. */ localDisplaySetting: DisplaySettingOptions; /** * The lock state. */ readonly lockState: LockStateValues; /** * If true, the Oval is locked. */ locked: boolean; /** * The media items collection. */ readonly mediaItems: MediaItems; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * A collection of movies. */ readonly movies: Movies; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * The name of the Oval. */ name: string; /** * If true, the Oval does not print. */ nonprinting: boolean; /** * Export options for the object */ readonly objectExportOptions: ObjectExportOption; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the Oval's fill color overprints any underlying objects. If false, * the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the Oval's stroke color overprints any underlying objects. If * false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the Oval (a Snippet, ComboBox, ListBox, TextBox, * SignatureField, Spread, MasterSpread, SplineItem, Polygon, GraphicLine, * Rectangle, Oval, Group, State, Cell, Character, PlaceGun or FlexObject). */ readonly parent: Cell | Character | ComboBox | GraphicLine | Group | ListBox | MasterSpread | Oval | PlaceGun | Polygon | Rectangle | SignatureField | SplineItem | Spread | State | TextBox | FlexObject | Snippet; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of paths. */ readonly paths: Paths; /** * A collection of PDF files. */ readonly pdfs: PDFs; /** * A collection of PICT graphics. */ readonly picts: PICTs; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the Oval. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the Oval. (Range: -360 to 360) */ shearAngle: number; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * A collection of sound clips. */ readonly sounds: Sounds; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * Title for this InCopy story. */ storyTitle: string; /** * The stroke alignment applied to the Oval. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the Oval. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the Oval. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the Oval's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * A collection of text paths. */ readonly textPaths: TextPaths; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the Oval. */ verticalScale: number; /** * If true, the Oval is visible. */ visible: boolean; /** * The bounds of the Oval including the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * A collection of WMF graphics. */ readonly wmfs: WMFs; /** * Dispatched after a Oval is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a Oval is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Creates a new page item by combining the Oval with other objects. Deletes * the objects if they do not intersect. * @param with_ The object(s) to add. */ addPath(with_: PageItem[]): PageItem; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the Oval's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the Oval that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Brings the Oval forward one level in its layer. */ bringForward(): void; /** * Brings the Oval to the front of its layer or in front of a particular item. * @param reference The reference object to bring the object in front of (must have same parent) (Optional) */ bringToFront(reference?: PageItem): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Checks in the story or stories. * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ checkIn(versionComments?: string, forceSave?: boolean): boolean; /** * Checks out the story. */ checkOut(): boolean; /** * Removes the frame fittings options and resets it to the initial state. */ clearFrameFittingOptions(): void; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the Oval. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the Oval to a different shape. * @param given The Oval's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Oval. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Oval. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Oval. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Oval. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Oval. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the Oval at the specified location or offset. * @param to The location of the new Oval, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new Oval from the original Oval's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Creates a new page item by excluding the overlapping areas of the Oval and * other objects. * @param with_ The object(s) to exclude. */ excludeOverlapPath(with_: PageItem[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the Oval. * @param given The axis around which to flip the Oval. * @param around The point around which to flip the Oval. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Oval[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Creates a new page item by intersecting the Oval with other objects. Returns * an error if the objects do not intersect. * @param with_ The object(s) with which to intersect. */ intersectPath(with_: PageItem[]): PageItem; /** * Creates a compound path by combining the path(s) of the Oval with the paths * of other objects. * @param with_ The other objects whose paths to include in the new compound path. */ makeCompoundPath(with_: PageItem[]): PageItem; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Creates a new page item by reverse subtracting the overlapping areas of the * Oval and other objects. * @param with_ The object(s) to reverse subtract. */ minusBack(with_: PageItem[]): PageItem; /** * Moves the Oval to a new location. Note: Either the 'to' or 'by' parameter is * required; if both parameters are defined, only the to value is used. * @param to The new location of the Oval,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the Oval relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Releases a compound path. */ releaseCompoundPath(): PageItem[]; /** * Deletes the Oval. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Reverts the document to its state at the last save operation. */ revert(): boolean; /** * Selects the object. * @param existingSelection The selection status of the Oval in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Sends the Oval back one level in its layer. */ sendBackward(): void; /** * Sends the Oval to the back of its layer or behind a particular item (must * have same parent). * @param reference The reference object to send the object behind (Optional) */ sendToBack(reference?: PageItem): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new Oval (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Creates a new page item by subtracting the overlapping areas of the Oval and * other objects. * @param with_ The object(s) to subtract. */ subtractPath(with_: PageItem[]): PageItem; /** * Generates a string which, if executed, will return the Oval. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the Oval using the last transformation performed on any object. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformAgain(): string[]; /** * Transforms the Oval using the last transformation performed on any Oval. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformAgainIndividually(): string[]; /** * Transforms the Oval using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the Oval using the last sequence of transformations performed on * any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * A collection of ellipses. */ declare class Ovals { /** Returns the Oval with the specified index or name. */ [index: number]: Oval; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new Oval * @param layer The layer on which to create the Oval. (Optional) * @param at The location at which to insert the Oval relative to the reference object or within the container object. (Optional) * @param reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) * @param withProperties Initial values for properties of the new Oval (Optional) */ add(layer?: Layer, at?: LocationOptions, reference?: Document | Layer | MasterSpread | Page | Spread | PageItem, withProperties?: Object): Oval; /** * Returns any Oval in the collection. */ anyItem(): Oval; /** * Displays the number of elements in the Oval. */ count(): number; /** * Returns every Oval in the collection. */ everyItem(): Oval; /** * Returns the first Oval in the collection. */ firstItem(): Oval; /** * Returns the Oval with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Oval; /** * Returns the Oval with the specified ID. * @param id The ID. */ itemByID(id: number): Oval; /** * Returns the Oval with the specified name. * @param name The name. */ itemByName(name: string): Oval; /** * Returns the Ovals within the specified range. * @param from The Oval, index, or name at the beginning of the range. Can accept: Oval, Long Integer or String. * @param to The Oval, index, or name at the end of the range. Can accept: Oval, Long Integer or String. */ itemByRange(from: number | Oval | string, to: number | Oval | string): Oval[]; /** * Returns the last Oval in the collection. */ lastItem(): Oval; /** * Returns the middle Oval in the collection. */ middleItem(): Oval; /** * Returns the Oval whose index follows the specified Oval in the collection. * @param obj The Oval whose index comes before the desired Oval. */ nextItem(obj: Oval): Oval; /** * Returns the Oval with the index previous to the specified index. * @param obj The index of the Oval that follows the desired Oval. */ previousItem(obj: Oval): Oval; /** * Generates a string which, if executed, will return the Oval. */ toSource(): string; } /** * Override clearing options. */ declare enum OverrideType { /** * Clears all types of override. */ ALL = 1634495520, /** * Clears only character style overrides. */ CHARACTER_ONLY = 1667789423, /** * Clears only paragraph style overrides. */ PARAGRAPH_ONLY = 1885434479, } /** * A placed PDF file. */ declare class PDF extends Graphic { /** * Indicates whether the PDF has been flipped independently of its parent * object and, if yes, the direction in which the PDF was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the PDF relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the PDF relative to its containing object. (Range: * -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the PDF relative to its containing object. (Range: -360 * to 360) */ absoluteShearAngle: number; /** * The vertical scale of the PDF relative to its containing object. */ absoluteVerticalScale: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the PDF. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the PDF. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the PDF. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the PDF. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the PDF. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * Clipping path settings. */ readonly clippingPath: ClippingPathSettings; /** * The color profile policy for CMYK content in a placed vector. */ cmykVectorPolicy: PlacedVectorProfilePolicy; /** * Transparency settings for the content of the PDF. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the PDF. */ endJoin: EndJoin; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * PDF. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the PDF's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the PDF. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the PDF excluding the stroke width, in the format [y1, x1, y2, * x2], which give the coordinates of the top-left and bottom-right corners of * the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the PDF. (Range: -180 * to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the PDF. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the PDF, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the PDF. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the PDF. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the PDF, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * Graphic layer option settings. */ readonly graphicLayerOptions: GraphicLayerOption; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * The color profile policy for grayscale content in a placed vector. */ grayVectorPolicy: PlacedVectorProfilePolicy; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the PDF. */ horizontalScale: number; /** * The unique ID of the PDF. */ readonly id: number; /** * The type of the image. */ readonly imageTypeName: string; /** * The index of the PDF within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the PDF is on. */ itemLayer: Layer; /** * The source file of the link. */ readonly itemLink: Link; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the PDF. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the PDF is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * The name of the PDF. */ name: string; /** * If true, the PDF does not print. */ nonprinting: boolean; /** * If true, the PDF's fill color overprints any underlying objects. If false, * the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the PDF's stroke color overprints any underlying objects. If false, * the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the PDF (a Snippet, XMLElement, PlaceGun, TextBox, * SignatureField, ComboBox, ListBox, SplineItem, Polygon, GraphicLine, * Rectangle, Oval or State). */ readonly parent: ComboBox | GraphicLine | ListBox | Oval | PlaceGun | Polygon | Rectangle | SignatureField | SplineItem | TextBox | XMLElement | Snippet | State; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * PDF attribute settings. */ readonly pdfAttributes: PDFAttribute; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The color profile policy for RGB content in a placed vector. */ rgbVectorPolicy: PlacedVectorProfilePolicy; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the PDF. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the PDF. (Range: -360 to 360) */ shearAngle: number; /** * The stroke alignment applied to the PDF. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the PDF. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the PDF. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the PDF's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the PDF. */ verticalScale: number; /** * If true, the PDF is visible. */ visible: boolean; /** * The bounds of the PDF including the stroke width, in the format [y1, x1, y2, * x2], which give the coordinates of the top-left and bottom-right corners of * the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * Dispatched after a PDF is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a PDF is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the PDF's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the PDF that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the PDF. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the PDF to a different shape. * @param given The PDF's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new PDF. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new PDF. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new PDF. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new PDF. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new PDF. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the PDF at the specified location or offset. * @param to The location of the new PDF, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new PDF from the original PDF's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Exports the PDF for the web. * @param to The full path name of the exported file. */ exportForWeb(to: File): string[]; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the PDF. * @param given The axis around which to flip the PDF. * @param around The point around which to flip the PDF. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PDF[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the PDF to a new location. Note: Either the 'to' or 'by' parameter is * required; if both parameters are defined, only the to value is used. * @param to The new location of the PDF,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the PDF relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the PDF. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the PDF in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new PDF (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the PDF. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the PDF using the last transformation performed on any object. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformAgain(): string[]; /** * Transforms the PDF using the last transformation performed on any PDF. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformAgainIndividually(): string[]; /** * Transforms the PDF using the last sequence of transform operations performed * on any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgain(): string[]; /** * Transforms the PDF using the last sequence of transformations performed on * any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * PDF attributes. */ declare class PDFAttribute extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The page number of the PDF document page to place. */ readonly pageNumber: number; /** * The parent of the PDFAttribute (a PDF or ImportedPage). */ readonly parent: ImportedPage | PDF; /** * The type of cropping to apply. */ readonly pdfCrop: PDFCrop; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, the background of the PDF is transparent. */ readonly transparentBackground: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PDFAttribute[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the PDFAttribute. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for specifying how to represent color information in the exported * PDF. */ declare enum PDFColorSpace { /** * Represents all color values using CYMK color space. */ CMYK = 1129142603, /** * Converts all color values to high-quality black-and-white images. Gray * levels of the converted objects represent the luminosity of the original * objects. */ GRAY = 1766290041, /** * Repurposes CMYK colors. */ REPURPOSE_CMYK = 1917013337, /** * Repurposes RGB colors. */ REPURPOSE_RGB = 1917994818, /** * Represents all color values using the RGB color space. Best suited for * documents that will be viewed onscreen. */ RGB = 1666336578, /** * Leaves each image in its original color space. */ UNCHANGED_COLOR_SPACE = 1970161251, } /** * PDF comment object */ declare class PDFComment { /** * The content of the comment */ readonly commentContent: string; /** * The date of the comment */ readonly commentDate: Date; /** * The file path of the comment */ readonly commentFilePath: string; /** * Whether the comment has been applied */ readonly commentIsApplied: boolean; /** * Whether the comment is an orphan */ readonly commentIsOrphan: boolean; /** * Path geometry of the comment. Can return: Ordered array containing * pathPointArray:Array of Ordered array containing anchor:Array of 2 Reals, * leftDirection:Array of 2 Reals, rightDirection:Array of 2 Reals, * pathOpen:Boolean. */ readonly commentPathGeometry: (any[] | number[][] | boolean)[]; /** * The name of the reviewer who made the comment */ readonly commentReviewer: string; /** * The status of the comment */ readonly commentStatus: CommentStatusEnum; /** * The type of the comment */ readonly commentType: CommentTypeEnum; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the PDFComment. */ readonly id: number; /** * The index of the PDFComment within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the PDFComment; this is an alias to the PDFComment's label * property. */ name: string; /** * The parent of the PDFComment (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of reply objects */ readonly replies: Replies; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Change the status of a comment * @param commentStatus The new status of the comment * @param withProperties Initial values for properties of the new PDFComment (Optional) */ changeStatus(commentStatus: CommentStatusEnum, withProperties?: Object): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PDFComment[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the PDFComment. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the PDFComment. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of PDF comment objects */ declare class PDFComments { /** Returns the PDFComment with the specified index or name. */ [index: number]: PDFComment; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any PDFComment in the collection. */ anyItem(): PDFComment; /** * Displays the number of elements in the PDFComment. */ count(): number; /** * Returns every PDFComment in the collection. */ everyItem(): PDFComment; /** * Returns the first PDFComment in the collection. */ firstItem(): PDFComment; /** * Returns the PDFComment with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): PDFComment; /** * Returns the PDFComment with the specified ID. * @param id The ID. */ itemByID(id: number): PDFComment; /** * Returns the PDFComment with the specified name. * @param name The name. */ itemByName(name: string): PDFComment; /** * Returns the PDFComments within the specified range. * @param from The PDFComment, index, or name at the beginning of the range. Can accept: PDFComment, Long Integer or String. * @param to The PDFComment, index, or name at the end of the range. Can accept: PDFComment, Long Integer or String. */ itemByRange(from: number | PDFComment | string, to: number | PDFComment | string): PDFComment[]; /** * Returns the last PDFComment in the collection. */ lastItem(): PDFComment; /** * Returns the middle PDFComment in the collection. */ middleItem(): PDFComment; /** * Returns the PDFComment whose index follows the specified PDFComment in the * collection. * @param obj The PDFComment whose index comes before the desired PDFComment. */ nextItem(obj: PDFComment): PDFComment; /** * Returns the PDFComment with the index previous to the specified index. * @param obj The index of the PDFComment that follows the desired PDFComment. */ previousItem(obj: PDFComment): PDFComment; /** * Generates a string which, if executed, will return the PDFComment. */ toSource(): string; } /** * The objects to compress in the PDF document. */ declare enum PDFCompressionType { /** * Uses no compression. */ COMPRESS_NONE = 1131368047, /** * Compress all objects. */ COMPRESS_OBJECTS = 1131368290, /** * Compresses only objects related to PDF structure. */ COMPRESS_STRUCTURE = 1131369332, } /** * The amount of the PDF document to place. */ declare enum PDFCrop { /** * Places only the area defined by the PDF author as placeable artwork. */ CROP_ART = 1131573313, /** * Places only the area that represents clipped content. */ CROP_BLEED = 1131573314, /** * Places the page's bounding box using all layers. */ CROP_CONTENT_ALL_LAYERS = 1131561324, /** * Places the page's bounding box using visible layers only. */ CROP_CONTENT_VISIBLE_LAYERS = 1131566703, /** * Places the area that represents the physical paper size of the original PDF * document. */ CROP_MEDIA = 1131573325, /** * Places only the area displayed by Acrobat. */ CROP_PDF = 1131573328, /** * Places only the area that represents the final trim size of the document. */ CROP_TRIM = 1131573332, } /** * PDF export settings for the application object. */ declare class PDFExportPreference extends Preference { /** * The exported PDF document's Acrobat compatibility. */ acrobatCompatibility: AcrobatCompatibility; /** * The transparency flattener preset to use. */ appliedFlattenerPreset: FlattenerPreset; /** * The height of the bleed area at the bottom of the page. Note: Valid only * when use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedBottom: number | string; /** * The width of the bleed area at the inside of the page. Note: Valid only when * use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedInside: number | string; /** * If true, print bleed marks. */ bleedMarks: boolean; /** * The width of the bleed area at the outside of the page. Note: Valid only * when use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedOutside: number | string; /** * The height of the bleed area at the top of the page. Note: Valid only when * use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedTop: number | string; /** * Changes the open document password to the specified string. Valid only when * use security is true. Note: A script can set but not get this value. */ changeSecurityPassword: string; /** * If true, add small squares of color representing the CMYK inks and tints of * gray in 10% increments. */ colorBars: boolean; /** * The amount of bitmap compression to use. */ colorBitmapCompression: BitmapCompression; /** * The compression option to apply to color images. */ colorBitmapQuality: CompressionQuality; /** * The sampling option to apply to color bitmap images in the PDF document. */ colorBitmapSampling: Sampling; /** * The ppi of the resampled image. (Range: 9 to 2400) * @remarks Range: 9 to 2400 */ colorBitmapSamplingDPI: number; /** * The tile size for color images. Valid only when color bitmap compression is * JPEG 2000. (Range: 128 to 2048) * @remarks Range: 128 to 2048 */ colorTileSize: number; /** * If true, compresses text and line art using ZIP compression. */ compressTextAndLineArt: boolean; /** * The objects to compress in the PDF document. */ compressionType: PDFCompressionType; /** * If true, image data that falls outside the visible portion of an image's * frame is not exported to the PDF document. */ cropImagesToFrames: boolean; /** * Prints crop marks that define where the page should be trimmed. */ cropMarks: boolean; /** * Sets the default document language in the exported PDF. The correct ISO code * of the language must be provided. */ defaultDocumentLanguage: string; /** * If true, users cannot fill in forms, sign, extract pages, or add comments in * the PDF document. Valid only when use security is true. */ disallowChanging: boolean; /** * If true, users cannot copy and paste text, images, or other content from the * PDF document. Valid only when use security is true. */ disallowCopying: boolean; /** * If true, users cannot insert, delete, or rotate pages in the PDF document. * Valid only when use security is true. */ disallowDocumentAssembly: boolean; /** * If true, users cannot extract content from the PDF document using software * tools for the visually impaired. Valid only when use security is true. */ disallowExtractionForAccessibility: boolean; /** * If true, users cannot change form fields in the PDF document. Valid only * when use security is true. */ disallowFormFillIn: boolean; /** * If true, users cannot print high-resolution copies of the PDF document. * Valid only when use security is true. */ disallowHiResPrinting: boolean; /** * If true, users cannot add or change notes, edit text, or fill in form fields * in the PDF document. Valid only when use security is true. */ disallowNotes: boolean; /** * If true and acrobat compatibility is Acrobat 6 or higher, storage systems * and search engines cannot access metadata stored in the PDF document. If * true and acrobat compatibility is acrobat 5 or higher, users cannot copy and * extract content from the document. Valid only when use security is true. */ disallowPlaintextMetadata: boolean; /** * If true, users cannot print the PDF document. Valid only when use security * is true. */ disallowPrinting: boolean; /** * Effective PDF/X OC Registry. */ readonly effectiveOCRegistry: string; /** * Effective PDF/X output condition. */ readonly effectiveOutputCondition: string; /** * Effective destination color profile. Can return: PDFProfileSelector * enumerator or String. */ readonly effectivePDFDestinationProfile: PDFProfileSelector | string; /** * Effective PDF X color profile. Can return: PDFProfileSelector enumerator or * String. */ readonly effectivePDFXProfile: PDFProfileSelector | string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Export each page or spread as a separate PDF file. */ exportAsSinglePages: boolean; /** * If true, includes visible guides and baseline grids in the PDF document. */ exportGuidesAndGrids: boolean; /** * If true, export hidden spreads in PDF. If false, skip export of hidden * spreads. */ exportHiddenSpread: boolean; /** * If true, saves each layer as an Acrobat layer within the PDF document. */ exportLayers: boolean; /** * If true, makes non-printing objects visible in the PDF document. */ exportNonprintingObjects: boolean; /** * If true, each spread in the exported document is combined into a single page * that has spread's original width. */ exportReaderSpreads: boolean; /** * Which layers to export. */ exportWhichLayers: ExportLayerOptions; /** * If true, generates thumbnail images for each page or spread. */ generateThumbnails: boolean; /** * The tile size for grayscale images. Valid only when grayscale bitmap * compression is JPEG 2000. (Range: 128 to 2048) * @remarks Range: 128 to 2048 */ grayTileSize: number; /** * The bitmap compression option to apply to grayscale bitmap images. */ grayscaleBitmapCompression: BitmapCompression; /** * The compression option to apply to grayscale bitmap images. */ grayscaleBitmapQuality: CompressionQuality; /** * The sampling option to apply to grayscale bitmap images. */ grayscaleBitmapSampling: Sampling; /** * The ppi of the resampled image. (Range: 9 to 2400) * @remarks Range: 9 to 2400 */ grayscaleBitmapSamplingDPI: number; /** * If true, ignores flattener spread overrides. */ ignoreSpreadOverrides: boolean; /** * If true, displays bookmarks and table of contents entries as links in the * bookmarks pane in the PDF document. If false, no bookmarks are exported. */ includeBookmarks: boolean; /** * If true, includes hyperlinks when exporting the document. */ includeHyperlinks: boolean; /** * The ICC Profiles to include in the exported PDF document. Can also accept: * Boolean. */ includeICCProfiles: ICCProfiles | boolean; /** * If true, includes the document's slug area in the PDF document. */ includeSlugWithPDF: boolean; /** * If true, creates a tagged PDF file. Note: If acrobat compatibility is * acrobat 6 or higher, tags are visible only when the PDF is opened in Acrobat * 6 or higher. */ includeStructure: boolean; /** * How to draw interactive elements. */ interactiveElementsOption: InteractiveElementsOptions; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The bitmap compression option to apply to monochrome bitmap images. */ monochromeBitmapCompression: MonoBitmapCompression; /** * The sampling option to apply to monochrome bitmap images. */ monochromeBitmapSampling: Sampling; /** * The ppi of the resampled image. (Range: 9 to 2400) * @remarks Range: 9 to 2400 */ monochromeBitmapSamplingDPI: number; /** * The web address for the output condition registry. Not valid when PDF/X-3 is * the compliance standard or PDF export preset. */ ocRegistry: string; /** * If true, replaces bitmap images with OPI links. */ omitBitmaps: boolean; /** * If true, replaces EPS images with OPI links. */ omitEPS: boolean; /** * If true, replaces PDF images with OPI links. */ omitPDF: boolean; /** * The password to enter when opening the PDF document. Valid only when use * security is true. Note: A script can set but not get this value. */ openDocumentPassword: string; /** * Open PDF in full screen mode. */ openInFullScreen: boolean; /** * If true, optimizes the exported PDF document for faster viewing in a web * browser. Note: Compresses text and line art, regardless of specified * compression settings. */ optimizePDF: boolean; /** * The name of the intended printing condition. Valid only when a PDF/X * compliance standard has been defined for the document. Not valid when * PDF/X-3 is the compliance standard or PDF export preset. For information on * compliance standards, see standards compliance and PDF X standards. */ outputCondition: string; /** * The name of the output condition. Valid only when a PDF/X standard has been * defined for the document. */ outputConditionName: string; /** * If true, prints the filename, page number, current date and time, and color * separation name. */ pageInformationMarks: boolean; /** * The offset from the edge of the page for page marks. * @remarks Measurement unit — also accepts a string such as "12mm". */ pageMarksOffset: number | string; /** * The pages to print, specified either as an enumeration or a string. To * specify a range, separate page numbers in the string with a hyphen (-). To * specify separate pages, separate page numbers in the string with a comma * (,). Can return: PageRange enumerator or String. */ pageRange: PageRange | string; /** * The parent of the PDFExportPreference (a Application). */ readonly parent: Application; /** * The color space to use to represent color information in the exported PDF * document. */ pdfColorSpace: PDFColorSpace; /** * The gamut of the final RGB or CMYK device. Can return: PDFProfileSelector * enumerator or String. */ pdfDestinationProfile: PDFProfileSelector | string; /** * The export PDF display title. */ pdfDisplayTitle: PdfDisplayTitleOptions; /** * The export PDF magnification options. */ pdfMagnification: PdfMagnificationOptions; /** * The type of printer marks, either an enum value or the name of a custom * marks file. Can return: MarkTypes enumerator or String. */ pdfMarkType: MarkTypes | string; /** * The export PDF page layout. */ pdfPageLayout: PageLayoutOptions; /** * The PDF X color profile to use for the PDF document. . Can return: * PDFProfileSelector enumerator or String. */ pdfXProfile: PDFProfileSelector | string; /** * If true, retains editing information in the exported PDF, allowing the * document to be re-imported and edited in InDesign. If false, editing * information is not preserved. */ preserveInDesignEditingCapabilities: boolean; /** * The stroke weight for printer's marks. */ printerMarkWeight: PDFMarkWeight; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, prints small targets outside the page area for aligning color * separations. */ registrationMarks: boolean; /** * If true, simulates the effects of overprinting spot inks with different * neutral density values by converting spot colors to process colors for * printing. Note: Not valid when the color output mode is defined to leave * color profiles unchanged. */ simulateOverprint: boolean; /** * Suffix to be used at the end of each file when pages are exported as * separate PDF files. */ singlePagesPDFSuffix: string; /** * The PDF/X standards compliance to test against. */ standardsCompliance: PDFXStandards; /** * Sets the threshold for embedding complete fonts based on how many of the * fonts' characters are used in the document. If the percentage of characters * used in the document for any given font exceeds the specified value, the * font is completely embedded; otherwise, the font is subsetted. (Range: 0 to * 100) Notes: Embedding complete fonts increases file size. To completely * embed all fonts, use 0 (zero). * @remarks Range: 0 to 100 */ subsetFontsBelow: number; /** * The minimum dpi at which color compression is applied. (Range: 1 to 10 times * the value specified for color bitmap sampling DPI.) * @remarks Range: 1 to 10 */ thresholdToCompressColor: number; /** * The minimum dpi at which grayscale compression is applied. (Range: 1 to 10 * times the value specified for grayscale bitmap sampling DPI.) * @remarks Range: 1 to 10 */ thresholdToCompressGray: number; /** * The minimum dpi at which monochrome compression is applied. (Range: 1 to 10 * times the value specified for monochrome bitmap sampling DPI.) * @remarks Range: 1 to 10 */ thresholdToCompressMonochrome: number; /** * If true, uses the document's bleed settings in the PDF document. */ useDocumentBleedWithPDF: boolean; /** * If true, activates security controls for the PDF document. */ useSecurity: boolean; /** * If true, automatically opens the PDF file after exporting. */ viewPDF: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PDFExportPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the PDFExportPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * PDF export settings for the document object. */ declare class PDFExportPreset { /** * The exported PDF document's Acrobat compatibility. */ acrobatCompatibility: AcrobatCompatibility; /** * The transparency flattener preset to use. */ appliedFlattenerPreset: FlattenerPreset; /** * The height of the bleed area at the bottom of the page. Note: Valid only * when use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedBottom: number | string; /** * The width of the bleed area at the inside of the page. Note: Valid only when * use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedInside: number | string; /** * If true, print bleed marks. */ bleedMarks: boolean; /** * The width of the bleed area at the outside of the page. Note: Valid only * when use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedOutside: number | string; /** * The height of the bleed area at the top of the page. Note: Valid only when * use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedTop: number | string; /** * If true, add small squares of color representing the CMYK inks and tints of * gray in 10% increments. */ colorBars: boolean; /** * The amount of bitmap compression to use. */ colorBitmapCompression: BitmapCompression; /** * The compression option to apply to color images. */ colorBitmapQuality: CompressionQuality; /** * The sampling option to apply to color bitmap images in the PDF document. */ colorBitmapSampling: Sampling; /** * The ppi of the resampled image. (Range: 9 to 2400) * @remarks Range: 9 to 2400 */ colorBitmapSamplingDPI: number; /** * The tile size for color images. Valid only when color bitmap compression is * JPEG 2000. (Range: 128 to 2048) * @remarks Range: 128 to 2048 */ colorTileSize: number; /** * If true, compresses text and line art using ZIP compression. */ compressTextAndLineArt: boolean; /** * The objects to compress in the PDF document. */ compressionType: PDFCompressionType; /** * If true, image data that falls outside the visible portion of an image's * frame is not exported to the PDF document. */ cropImagesToFrames: boolean; /** * Prints crop marks that define where the page should be trimmed. */ cropMarks: boolean; /** * Sets the default document language in the exported PDF. The correct ISO code * of the language must be provided. */ defaultDocumentLanguage: string; /** * Effective PDF/X OC Registry. */ readonly effectiveOCRegistry: string; /** * Effective PDF/X output condition. */ readonly effectiveOutputCondition: string; /** * Effective destination color profile. Can return: PDFProfileSelector * enumerator or String. */ readonly effectivePDFDestinationProfile: PDFProfileSelector | string; /** * Effective PDF X color profile. Can return: PDFProfileSelector enumerator or * String. */ readonly effectivePDFXProfile: PDFProfileSelector | string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Export each page or spread as a separate PDF file. */ exportAsSinglePages: boolean; /** * If true, includes visible guides and baseline grids in the PDF document. */ exportGuidesAndGrids: boolean; /** * If true, saves each layer as an Acrobat layer within the PDF document. */ exportLayers: boolean; /** * If true, makes non-printing objects visible in the PDF document. */ exportNonprintingObjects: boolean; /** * If true, each spread in the exported document is combined into a single page * that has spread's original width. */ exportReaderSpreads: boolean; /** * Which layers to export. */ exportWhichLayers: ExportLayerOptions; /** * The full path to the PDFExportPreset, including the name of the * PDFExportPreset. */ readonly fullName: File; /** * If true, generates thumbnail images for each page or spread. */ generateThumbnails: boolean; /** * The tile size for grayscale images. Valid only when grayscale bitmap * compression is JPEG 2000. (Range: 128 to 2048) * @remarks Range: 128 to 2048 */ grayTileSize: number; /** * The bitmap compression option to apply to grayscale bitmap images. */ grayscaleBitmapCompression: BitmapCompression; /** * The compression option to apply to grayscale bitmap images. */ grayscaleBitmapQuality: CompressionQuality; /** * The sampling option to apply to grayscale bitmap images. */ grayscaleBitmapSampling: Sampling; /** * The ppi of the resampled image. (Range: 9 to 2400) * @remarks Range: 9 to 2400 */ grayscaleBitmapSamplingDPI: number; /** * If true, ignores flattener spread overrides. */ ignoreSpreadOverrides: boolean; /** * If true, displays bookmarks and table of contents entries as links in the * bookmarks pane in the PDF document. If false, no bookmarks are exported. */ includeBookmarks: boolean; /** * If true, includes hyperlinks when exporting the document. */ includeHyperlinks: boolean; /** * The ICC Profiles to include in the exported PDF document. Can also accept: * Boolean. */ includeICCProfiles: ICCProfiles | boolean; /** * If true, includes the document's slug area in the PDF document. */ includeSlugWithPDF: boolean; /** * If true, creates a tagged PDF file. Note: If acrobat compatibility is * acrobat 6 or higher, tags are visible only when the PDF is opened in Acrobat * 6 or higher. */ includeStructure: boolean; /** * The index of the PDFExportPreset within its containing object. */ readonly index: number; /** * How to draw interactive elements. */ interactiveElementsOption: InteractiveElementsOptions; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The bitmap compression option to apply to monochrome bitmap images. */ monochromeBitmapCompression: MonoBitmapCompression; /** * The sampling option to apply to monochrome bitmap images. */ monochromeBitmapSampling: Sampling; /** * The ppi of the resampled image. (Range: 9 to 2400) * @remarks Range: 9 to 2400 */ monochromeBitmapSamplingDPI: number; /** * The name of the PDFExportPreset. */ name: string; /** * The web address for the output condition registry. Not valid when PDF/X-3 is * the compliance standard or PDF export preset. */ ocRegistry: string; /** * If true, replaces bitmap images with OPI links. */ omitBitmaps: boolean; /** * If true, replaces EPS images with OPI links. */ omitEPS: boolean; /** * If true, replaces PDF images with OPI links. */ omitPDF: boolean; /** * Open PDF in full screen mode. */ openInFullScreen: boolean; /** * If true, optimizes the exported PDF document for faster viewing in a web * browser. Note: Compresses text and line art, regardless of specified * compression settings. */ optimizePDF: boolean; /** * The name of the intended printing condition. Valid only when a PDF/X * compliance standard has been defined for the document. Not valid when * PDF/X-3 is the compliance standard or PDF export preset. For information on * compliance standards, see standards compliance and PDF X standards. */ outputCondition: string; /** * The name of the output condition. Valid only when a PDF/X standard has been * defined for the document. */ outputConditionName: string; /** * If true, prints the filename, page number, current date and time, and color * separation name. */ pageInformationMarks: boolean; /** * The offset from the edge of the page for page marks. * @remarks Measurement unit — also accepts a string such as "12mm". */ pageMarksOffset: number | string; /** * The parent of the PDFExportPreset (a Application). */ readonly parent: Application; /** * The color space to use to represent color information in the exported PDF * document. */ pdfColorSpace: PDFColorSpace; /** * The gamut of the final RGB or CMYK device. Can return: PDFProfileSelector * enumerator or String. */ pdfDestinationProfile: PDFProfileSelector | string; /** * The export PDF display title. */ pdfDisplayTitle: PdfDisplayTitleOptions; /** * The export PDF magnification options. */ pdfMagnification: PdfMagnificationOptions; /** * The type of printer marks, either an enum value or the name of a custom * marks file. Can return: MarkTypes enumerator or String. */ pdfMarkType: MarkTypes | string; /** * The export PDF page layout. */ pdfPageLayout: PageLayoutOptions; /** * The PDF X color profile to use for the PDF document. . Can return: * PDFProfileSelector enumerator or String. */ pdfXProfile: PDFProfileSelector | string; /** * The stroke weight for printer's marks. */ printerMarkWeight: PDFMarkWeight; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, prints small targets outside the page area for aligning color * separations. */ registrationMarks: boolean; /** * If true, simulates the effects of overprinting spot inks with different * neutral density values by converting spot colors to process colors for * printing. Note: Not valid when the color output mode is defined to leave * color profiles unchanged. */ simulateOverprint: boolean; /** * Suffix to be used at the end of each file when pages are exported as * separate PDF files. */ singlePagesPDFSuffix: string; /** * The PDF/X standards compliance to test against. */ standardsCompliance: PDFXStandards; /** * Sets the threshold for embedding complete fonts based on how many of the * fonts' characters are used in the document. If the percentage of characters * used in the document for any given font exceeds the specified value, the * font is completely embedded; otherwise, the font is subsetted. (Range: 0 to * 100) Notes: Embedding complete fonts increases file size. To completely * embed all fonts, use 0 (zero). * @remarks Range: 0 to 100 */ subsetFontsBelow: number; /** * The minimum dpi at which color compression is applied. (Range: 1 to 10 times * the value specified for color bitmap sampling DPI.) * @remarks Range: 1 to 10 */ thresholdToCompressColor: number; /** * The minimum dpi at which grayscale compression is applied. (Range: 1 to 10 * times the value specified for grayscale bitmap sampling DPI.) * @remarks Range: 1 to 10 */ thresholdToCompressGray: number; /** * The minimum dpi at which monochrome compression is applied. (Range: 1 to 10 * times the value specified for monochrome bitmap sampling DPI.) * @remarks Range: 1 to 10 */ thresholdToCompressMonochrome: number; /** * If true, uses the document's bleed settings in the PDF document. */ useDocumentBleedWithPDF: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the PDFExportPreset. */ duplicate(): PDFExportPreset; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PDFExportPreset[]; /** * Deletes the PDFExportPreset. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the PDFExportPreset. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of PDF export presets. */ declare class PDFExportPresets { /** Returns the PDFExportPreset with the specified index or name. */ [index: number]: PDFExportPreset; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new PDFExportPreset. * @param withProperties Initial values for properties of the new PDFExportPreset (Optional) */ add(withProperties?: Object): PDFExportPreset; /** * Returns any PDFExportPreset in the collection. */ anyItem(): PDFExportPreset; /** * Displays the number of elements in the PDFExportPreset. */ count(): number; /** * Returns every PDFExportPreset in the collection. */ everyItem(): PDFExportPreset; /** * Returns the first PDFExportPreset in the collection. */ firstItem(): PDFExportPreset; /** * Returns the PDFExportPreset with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): PDFExportPreset; /** * Returns the PDFExportPreset with the specified name. * @param name The name. */ itemByName(name: string): PDFExportPreset; /** * Returns the PDFExportPresets within the specified range. * @param from The PDFExportPreset, index, or name at the beginning of the range. Can accept: PDFExportPreset, Long Integer or String. * @param to The PDFExportPreset, index, or name at the end of the range. Can accept: PDFExportPreset, Long Integer or String. */ itemByRange(from: number | PDFExportPreset | string, to: number | PDFExportPreset | string): PDFExportPreset[]; /** * Returns the last PDFExportPreset in the collection. */ lastItem(): PDFExportPreset; /** * Returns the middle PDFExportPreset in the collection. */ middleItem(): PDFExportPreset; /** * Returns the PDFExportPreset whose index follows the specified * PDFExportPreset in the collection. * @param obj The PDFExportPreset whose index comes before the desired PDFExportPreset. */ nextItem(obj: PDFExportPreset): PDFExportPreset; /** * Returns the PDFExportPreset with the index previous to the specified index. * @param obj The index of the PDFExportPreset that follows the desired PDFExportPreset. */ previousItem(obj: PDFExportPreset): PDFExportPreset; /** * Generates a string which, if executed, will return the PDFExportPreset. */ toSource(): string; } /** * PDF JPEG Quality options. */ declare enum PDFJPEGQualityOptions { /** * Uses high JPEG compression. */ HIGH = 1701726313, /** * Uses low JPEG compression. */ LOW = 1701727351, /** * Uses maximum JPEG compression. */ MAXIMUM = 1701727608, /** * Uses medium JPEG compression. */ MEDIUM = 1701727588, /** * Uses minimum JPEG compression. */ MINIMUM = 1701727598, } /** * PDF mark weight */ declare enum PDFMarkWeight { /** * Printer mark line weight of 0.125 points. */ P125PT = 825374064, /** * Printer mark line weight of 0.25 points. */ P25PT = 842346608, /** * Printer mark line weight of 0.50 points. */ P50PT = 892350576, } /** * PDF place preferences. */ declare class PDFPlacePreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The password to enter when opening the PDF document. Valid only when use * security is true. Note: A script can set but not get this value. */ openDocumentPassword: string; /** * The page number of the PDF document page to place. */ pageNumber: number; /** * The parent of the PDFPlacePreference (a Application). */ readonly parent: Application; /** * The type of cropping to apply. */ pdfCrop: PDFCrop; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, the background of the PDF is transparent. */ transparentBackground: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PDFPlacePreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the PDFPlacePreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * The color profile. */ declare enum PDFProfileSelector { /** * Uses the document's CMYK profile. */ USE_DOCUMENT = 1967419235, /** * Uses the monitor's color profile. */ USE_MONITOR_PROFILE = 1836008528, /** * Uses no profile. */ USE_NO_PROFILE = 1851868240, /** * Uses the working CMYK profile. */ WORKING = 1466921579, } /** * PDF raster compression options. */ declare enum PDFRasterCompressionOptions { /** * Uses JPEG compression and automatically determines the best quality type. */ AUTOMATIC_COMPRESSION = 1936875875, /** * Uses JPEG compression. */ JPEG_COMPRESSION = 1936878179, /** * Uses the best quality type. */ LOSSLESS_COMPRESSION = 1936878691, } /** * Options for specifying the PDF/X compliance standard. */ declare enum PDFXStandards { /** * Does not check for compliance with a PDF/X standard. */ NONE = 1852796517, /** * Checks for compliance with the PDF/X-1a:2001 standard. */ PDFX1A2001_STANDARD = 1396912481, /** * Checks for compliance with the PDF/X-1a:2003 standard. */ PDFX1A2003_STANDARD = 1395745075, /** * Checks for compliance with the PDF/X-3:2002 standard. */ PDFX32002_STANDARD = 1396922419, /** * Checks for compliance with the PDF/X-3:2003 standard. */ PDFX32003_STANDARD = 1398289203, /** * PDFX42010 standard is used. */ PDFX42010_STANDARD = 1398289496, } /** * A collection of PDF files. */ declare class PDFs { /** Returns the PDF with the specified index or name. */ [index: number]: PDF; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any PDF in the collection. */ anyItem(): PDF; /** * Displays the number of elements in the PDF. */ count(): number; /** * Returns every PDF in the collection. */ everyItem(): PDF; /** * Returns the first PDF in the collection. */ firstItem(): PDF; /** * Returns the PDF with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): PDF; /** * Returns the PDF with the specified ID. * @param id The ID. */ itemByID(id: number): PDF; /** * Returns the PDF with the specified name. * @param name The name. */ itemByName(name: string): PDF; /** * Returns the PDFs within the specified range. * @param from The PDF, index, or name at the beginning of the range. Can accept: PDF, Long Integer or String. * @param to The PDF, index, or name at the end of the range. Can accept: PDF, Long Integer or String. */ itemByRange(from: number | PDF | string, to: number | PDF | string): PDF[]; /** * Returns the last PDF in the collection. */ lastItem(): PDF; /** * Returns the middle PDF in the collection. */ middleItem(): PDF; /** * Returns the PDF whose index follows the specified PDF in the collection. * @param obj The PDF whose index comes before the desired PDF. */ nextItem(obj: PDF): PDF; /** * Returns the PDF with the index previous to the specified index. * @param obj The index of the PDF that follows the desired PDF. */ previousItem(obj: PDF): PDF; /** * Generates a string which, if executed, will return the PDF. */ toSource(): string; } /** * A placed PICT graphic. */ declare class PICT extends Graphic { /** * Indicates whether the PICT has been flipped independently of its parent * object and, if yes, the direction in which the PICT was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the PICT relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the PICT relative to its containing object. (Range: * -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the PICT relative to its containing object. (Range: * -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the PICT relative to its containing object. */ absoluteVerticalScale: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the PICT. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the PICT. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the PICT. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the PICT. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the PICT. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * Clipping path settings. */ readonly clippingPath: ClippingPathSettings; /** * Transparency settings for the content of the PICT. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the PICT. */ endJoin: EndJoin; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * PICT. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the PICT's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the PICT. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the PICT excluding the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the PICT. (Range: -180 * to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the PICT. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the PICT, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the PICT. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the PICT. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the PICT, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the PICT. */ horizontalScale: number; /** * The unique ID of the PICT. */ readonly id: number; /** * The type of the image. */ readonly imageTypeName: string; /** * The index of the PICT within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the PICT is on. */ itemLayer: Layer; /** * The source file of the link. */ readonly itemLink: Link; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the PICT. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the PICT is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * The name of the PICT. */ name: string; /** * If true, the PICT does not print. */ nonprinting: boolean; /** * If true, the PICT's fill color overprints any underlying objects. If false, * the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the PICT's stroke color overprints any underlying objects. If * false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the PICT (a Snippet, XMLElement, PlaceGun, TextBox, * SignatureField, ComboBox, ListBox, SplineItem, Polygon, GraphicLine, * Rectangle, Oval or State). */ readonly parent: ComboBox | GraphicLine | ListBox | Oval | PlaceGun | Polygon | Rectangle | SignatureField | SplineItem | TextBox | XMLElement | Snippet | State; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the PICT. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the PICT. (Range: -360 to 360) */ shearAngle: number; /** * The stroke alignment applied to the PICT. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the PICT. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the PICT. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the PICT's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the PICT. */ verticalScale: number; /** * If true, the PICT is visible. */ visible: boolean; /** * The bounds of the PICT including the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * Dispatched after a PICT is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a PICT is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the PICT's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the PICT that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the PICT. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the PICT to a different shape. * @param given The PICT's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new PICT. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new PICT. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new PICT. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new PICT. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new PICT. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the PICT at the specified location or offset. * @param to The location of the new PICT, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new PICT from the original PICT's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Exports the PICT for the web. * @param to The full path name of the exported file. */ exportForWeb(to: File): string[]; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the PICT. * @param given The axis around which to flip the PICT. * @param around The point around which to flip the PICT. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PICT[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the PICT to a new location. Note: Either the 'to' or 'by' parameter is * required; if both parameters are defined, only the to value is used. * @param to The new location of the PICT,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the PICT relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the PICT. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the PICT in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new PICT (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the PICT. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the PICT using the last transformation performed on any object. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformAgain(): string[]; /** * Transforms the PICT using the last transformation performed on any PICT. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformAgainIndividually(): string[]; /** * Transforms the PICT using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the PICT using the last sequence of transformations performed on * any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * A collection of PICT graphics. */ declare class PICTs { /** Returns the PICT with the specified index or name. */ [index: number]: PICT; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any PICT in the collection. */ anyItem(): PICT; /** * Displays the number of elements in the PICT. */ count(): number; /** * Returns every PICT in the collection. */ everyItem(): PICT; /** * Returns the first PICT in the collection. */ firstItem(): PICT; /** * Returns the PICT with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): PICT; /** * Returns the PICT with the specified ID. * @param id The ID. */ itemByID(id: number): PICT; /** * Returns the PICT with the specified name. * @param name The name. */ itemByName(name: string): PICT; /** * Returns the PICTs within the specified range. * @param from The PICT, index, or name at the beginning of the range. Can accept: PICT, Long Integer or String. * @param to The PICT, index, or name at the end of the range. Can accept: PICT, Long Integer or String. */ itemByRange(from: number | PICT | string, to: number | PICT | string): PICT[]; /** * Returns the last PICT in the collection. */ lastItem(): PICT; /** * Returns the middle PICT in the collection. */ middleItem(): PICT; /** * Returns the PICT whose index follows the specified PICT in the collection. * @param obj The PICT whose index comes before the desired PICT. */ nextItem(obj: PICT): PICT; /** * Returns the PICT with the index previous to the specified index. * @param obj The index of the PICT that follows the desired PICT. */ previousItem(obj: PICT): PICT; /** * Generates a string which, if executed, will return the PICT. */ toSource(): string; } /** * Color space options for representing color in the exported PNG. */ declare enum PNGColorSpaceEnum { /** * Converts all color values to high-quality black-and-white images. Gray * levels of the converted objects represent the luminosity of the original * objects. */ GRAY = 1766290041, /** * Represents all color values using the RGB color space. Best suited for * documents that will be viewed on-screen. */ RGB = 1666336578, } /** * PNG export preferences. */ declare class PNGExportPreference extends Preference { /** * If true, use anti-aliasing for text and vectors during export. */ antiAlias: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The export resolution expressed as a real number instead of an integer. * (Range: 1.0 to 2400.0) * @remarks Range: 1 to 2400 */ exportResolution: number; /** * If true, export hidden spreads. If false, skip export of hidden spreads. */ exportingHiddenSpread: boolean; /** * If true, exports each spread as a single PNG file. If false, exports facing * pages as separate files and appends sequential numbers to each file name. */ exportingSpread: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The page(s) to export, specified as a page number or an array of page * numbers. Note: Valid when PNG export range is not all. */ pageString: string; /** * The parent of the PNGExportPreference (a Application). */ readonly parent: Application; /** * RGB or Gray */ pngColorSpace: PNGColorSpaceEnum; /** * The page range to export. */ pngExportRange: PNGExportRangeEnum; /** * The compression quality. */ pngQuality: PNGQualityEnum; /** * Suffix to be used at the end of each exported file. */ pngSuffix: string; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, simulates the effects of overprinting spot and process colors in * the same way they would occur when printing. */ simulateOverprint: boolean; /** * If true, use a transparent background for the exported PNG. */ transparentBackground: boolean; /** * If true, uses the document's bleed settings in the exported PNG. */ useDocumentBleeds: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PNGExportPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the PNGExportPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * PNG page export range options. */ declare enum PNGExportRangeEnum { /** * Exports all pages. */ EXPORT_ALL = 1785742657, /** * Exports the page range specified in the page string property. */ EXPORT_RANGE = 1785742674, } /** * Quality options for exported PNG images. */ declare enum PNGQualityEnum { /** * High quality. */ HIGH = 1701726313, /** * Low quality. */ LOW = 1701727351, /** * Maximum quality. */ MAXIMUM = 1701727608, /** * Medium quality. */ MEDIUM = 1701727588, } /** * PPD options. */ declare enum PPDValues { /** * Device-independent. */ DEVICE_INDEPENDENT = 1684367716, } /** * A page. */ declare class Page { /** * Lists all graphics contained by the Page. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the Page. */ readonly allPageItems: PageItem[]; /** * The alternate layout section to which the page belongs. */ readonly appliedAlternateLayout: Section; /** * The master spread applied to the Page. Can also accept: NothingEnum * enumerator. */ appliedMaster: MasterSpread | NothingEnum; /** * The section to which the page belongs. */ readonly appliedSection: Section; /** * The trap preset applied to the page. Can also accept: String. */ appliedTrapPreset: TrapPreset | string; /** * The bounds of the Page, in the format [y1, x1, y2, x2]. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly bounds: (number | string)[]; /** * A collection of buttons. */ readonly buttons: Buttons; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * The sequential number of the page within the document. */ readonly documentOffset: number; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * A collection of form fields. */ readonly formFields: FormFields; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * Default grid properties. Note: Applies to named, layout, and frame (story) * grids. */ readonly gridData: GridDataInformation; /** * A collection of groups. */ readonly groups: Groups; /** * A collection of guides. */ readonly guides: Guides; /** * The unique ID of the Page. */ readonly id: number; /** * The index of the Page within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * layout rule */ layoutRule: LayoutRuleOptions; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * Margin preference settings. */ readonly marginPreferences: MarginPreference; /** * The items on a specified document page that originated on the applied master * page and have not been overridden or detached. Can return: Array of * PageItems, Guides, Graphics, Movies or Sounds. */ readonly masterPageItems: (PageItems | Graphics | Guides | Movies | Sounds)[]; /** * The transform applied to the master page before it is applied to Page. */ masterPageTransform: TransformationMatrix; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * The name of the Page. */ readonly name: string; /** * optional page for HTML5 pagination. Obsolete after CS6 */ optionalPage: boolean; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * The color label of the Page, specified either as an array of three doubles, * each in the range 0 to 255 and representing R, G, and B values, or as a UI * color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator or * PageColorOptions enumerator. */ pageColor: (number[][] | PageColorOptions | UIColors)[]; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the Page (a Spread or MasterSpread). */ readonly parent: MasterSpread | Spread; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * The side of the binding spine on which to place the page within the spread. */ readonly side: PageSideOptions; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * snapshot blending mode */ snapshotBlendingMode: SnapshotBlendingModes; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The order in which the focus moves to different form fields in the PDF when * the tab key is pressed. Can return: Array of Buttons, CheckBoxes, * ComboBoxes, ListBoxes, RadioButtons, TextBoxes or SignatureFields. */ tabOrder: (Buttons | CheckBoxes | ComboBoxes | ListBoxes | RadioButtons | TextBoxes | SignatureFields)[]; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Adjust the existing layout according to new page size, bleed and margin * values. The first parameter is a plain object with key value pairs for * properties affected. Permissible keys are width, height, bleedInside, * bleedTop, bleedOutside, bleedBottom, leftMargin, topMargin, rightMargin, * bottomMargin. The values can be specified as decimal numbers in units of Pt * or as a string having a measurement value such as '1 in'. Not all properties * need to be specified, only the values that need updation. Notice that when * dealing with individual pages rather than the whole document, bleed changes * has no effect. E.g. - app.activeDocument.adjustLayout({width:'600px', * leftMargin: '1in'}), app.activeDocument.adjustLayout({rightMargin:'1in'}, * app.activeDocument.spreads[0].pages), * app.activeDocument.spreads[0].pages[0].adjustLayout({width:'400px', * leftMargin: '10px'}) * @param adoptTo Change values - see functin definition for details * @param affectedPages The collection of Page objects to affect (optional). Has no effect if function is called from Page (Optional) */ adjustLayout(adoptTo: Object, affectedPages?: Page[]): void; /** * Duplicate an object and place it into the target. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param placePoint The point at which to place (Optional) * @param destinationLayer The layer on which to place (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, placePoint?: (number | string)[], destinationLayer?: Layer, showingOptions?: boolean): any[]; /** * Delete all layout snapshots for this Page. */ deleteAllLayoutSnapshots(): void; /** * Delete the snapshot of the layout for the current Page size and shape. */ deleteLayoutSnapshot(): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the page. * @param to The location at which to place the duplicate page relative to the reference object or within the document or spread. (Optional) * @param reference The reference object. Note: Required when the to value specifies before or after. Can accept: Page or Spread. (Optional) */ duplicate(to?: LocationOptions, reference?: Page | Spread): Page; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Page[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Moves the page. * @param to The new location of the page relative to the reference object or within the document or spread. (Optional) * @param reference The reference object. Note: Required when the to parameter value specifies before or after. Can accept: Page or Spread. (Optional) * @param binding The location of the binding spine in spreads. (Optional) */ move(to?: LocationOptions, reference?: Page | Spread, binding?: BindingOptions): Page; /** * Places the file. * @param fileName The file to place * @param placePoint The point at which to place (Optional) * @param destinationLayer The layer on which to place (Optional) * @param showingOptions Whether to display the import options dialog (Optional) * @param autoflowing Whether to autoflow placed text (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, placePoint?: (number | string)[], destinationLayer?: Layer, showingOptions?: boolean, autoflowing?: boolean, withProperties?: Object): any[]; /** * Deprecated: Use contentPlace method. Original Description: Create a linked * story and place it into the target. * @param parentStory The story to place and link from. * @param placePoint The point at which to place (Optional) * @param destinationLayer The layer on which to place (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ placeAndLink(parentStory: Story, placePoint?: (number | string)[], destinationLayer?: Layer, showingOptions?: boolean): Story; /** * Places the XML element onto a page. If the place point is above an existing * page item, place the XML element into the page item. * @param using The XML element to place. * @param placePoint The point at which to place the object, specified in the format [x, y]. * @param autoflowing If true, autoflows placed text. (Optional) */ placeXML(using: XMLElement, placePoint: (number | string)[], autoflowing?: boolean): PageItem; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the Page. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the Page in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Replaces the content of XML element with content imported from a file. * @param using The file path to the import file. * @param relativeBasePath Base path used to resolve relative paths. (Optional) */ setContent(using: string, relativeBasePath?: string): PageItem; /** * Create a snapshot of the layout for the current Page size and shape. */ snapshotCurrentLayout(): void; /** * Generates a string which, if executed, will return the Page. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * The page binding placement. */ declare enum PageBindingOptions { /** * Uses default page binding. */ DEFAULT_VALUE = 1147563124, /** * Pages are bound on the left. */ LEFT_TO_RIGHT = 1819570786, /** * Pages are bound on the right. */ RIGHT_TO_LEFT = 1920232546, } /** * Options for page color label. */ declare enum PageColorOptions { /** * No color. */ NOTHING = 1851876449, /** * Uses the color label of the page's master page. */ USE_MASTER_COLOR = 1346594413, } /** * An item on a page, including rectangles, ellipses, graphic lines, polygons, * groups, text frames, and buttons. */ declare class PageItem { /** * Indicates whether the PageItem has been flipped independently of its parent * object and, if yes, the direction in which the PageItem was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the PageItem relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the PageItem relative to its containing object. * (Range: -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the PageItem relative to its containing object. (Range: * -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the PageItem relative to its containing object. */ absoluteVerticalScale: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the PageItem. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the PageItem. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the PageItem. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the PageItem. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the PageItem. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * Transparency settings for the content of the PageItem. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the PageItem. */ endJoin: EndJoin; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * PageItem. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the PageItem's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the PageItem. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the PageItem excluding the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the PageItem. (Range: * -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the PageItem. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the PageItem, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the PageItem. * (Range: -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the PageItem. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the PageItem, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the PageItem. */ horizontalScale: number; /** * The unique ID of the PageItem. */ readonly id: number; /** * The index of the PageItem within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the PageItem is on. */ itemLayer: Layer; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the PageItem. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the PageItem is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * The name of the PageItem. */ name: string; /** * If true, the PageItem does not print. */ nonprinting: boolean; /** * If true, the PageItem's fill color overprints any underlying objects. If * false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the PageItem's stroke color overprints any underlying objects. If * false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the PageItem (a Snippet, XMLElement, ComboBox, ListBox, * TextBox, SignatureField, CheckBox, RadioButton, Spread, MasterSpread, * Polygon, GraphicLine, Rectangle, Oval, SplineItem, Group, State, Cell, * Button, MultiStateObject, EndnoteTextFrame, TextFrame, Character, Sound, * PlaceGun, Movie, FlexObject, HtmlItem, FormField, MediaItem, EPSText, SVG, * ImportedPage, PICT, WMF, PDF, EPS, Image, Graphic or PageItem). */ readonly parent: Button | Cell | Character | CheckBox | ComboBox | EPS | EPSText | EndnoteTextFrame | FlexObject | FormField | Graphic | GraphicLine | Group | HtmlItem | Image | ImportedPage | ListBox | MasterSpread | MediaItem | Movie | MultiStateObject | Oval | PDF | PICT | PlaceGun | Polygon | RadioButton | Rectangle | SVG | SignatureField | Sound | SplineItem | Spread | State | TextBox | TextFrame | WMF | XMLElement | PageItem | Snippet; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the PageItem. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the PageItem. (Range: -360 to 360) */ shearAngle: number; /** * The stroke alignment applied to the PageItem. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the PageItem. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the PageItem. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the PageItem's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the PageItem. */ verticalScale: number; /** * If true, the PageItem is visible. */ visible: boolean; /** * The bounds of the PageItem including the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * Dispatched after a PageItem is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a PageItem is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the PageItem's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the PageItem that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the PageItem. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the PageItem to a different shape. * @param given The PageItem's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new PageItem. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new PageItem. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new PageItem. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new PageItem. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new PageItem. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the PageItem at the specified location or offset. * @param to The location of the new PageItem, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new PageItem from the original PageItem's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the PageItem. * @param given The axis around which to flip the PageItem. * @param around The point around which to flip the PageItem. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PageItem[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the PageItem to a new location. Note: Either the 'to' or 'by' * parameter is required; if both parameters are defined, only the to value is * used. * @param to The new location of the PageItem,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the PageItem relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the PageItem. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the PageItem in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new PageItem (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the PageItem. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the PageItem using the last transformation performed on any * object. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgain(): string[]; /** * Transforms the PageItem using the last transformation performed on any * PageItem. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgainIndividually(): string[]; /** * Transforms the PageItem using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the PageItem using the last sequence of transformations performed * on any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * Default page item formatting properties. */ declare class PageItemDefault extends Preference { /** * The default graphic object style applied to the PageItemDefault. Can also * accept: String. */ appliedGraphicObjectStyle: ObjectStyle | string; /** * The default frame grid object style applied to the PageItemDefault. Can also * accept: String. */ appliedGridObjectStyle: ObjectStyle | string; /** * The default text object style applied to the PageItemDefault. Can also * accept: String. */ appliedTextObjectStyle: ObjectStyle | string; /** * The arrowhead alignment applied to the PageItemDefault. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * Transparency settings for the content of the PageItemDefault. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the PageItemDefault. */ endJoin: EndJoin; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * PageItemDefault. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the PageItemDefault's fill color. (To specify * a tint percent, use a number in the range of 0 to 100; to use the inherited * or overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the PageItemDefault. */ readonly fillTransparencySettings: FillTransparencySetting; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The angle of a linear gradient applied to the fill of the PageItemDefault. * (Range: -180 to 180) */ gradientFillAngle: number; /** * The angle of a linear gradient applied to the stroke of the PageItemDefault. * (Range: -180 to 180) */ gradientStrokeAngle: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * If true, the PageItemDefault does not print. */ nonprinting: boolean; /** * If true, the PageItemDefault's fill color overprints any underlying objects. * If false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the PageItemDefault's stroke color overprints any underlying * objects. If false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * The parent of the PageItemDefault (a Application or Document). */ readonly parent: Application | Document; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The stroke alignment applied to the PageItemDefault. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the PageItemDefault. Can also accept: String. */ strokeColor: Swatch | string; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the PageItemDefault's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the PageItemDefault's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the PageItemDefault that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PageItemDefault[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the PageItemDefault. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ declare class PageItems { /** Returns the PageItem with the specified index or name. */ [index: number]: PageItem; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any PageItem in the collection. */ anyItem(): PageItem; /** * Displays the number of elements in the PageItem. */ count(): number; /** * Returns every PageItem in the collection. */ everyItem(): PageItem; /** * Returns the first PageItem in the collection. */ firstItem(): PageItem; /** * Returns the PageItem with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): PageItem; /** * Returns the PageItem with the specified ID. * @param id The ID. */ itemByID(id: number): PageItem; /** * Returns the PageItem with the specified name. * @param name The name. */ itemByName(name: string): PageItem; /** * Returns the PageItems within the specified range. * @param from The PageItem, index, or name at the beginning of the range. Can accept: PageItem, Long Integer or String. * @param to The PageItem, index, or name at the end of the range. Can accept: PageItem, Long Integer or String. */ itemByRange(from: number | PageItem | string, to: number | PageItem | string): PageItem[]; /** * Returns the last PageItem in the collection. */ lastItem(): PageItem; /** * Returns the middle PageItem in the collection. */ middleItem(): PageItem; /** * Returns the PageItem whose index follows the specified PageItem in the * collection. * @param obj The PageItem whose index comes before the desired PageItem. */ nextItem(obj: PageItem): PageItem; /** * Returns the PageItem with the index previous to the specified index. * @param obj The index of the PageItem that follows the desired PageItem. */ previousItem(obj: PageItem): PageItem; /** * Generates a string which, if executed, will return the PageItem. */ toSource(): string; } /** * PDF export page layout options. */ declare enum PageLayoutOptions { /** * Uses default page layout. */ DEFAULT_VALUE = 1147563124, /** * Single page layout. */ SINGLE_PAGE = 1987736432, /** * Single page continuous layout. */ SINGLE_PAGE_CONTINUOUS = 1884508259, /** * Two up cover page page layout. */ TWO_UP_COVER_PAGE = 1884570448, /** * Two up cover page continuous page layout. */ TWO_UP_COVER_PAGE_CONTINUOUS = 1884570467, /** * Two up facing page layout. */ TWO_UP_FACING = 1884575046, /** * Two up facing continuous page layout. */ TWO_UP_FACING_CONTINUOUS = 1884571235, } /** * Page number position options. */ declare enum PageNumberPosition { /** * Places page numbers after entry text. */ AFTER_ENTRY = 1634100590, /** * Places page numbers before entry text. */ BEFORE_ENTRY = 1650877806, /** * Turns off page numbers. */ NONE = 1852796517, } /** * Page number style options. */ declare enum PageNumberStyle { /** * Uses Arabic numerals. */ ARABIC = 1298231906, /** * Uses Arabic Abjad */ ARABIC_ABJAD = 1296130410, /** * Uses Arabic Alif Ba Tah */ ARABIC_ALIF_BA_TAH = 1296130420, /** * Uses Arabic numerals and formats all page numbers as three digits. */ DOUBLE_LEADING_ZEROS = 1296329850, /** * Uses Hebrew Biblical */ HEBREW_BIBLICAL = 1296589410, /** * Uses Hebrew Non Standard */ HEBREW_NON_STANDARD = 1296589422, /** * Uses Kanji. */ KANJI = 1296788073, /** * Uses lowercase letters. */ LOWER_LETTERS = 1296855660, /** * Uses lowercase Roman numerals. */ LOWER_ROMAN = 1297247596, /** * Uses Arabic numerals and formats all page numbers as two digits. */ SINGLE_LEADING_ZEROS = 1297312890, /** * Uses Arabic numerals and formats all page numbers as four digits. */ TRIPLE_LEADING_ZEROS = 1297378426, /** * Uses uppercase letters. */ UPPER_LETTERS = 1296855669, /** * Uses uppercase Roman numerals. */ UPPER_ROMAN = 1297247605, } /** * The preferences for a page number variable. */ declare class PageNumberVariablePreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The format for the variable. */ format: VariableNumberingStyles; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the PageNumberVariablePreference (a TextVariable). */ readonly parent: TextVariable; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The scope or range of the pages to include. */ scope: VariableScopes; /** * The text that follows the value of the variable. (Limit: 128 characters) */ textAfter: string; /** * The text that precedes the value of the variable. (Limit: 128 characters) */ textBefore: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PageNumberVariablePreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * PageNumberVariablePreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for page numbering. */ declare enum PageNumberingOptions { /** * Numbers all pages in the document sequentially. */ ABSOLUTE = 1096971116, /** * Numbers pages according to page numbering specifications of the section. */ SECTION = 1935897710, } /** * Page orientation options. */ declare enum PageOrientation { /** * Landscape. */ LANDSCAPE = 2003395685, /** * Portrait. */ PORTRAIT = 1751738216, } /** * Options for positioning the page on the paper or film. */ declare enum PagePositions { /** * Centers the page horizontally and vertically. */ CENTERED = 1668183106, /** * Centers the page horizontally. */ CENTER_HORIZONTALLY = 1668183112, /** * Centers the page vertically. */ CENTER_VERTICALLY = 1668183126, /** * Places the page in the upper left corner. */ UPPER_LEFT = 1668183118, } /** * Page range options. */ declare enum PageRange { /** * Print or export all pages in the document. */ ALL_PAGES = 1886547553, /** * Export selected items in the document. */ SELECTED_ITEMS = 1886547571, } /** * Choices for page range format for export. */ declare enum PageRangeFormat { /** * export all pages. */ EXPORT_ALL_PAGES = 1700883568, /** * export page ranges. */ EXPORT_PAGE_RANGE = 1700951410, } /** * The page reference for an index topic. */ declare class PageReference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the PageReference. */ readonly id: number; /** * The index of the PageReference within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the PageReference; this is an alias to the PageReference's label * property. */ name: string; /** * The character style applied to page numbers. */ pageNumberStyleOverride: CharacterStyle; /** * The paragraph style or number of paragraphs or pages that defines the last * page in a page range. Note: Valid only when page reference type specifies * the next use of a paragraph style or a number of paragraphs or pages. . Can * return: ParagraphStyle or Long Integer. */ pageReferenceLimit: ParagraphStyle | number; /** * Options for index page references. */ pageReferenceType: PageReferenceType; /** * The parent of the PageReference (a Topic). */ readonly parent: Topic; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The hyperlinked text or insertion point. */ readonly sourceText: Text; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PageReference[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the PageReference. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the PageReference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for index page references. */ declare enum PageReferenceType { /** * The page on which the index entry is located. */ CURRENT_PAGE = 1668444263, /** * The range of pages from the page containing the inedex entry to the nth page * after that page (where n is the number of pages to include). */ FOR_NEXT_N_PAGES = 1718513767, /** * The range of pages from the page containing the index entry to the page * containing the nth full paragraph from the paragraph containing the index * entry (where n is the number of paragraphs to include). */ FOR_NEXT_N_PARAGRAPHS = 1718513778, /** * Turns off page numbers for the index topic. */ SUPPRESS_PAGE_NUMBERS = 1852863079, /** * The last page in the document. */ TO_END_OF_DOCUMENT = 1701799011, /** * The last page in the numbered section containing the index entry. */ TO_END_OF_SECTION = 1701802851, /** * The last page in the story containing the index entry. */ TO_END_OF_STORY = 1701802868, /** * The range of pages from the page containing the index entry to the page * containing the next paragraph style change. */ TO_NEXT_STYLE_CHANGE = 1953395555, /** * The range of pages from the page containing the index entry to the page that * contains the next occurrance of the specified paragraph style. If no * paragraph style is specified, the paragraph style of the index entry * paragraph is used. */ TO_NEXT_USE_OF_STYLE = 1953396083, } /** * A collection of index page references. */ declare class PageReferences { /** Returns the PageReference with the specified index or name. */ [index: number]: PageReference; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new page reference. * @param source The text or insertion point to which the page reference points. * @param pageReferenceType The page number for an index page reference or the last page in an index page reference page range. (Optional) * @param pageReferenceLimit The paragraph style or number of paragraphs or pages that defines the last page in a page range. Valid only when page reference type specifies the next use of a paragraph style or a number of paragraphs or pages. . Can accept: ParagraphStyle or Long Integer. (Optional) * @param pageNumberStyleOverride The style override for the page number. (Optional) * @param withProperties Initial values for properties of the new PageReference (Optional) */ add(source: Text, pageReferenceType?: PageReferenceType, pageReferenceLimit?: ParagraphStyle | number, pageNumberStyleOverride?: CharacterStyle, withProperties?: Object): PageReference; /** * Returns any PageReference in the collection. */ anyItem(): PageReference; /** * Displays the number of elements in the PageReference. */ count(): number; /** * Returns every PageReference in the collection. */ everyItem(): PageReference; /** * Returns the first PageReference in the collection. */ firstItem(): PageReference; /** * Returns the PageReference with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): PageReference; /** * Returns the PageReference with the specified ID. * @param id The ID. */ itemByID(id: number): PageReference; /** * Returns the PageReference with the specified name. * @param name The name. */ itemByName(name: string): PageReference; /** * Returns the PageReferences within the specified range. * @param from The PageReference, index, or name at the beginning of the range. Can accept: PageReference, Long Integer or String. * @param to The PageReference, index, or name at the end of the range. Can accept: PageReference, Long Integer or String. */ itemByRange(from: number | PageReference | string, to: number | PageReference | string): PageReference[]; /** * Returns the last PageReference in the collection. */ lastItem(): PageReference; /** * Returns the middle PageReference in the collection. */ middleItem(): PageReference; /** * Returns the PageReference whose index follows the specified PageReference in * the collection. * @param obj The PageReference whose index comes before the desired PageReference. */ nextItem(obj: PageReference): PageReference; /** * Returns the PageReference with the index previous to the specified index. * @param obj The index of the PageReference that follows the desired PageReference. */ previousItem(obj: PageReference): PageReference; /** * Generates a string which, if executed, will return the PageReference. */ toSource(): string; } /** * Binding spine placement options. */ declare enum PageSideOptions { /** * The page is on the left side of the binding spine in the spread. */ LEFT_HAND = 1818653800, /** * The page is on the right side of the binding spine in the spread. */ RIGHT_HAND = 1919382632, /** * The page is a single-sided page. */ SINGLE_SIDED = 1970496888, } /** * The page transition direction options. */ declare enum PageTransitionDirectionOptions { /** * The top to bottom direction. */ DOWN = 1181971556, /** * The horizontal direction. */ HORIZONTAL = 1752134266, /** * The horizontal inward direction. */ HORIZONTAL_IN = 1886668873, /** * The horizontal outward direction. */ HORIZONTAL_OUT = 1886668879, /** * The inward direction. */ IN = 1768824864, /** * The down and left direction. */ LEFT_DOWN = 1886669892, /** * The left to right direction. */ LEFT_TO_RIGHT = 1819570786, /** * The up and left direction. */ LEFT_UP = 1886669909, /** * Direction does not apply. */ NOT_APPLICABLE = 1886670401, /** * The outward direction. */ OUT = 1886670708, /** * The down and right direction. */ RIGHT_DOWN = 1886671428, /** * The right to left direction. */ RIGHT_TO_LEFT = 1920232546, /** * The up and right direction. */ RIGHT_UP = 1886671445, /** * The bottom to top direction. */ UP = 1181971566, /** * The vertical direction. */ VERTICAL = 1986359924, /** * The vertical inward direction. */ VERTICAL_IN = 1886672457, /** * The vertical outward direction. */ VERTICAL_OUT = 1886672463, } /** * The page transition duration options. */ declare enum PageTransitionDurationOptions { /** * Fast duration. */ FAST = 1180791668, /** * Medium duration. */ MEDIUM = 1701727588, /** * Slow duration. */ SLOW = 1886671692, } /** * Page transition to use as an override when exporting. */ declare enum PageTransitionOverrideOptions { /** * The Blinds page transition. */ BLINDS_TRANSITION = 1886667372, /** * The Blinds page transition. */ BOX_TRANSITION = 1886667384, /** * The Comb page transition. */ COMB_TRANSITION = 1886667618, /** * The Cover page transition. */ COVER_TRANSITION = 1886667638, /** * The Dissolve page transition. */ DISSOLVE_TRANSITION = 1886667891, /** * The Fade page transition. */ FADE_TRANSITION = 1886668388, /** * Use the page transition from the document. */ FROM_DOCUMENT = 1718764655, /** * No page transition applied. */ NONE = 1852796517, /** * The Page Turn page transition (SWF only). */ PAGE_TURN_TRANSITION = 1886670932, /** * The Push page transition. */ PUSH_TRANSITION = 1886670963, /** * The Split page transition. */ SPLIT_TRANSITION = 1886671728, /** * The Uncover page transition. */ UNCOVER_TRANSITION = 1886672227, /** * The Wipe page transition. */ WIPE_TRANSITION = 1886672752, /** * The Zoom In page transition. */ ZOOM_IN_TRANSITION = 1886673481, /** * The Zoom Out page transition. */ ZOOM_OUT_TRANSITION = 1886673487, } /** * The page transition type options. */ declare enum PageTransitionTypeOptions { /** * The Blinds page transition. */ BLINDS_TRANSITION = 1886667372, /** * The Blinds page transition. */ BOX_TRANSITION = 1886667384, /** * The Comb page transition. */ COMB_TRANSITION = 1886667618, /** * The Cover page transition. */ COVER_TRANSITION = 1886667638, /** * The Dissolve page transition. */ DISSOLVE_TRANSITION = 1886667891, /** * The Fade page transition. */ FADE_TRANSITION = 1886668388, /** * No page transition applied. */ NONE = 1852796517, /** * The Push page transition. */ PUSH_TRANSITION = 1886670963, /** * The Split page transition. */ SPLIT_TRANSITION = 1886671728, /** * The Uncover page transition. */ UNCOVER_TRANSITION = 1886672227, /** * The Wipe page transition. */ WIPE_TRANSITION = 1886672752, /** * The Zoom In page transition. */ ZOOM_IN_TRANSITION = 1886673481, /** * The Zoom Out page transition. */ ZOOM_OUT_TRANSITION = 1886673487, } /** * options for viewing pages in Pages Panel */ declare enum PageViewOptions { /** * Pages arranged in vertical columns by alternate layout. */ BY_ALTERNATE_LAYOUT = 1987277931, /** * Pages arranged in horizontal rows. */ HORIZONTALLY = 1752396907, /** * Pages arranged in a vertical column. */ VERTICALLY = 1987211127, } /** * A collection of pages. */ declare class Pages { /** Returns the Page with the specified index or name. */ [index: number]: Page; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new page. * @param at The location of the new page relative to the reference object or within the document or spread. (Optional) * @param reference The reference object. Note: Required when the at parameter value specifies before or after. Can accept: Page, Spread, MasterSpread or Document. (Optional) * @param withProperties Initial values for properties of the new Page (Optional) */ add(at?: LocationOptions, reference?: MasterSpread | Page | Spread | Document, withProperties?: Object): Page; /** * Returns any Page in the collection. */ anyItem(): Page; /** * Displays the number of elements in the Page. */ count(): number; /** * Returns every Page in the collection. */ everyItem(): Page; /** * Returns the first Page in the collection. */ firstItem(): Page; /** * Returns the Page with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Page; /** * Returns the Page with the specified ID. * @param id The ID. */ itemByID(id: number): Page; /** * Returns the Page with the specified name. * @param name The name. */ itemByName(name: string): Page; /** * Returns the Pages within the specified range. * @param from The Page, index, or name at the beginning of the range. Can accept: Page, Long Integer or String. * @param to The Page, index, or name at the end of the range. Can accept: Page, Long Integer or String. */ itemByRange(from: number | Page | string, to: number | Page | string): Page[]; /** * Returns the last Page in the collection. */ lastItem(): Page; /** * Returns the middle Page in the collection. */ middleItem(): Page; /** * Returns the Page whose index follows the specified Page in the collection. * @param obj The Page whose index comes before the desired Page. */ nextItem(obj: Page): Page; /** * Returns the Page with the index previous to the specified index. * @param obj The index of the Page that follows the desired Page. */ previousItem(obj: Page): Page; /** * Generates a string which, if executed, will return the Page. */ toSource(): string; } /** * Pages panel. */ declare class PagesPanel extends Panel { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Page icon size. */ iconSize: IconSizes; /** * The index of the PagesPanel within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * Master page icon size. */ masterIconSize: IconSizes; /** * If true, master page icons will be arranged vertically around the binding * spine. If false, master page icons will be arranged horizontally. */ masterVerticalView: boolean; /** * If true, display thumbnails of the pages in the master pages area of the * panel. */ mastersThumbnails: boolean; /** * The name of the PagesPanel. */ readonly name: string; /** * If true, the pages area of the panel will be drawn above the master pages * area. */ pagesOnTop: boolean; /** * If true, display thumbnails of the pages in the pages area of the panel. */ pagesThumbnails: boolean; /** * View setting for how to arrange the pages in the page section of the panel. */ pagesViewSetting: PageViewOptions; /** * The parent of the PagesPanel (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Specifies the behavior of the document and master page areas of the panel * when the panel is resized. */ resizeBehavior: PanelLayoutResize; /** * If true, a rotation icon will display next to spreads with non-zero rotation * applied. */ rotationIcons: boolean; /** * If true, a page transitions icon will display next to spreads with page * transitions applied. */ transitionsIcons: boolean; /** * If true, a transparency icon will display next to spreads with elements * having transparency applied. */ transparencyIcons: boolean; /** * If true, the panel is visible. */ visible: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PagesPanel[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the PagesPanel. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A panel (possibly within a panel group). */ declare class Panel { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the Panel within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the Panel. */ readonly name: string; /** * The parent of the Panel (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, the panel is visible. */ visible: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Panel[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Panel. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Palette layout resizing options. */ declare enum PanelLayoutResize { /** * Do not resize master pages panel area when resizing panel. */ MASTERS_FIXED = 1886416230, /** * Do not resize document pages panel area when resizing panel. */ PAGES_FIXED = 1886414456, /** * Resize panel areas proportionally. */ PROPORTIONAL_RESIZE = 1886417010, } /** * A collection of panels. */ declare class Panels { /** Returns the Panel with the specified index or name. */ [index: number]: Panel; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Panel in the collection. */ anyItem(): Panel; /** * Displays the number of elements in the Panel. */ count(): number; /** * Returns every Panel in the collection. */ everyItem(): Panel; /** * Returns the first Panel in the collection. */ firstItem(): Panel; /** * Returns the Panel with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Panel; /** * Returns the Panel with the specified name. * @param name The name. */ itemByName(name: string): Panel; /** * Returns the Panels within the specified range. * @param from The Panel, index, or name at the beginning of the range. Can accept: Panel, Long Integer or String. * @param to The Panel, index, or name at the end of the range. Can accept: Panel, Long Integer or String. */ itemByRange(from: number | Panel | string, to: number | Panel | string): Panel[]; /** * Returns the last Panel in the collection. */ lastItem(): Panel; /** * Returns the middle Panel in the collection. */ middleItem(): Panel; /** * Returns the Panel whose index follows the specified Panel in the collection. * @param obj The Panel whose index comes before the desired Panel. */ nextItem(obj: Panel): Panel; /** * Returns the Panel with the index previous to the specified index. * @param obj The index of the Panel that follows the desired Panel. */ previousItem(obj: Panel): Panel; /** * Generates a string which, if executed, will return the Panel. */ toSource(): string; } /** * The display performance settings to use while scrolling. */ declare enum PanningTypes { /** * While scrolling, greeks newly revealed images until the mouse is released; * medium quality display with medium performance speed. */ GREEK_IMAGES = 1699111248, /** * While scrolling, greeks newly revealed images and text until the mouse is * released; highest quality display with the slowest performance. */ GREEK_IMAGES_AND_TEXT = 1699639120, /** * While scrolling, does not greek images or text; lowest quality display with * the fastest performance. */ NO_GREEKING = 1699116368, } /** * Paper size options. */ declare enum PaperSize { /** * Automatic */ AUTO = 1635019116, } /** * Paper size optons. */ declare enum PaperSizes { /** * Allows definition of a custom paper size. Note: Not all printers allow * custom paper sizes. */ CUSTOM = 1131639917, /** * Allows the printer driver to define the paper size. */ DEFINED_BY_DRIVER = 1347634290, } /** * A para style mapping. */ declare class ParaStyleMapping { /** * The destination style name property. */ destinationStyleName: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the ParaStyleMapping within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The type of the mapping rule. */ mappingRuleType: MapType; /** * The parent of the ParaStyleMapping (a Application, Document, Story or * XmlStory). */ readonly parent: Document | Story | Application | XmlStory; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The source style name property. */ sourceStyleName: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ParaStyleMapping[]; /** * deletes a style mapping. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ParaStyleMapping. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of para style mappings. */ declare class ParaStyleMappings { /** Returns the ParaStyleMapping with the specified index or name. */ [index: number]: ParaStyleMapping; /** * The number of objects in the collection. */ readonly length: number; /** * Adds a style mapping. * @param sourceStyleName The source style name. * @param destinationStyleName The destination style name. * @param mappingRuleType The mapping type * @param withProperties Initial values for properties of the new ParaStyleMapping (Optional) */ add(sourceStyleName: string, destinationStyleName: string, mappingRuleType: MapType, withProperties?: Object): ParaStyleMapping; /** * Returns any ParaStyleMapping in the collection. */ anyItem(): ParaStyleMapping; /** * Displays the number of elements in the ParaStyleMapping. */ count(): number; /** * Returns every ParaStyleMapping in the collection. */ everyItem(): ParaStyleMapping; /** * Returns the first ParaStyleMapping in the collection. */ firstItem(): ParaStyleMapping; /** * Returns the ParaStyleMapping with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): ParaStyleMapping; /** * Returns the ParaStyleMappings within the specified range. * @param from The ParaStyleMapping, index, or name at the beginning of the range. Can accept: ParaStyleMapping, Long Integer or String. * @param to The ParaStyleMapping, index, or name at the end of the range. Can accept: ParaStyleMapping, Long Integer or String. */ itemByRange(from: number | ParaStyleMapping | string, to: number | ParaStyleMapping | string): ParaStyleMapping[]; /** * Returns the last ParaStyleMapping in the collection. */ lastItem(): ParaStyleMapping; /** * Returns the middle ParaStyleMapping in the collection. */ middleItem(): ParaStyleMapping; /** * Returns the ParaStyleMapping whose index follows the specified * ParaStyleMapping in the collection. * @param obj The ParaStyleMapping whose index comes before the desired ParaStyleMapping. */ nextItem(obj: ParaStyleMapping): ParaStyleMapping; /** * Returns the ParaStyleMapping with the index previous to the specified index. * @param obj The index of the ParaStyleMapping that follows the desired ParaStyleMapping. */ previousItem(obj: ParaStyleMapping): ParaStyleMapping; /** * Generates a string which, if executed, will return the ParaStyleMapping. */ toSource(): string; } /** * A paragraph. */ declare class Paragraph extends Text { /** * If true, aligns the baseline of the text to the baseline grid. */ alignToBaseline: boolean; /** * Lists all graphics contained by the Paragraph. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the Paragraph. */ readonly allPageItems: PageItem[]; /** * If true, words unassociated with a hyphenation dictionary can break to the * next line on any character. */ allowArbitraryHyphenation: boolean; /** * The character style applied to the text. Can also accept: String. */ appliedCharacterStyle: CharacterStyle | string; /** * The applied conditions. */ appliedConditions: Condition[]; /** * The font applied to the Paragraph, specified as either a font object or the * name of font family. Can return: Font or String. */ appliedFont: Font | string; /** * The language of the text. Can return: LanguageWithVendors or Language. Can * also accept: String. */ appliedLanguage: LanguageWithVendors | string | Language; /** * The applied character styles dictated by nested styles. */ readonly appliedNestedStyles: CharacterStyle[]; /** * The list to be part of. Can return: NumberingList or String. */ appliedNumberingList: NumberingList | string; /** * The paragraph style applied to the text. Can also accept: String. */ appliedParagraphStyle: ParagraphStyle | string; /** * The maximum ascent of any character in the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly ascent: number | string; /** * The XML elements associated with the Paragraph. */ readonly associatedXMLElements: XMLItem[]; /** * The percent of the type size to use for auto leading. (Range: 0 to 500). * @remarks Range: 0 to 500 */ autoLeading: number; /** * The number of half-width characters at or below which the characters * automatically run horizontally in vertical text. */ autoTcy: number; /** * If true, auto tcy includes Roman characters. */ autoTcyIncludeRoman: boolean; /** * If true or set to an enumeration value, balances ragged lines. Note: Not * valid with a single-line text composer. Can return: Boolean or * BalanceLinesStyle enumerator. */ balanceRaggedLines: boolean | BalanceLinesStyle; /** * The vertical offset of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly baseline: number | string; /** * The baseline shift applied to the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ baselineShift: number | string; /** * Bullet character. */ readonly bulletChar: Bullet; /** * The alignment of the bullet character. */ bulletsAlignment: ListAlignment; /** * List type for bullets and numbering. */ bulletsAndNumberingListType: ListType; /** * The current bullets or numbering string. */ readonly bulletsAndNumberingResultText: string; /** * The character style to be used for the text after string. Can return: * CharacterStyle or String. */ bulletsCharacterStyle: CharacterStyle | string; /** * The text after string expression for bullets. */ bulletsTextAfter: string; /** * If true, adds the double period (..), ellipse (...), and double hyphen (--) * to the selected kinsoku set. Note: Valid only when a kinsoku set is in * effect. */ bunriKinshi: boolean; /** * A collection of buttons. */ readonly buttons: Buttons; /** * The capitalization scheme. */ capitalization: Capitalization; /** * The alignment of small characters to the largest character in the line. */ characterAlignment: CharacterAlignment; /** * The direction of the character. */ characterDirection: CharacterDirectionOptions; /** * The rotation angle (in degrees) of individual characters. Note: The rotation * is counterclockwise. */ characterRotation: number; /** * A collection of characters. */ readonly characters: Characters; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * If true, uses grid tracking to track non-Roman characters in CJK grids. */ cjkGridTracking: boolean; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * The text composer to use to compose the text. */ composer: string; /** * The contents of the text. Can return: String or SpecialCharacters * enumerator. */ contents: string | SpecialCharacters; /** * The maximum descent of any character in the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly descent: number | string; /** * Value of Design Axes */ designAxes: number[]; /** * The desired width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ desiredGlyphScaling: number; /** * The desired letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) */ desiredLetterSpacing: number; /** * The desired word spacing, specified as a percentage of the font word space * value. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ desiredWordSpacing: number; /** * Position of diacriticical characters. */ diacriticPosition: DiacriticPositionOptions; /** * The digits type. */ digitsType: DigitsTypeOptions; /** * The number of characters to drop cap. * @remarks Range: 0 to 150 */ dropCapCharacters: number; /** * The number of lines to drop cap. * @remarks Range: 0 to 25 */ dropCapLines: number; /** * The character style to apply to the drop cap. Can also accept: String. */ dropCapStyle: CharacterStyle | string; /** * Details about the drop cap based on the glyph outlines. 1 = left side * bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid. */ dropcapDetail: number; /** * Vertical offset of the end of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly endBaseline: number | string; /** * Horizontal offset of the end of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly endHorizontalOffset: number | string; /** * The stroke join type applied to the characters of the text. */ endJoin: OutlineJoin; /** * A collection of endnote text ranges. */ readonly endnoteRanges: EndnoteRanges; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * Paragraph. . Can also accept: String. */ fillColor: Swatch | string; /** * The tint (as a percentage) of the fill color of the Paragraph. (To specify a * tint percentage, use a number in the range of 0 to 100; to use the inherited * or overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * The amount to indent the first line. * @remarks Measurement unit — also accepts a string such as "12mm". */ firstLineIndent: number | string; /** * The name of the font style. */ fontStyle: string; /** * A collection of footnotes. */ readonly footnotes: Footnotes; /** * A collection of form fields. */ readonly formFields: FormFields; /** * The glyph variant to substitute for standard glyphs. */ glyphForm: AlternateGlyphForms; /** * The angle of a linear gradient applied to the fill of the text. (Range: -180 * to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the text. */ gradientFillLength: number; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the text. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the text. */ gradientStrokeLength: number; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * If true, aligns only the first line to the frame grid or baseline grid. If * false, aligns all lines to the grid. */ gridAlignFirstLineOnly: boolean; /** * The alignment to the frame grid or baseline grid. */ gridAlignment: GridAlignment; /** * The manual gyoudori setting. */ gridGyoudori: number; /** * A collection of groups. */ readonly groups: Groups; /** * A collection of hidden text objects. */ readonly hiddenTexts: HiddenTexts; /** * The horizontal offset of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly horizontalOffset: number | string; /** * The horizontal scaling applied to the Paragraph. */ horizontalScale: number; /** * The relative desirability of better spacing vs. fewer hyphens. A lower value * results in greater use of hyphens. (Range: 0 to 100) * @remarks Range: 0 to 10 */ hyphenWeight: number; /** * If true, allows the last word in a text column to be hyphenated. */ hyphenateAcrossColumns: boolean; /** * The mininum number of letters at the beginning of a word that can be broken * by a hyphen. * @remarks Range: 1 to 15 */ hyphenateAfterFirst: number; /** * The minimum number of letters at the end of a word that can be broken by a * hyphen. * @remarks Range: 1 to 15 */ hyphenateBeforeLast: number; /** * If true, allows hyphenation of capitalized words. */ hyphenateCapitalizedWords: boolean; /** * The maximum number of hyphens that can appear on consecutive lines. To * specify unlimited consecutive lines, use zero. * @remarks Range: 0 to 25 */ hyphenateLadderLimit: number; /** * If true, allows hyphenation in the last word in a paragraph. Note: Valid * only when hyphenation is true. */ hyphenateLastWord: boolean; /** * The minimum number of letters a word must have in order to qualify for * hyphenation. * @remarks Range: 3 to 25 */ hyphenateWordsLongerThan: number; /** * If true, allows hyphenation. */ hyphenation: boolean; /** * The amount of white space allowed at the end of a line of non-justified text * before hypenation begins. Note: Valid when composer is single-line composer. * @remarks Measurement unit — also accepts a string such as "12mm". */ hyphenationZone: number | string; /** * If true, ignores optical edge alignment for the paragraph. */ ignoreEdgeAlignment: boolean; /** * The index of the text in the collection or parent object. */ readonly index: number; /** * A collection of insertion points. */ readonly insertionPoints: InsertionPoints; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The number of grid squares in which to arrange the text. */ jidori: number; /** * The paragraph alignment. */ justification: Justification; /** * Use of Kashidas for justification */ kashidas: KashidasOptions; /** * If true, keeps all lines of the paragraph together. If false, allows * paragraphs to break across pages or columns. */ keepAllLinesTogether: boolean; /** * The minimum number of lines to keep together in a paragraph before allowing * a page break. * @remarks Range: 1 to 50 */ keepFirstLines: number; /** * The minimum number of lines to keep together in a paragraph after a page * break. * @remarks Range: 1 to 50 */ keepLastLines: number; /** * If true, keeps a specified number of lines together when the paragraph * breaks across columns or text frames. */ keepLinesTogether: boolean; /** * If true, forces the rule above the paragraph to remain in the frame bounds. * Note: Valid only when rule above is true. */ keepRuleAboveInFrame: boolean; /** * The minimum number of lines to keep with the next paragraph. * @remarks Range: 0 to 5 */ keepWithNext: number; /** * If the first line in the paragraph should be kept with the last line of * previous paragraph. */ keepWithPrevious: boolean; /** * The alignment of kenten characters relative to the parent characters. */ kentenAlignment: KentenAlignment; /** * The character set used for the custom kenten character. Note: Valid only * when kenten kind is custom. */ kentenCharacterSet: KentenCharacterSet; /** * The character used for kenten. Note: Valid only when kenten kind is custom. */ kentenCustomCharacter: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of * kenten characters. Can return: Swatch or String. */ kentenFillColor: Swatch | string; /** * The font to use for kenten characters. Can return: Font or String. */ kentenFont: Font | string; /** * The size (in points) of kenten characters. */ kentenFontSize: number; /** * The font style of kenten characters. Can return: String or NothingEnum * enumerator. */ kentenFontStyle: string | NothingEnum; /** * The style of kenten characters. */ kentenKind: KentenCharacter; /** * The method of overprinting the kenten fill. */ kentenOverprintFill: AdornmentOverprint; /** * The method of overprinting the kenten stroke. */ kentenOverprintStroke: AdornmentOverprint; /** * The distance between kenten characters and their parent characters. */ kentenPlacement: number; /** * The kenten position relative to the parent character. */ kentenPosition: RubyKentenPosition; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * kenten characters. Can return: Swatch or String. */ kentenStrokeColor: Swatch | string; /** * The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenStrokeTint: number; /** * The fill tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenTint: number; /** * The stroke weight (in points) of kenten characters. */ kentenWeight: number; /** * The horizontal size of kenten characters as a percent of the original size. */ kentenXScale: number; /** * The vertical size of kenten charachers as a percent of the original size. */ kentenYScale: number; /** * The type of pair kerning. */ kerningMethod: string; /** * The amount of space to add or remove between characters, specified in * thousands of an em. */ kerningValue: number; /** * The keyboard direction of the character. */ keyboardDirection: CharacterDirectionOptions; /** * The type of hanging punctuation to allow. Note: Valid only when a kinsoku * set is in effect. */ kinsokuHangType: KinsokuHangTypes; /** * The kinsoku set that determines legitimate line breaks. Can return: * KinsokuTable, KinsokuSet enumerator or String. */ kinsokuSet: KinsokuSet | KinsokuTable | string; /** * The type of kinsoku processing for preventing kinsoku characters from * beginning or ending a line. Note: Valid only when a kinsoku set is defined. */ kinsokuType: KinsokuType; /** * The amount to indent the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ lastLineIndent: number | string; /** * The leading applied to the text. Can return: Unit or Leading enumerator. */ leading: number | Leading; /** * The amount of space before each character. */ leadingAki: number; /** * The point from which leading is measured from line to line. */ leadingModel: LeadingModel; /** * The width of the left indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ leftIndent: number | string; /** * The number of objects in the collection. */ readonly length: number; /** * If true, replaces specific character combinations (e.g., fl, fi) with * ligature characters. */ ligatures: boolean; /** * A collection of lines. */ readonly lines: Lines; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * The maximum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ maximumGlyphScaling: number; /** * The maximum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ maximumLetterSpacing: number; /** * The maximum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ maximumWordSpacing: number; /** * If true, consecutive para borders with completely similar properties are * merged. */ mergeConsecutiveParaBorders: boolean; /** * The minimum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ minimumGlyphScaling: number; /** * The minimum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ minimumLetterSpacing: number; /** * The minimum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ minimumWordSpacing: number; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 0 to 1000 */ miterLimit: number; /** * The mojikumi table. For information, see mojikumi table defaults. Can * return: MojikumiTable, String or MojikumiTableDefaults enumerator. */ mojikumi: MojikumiTable | string | MojikumiTableDefaults; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * A collection of nested GREP styles. */ readonly nestedGrepStyles: NestedGrepStyles; /** * A collection of nested line styles. */ readonly nestedLineStyles: NestedLineStyles; /** * A collection of nested styles. */ readonly nestedStyles: NestedStyles; /** * If true, keeps the text on the same line. */ noBreak: boolean; /** * A collection of notes. */ readonly notes: Notes; /** * The alignment of the number. */ numberingAlignment: ListAlignment; /** * If true, apply the numbering restart policy. */ numberingApplyRestartPolicy: boolean; /** * The character style to be used for the number string. Can return: * CharacterStyle or String. */ numberingCharacterStyle: CharacterStyle | string; /** * Continue the numbering at this level. */ numberingContinue: boolean; /** * The number string expression for numbering. */ numberingExpression: string; /** * Numbering format options. Can return: NumberingStyle enumerator or String. */ numberingFormat: NumberingStyle | string; /** * The level of the paragraph. */ numberingLevel: number; /** * Numbering restart policies. */ readonly numberingRestartPolicies: NumberingRestartPolicy; /** * The current level number value. */ readonly numberingResultNumber: number; /** * Determines starting number in a numbered list. */ numberingStartAt: number; /** * OpenType features. Can return: Array of Array of 2 Strings or Long Integers. */ opentypeFeatures: (string[][] | number[])[]; /** * If true, uses contextual alternate forms in OpenType fonts. */ otfContextualAlternate: boolean; /** * If true, uses discretionary ligatures in OpenType fonts. */ otfDiscretionaryLigature: boolean; /** * The figure style in OpenType fonts. */ otfFigureStyle: OTFFigureStyle; /** * If true, uses fractions in OpenType fonts. */ otfFraction: boolean; /** * If true, switches hiragana fonts, which have different glyphs for horizontal * and vertical. */ otfHVKana: boolean; /** * If true, use historical forms in OpenType fonts. */ otfHistorical: boolean; /** * If true, use alternate justification forms in OpenType fonts */ otfJustificationAlternate: boolean; /** * If true, uses localized forms in OpenType fonts. */ otfLocale: boolean; /** * If true, uses mark positioning in OpenType fonts. */ otfMark: boolean; /** * If true, uses ordinals in OpenType fonts. */ otfOrdinal: boolean; /** * If true, use overlapping swash forms in OpenType fonts */ otfOverlapSwash: boolean; /** * If true, kerns according to proportional CJK metrics in OpenType fonts. */ otfProportionalMetrics: boolean; /** * If true, applies italics to half-width alphanumerics. */ otfRomanItalics: boolean; /** * If true, use a slashed zeroes in OpenType fonts. */ otfSlashedZero: boolean; /** * If true, use stretched alternate forms in OpenType fonts */ otfStretchedAlternate: boolean; /** * If true, use stylistic alternate forms in OpenType fonts */ otfStylisticAlternate: boolean; /** * The stylistic sets to use in OpenType fonts. */ otfStylisticSets: number; /** * If true, uses swash forms in OpenType fonts. */ otfSwash: boolean; /** * If true, uses titling forms in OpenType fonts. */ otfTitling: boolean; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the fill color of the characters will overprint. */ overprintFill: boolean; /** * If true, the stroke of the characters will overprint. */ overprintStroke: boolean; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphBorderBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLeftCornerRadius: number | string; /** * The bottom line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLineWeight: number | string; /** * The distance to offset the bottom edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph border. */ paragraphBorderBottomOrigin: ParagraphBorderBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphBorderBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomRightCornerRadius: number | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * stroke. Can return: Swatch or String. */ paragraphBorderColor: Swatch | string; /** * If true, then paragraph border is also displayed at the points where the * paragraph splits across frames or columns. */ paragraphBorderDisplayIfSplits: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * border gap. Note: Valid only when the border type is not solid. Can return: * Swatch or String. */ paragraphBorderGapColor: Swatch | string; /** * If true, the paragraph border gap will overprint. Note: Valid only when * border type is not solid. */ paragraphBorderGapOverprint: boolean; /** * The tint (as a percentage) of the paragraph border gap. Note: Valid only * when the border type is not solid. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderGapTint: number; /** * The left line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftLineWeight: number | string; /** * The distance to offset the left edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftOffset: number | string; /** * If true, the paragraph border is on. */ paragraphBorderOn: boolean; /** * If true, the paragraph border will overprint. */ paragraphBorderOverprint: boolean; /** * The right line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightLineWeight: number | string; /** * The distance to offset the right edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightOffset: number | string; /** * The end shape of an open path. */ paragraphBorderStrokeEndCap: EndCap; /** * The corner join applied to the Paragraph. */ paragraphBorderStrokeEndJoin: EndJoin; /** * The tint (as a percentage) of the paragraph stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphBorderTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLeftCornerRadius: number | string; /** * The top line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLineWeight: number | string; /** * The distance to offset the top edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph border. */ paragraphBorderTopOrigin: ParagraphBorderTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphBorderTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopRightCornerRadius: number | string; /** * The type of the border for the paragraph. Can return: StrokeStyle or String. */ paragraphBorderType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph border. */ paragraphBorderWidth: ParagraphBorderEnum; /** * Paragraph direction. */ paragraphDirection: ParagraphDirectionOptions; /** * If true, the gyoudori mode applies to the entire paragraph. If false, the * gyoudori mode applies to each line in the paragraph. */ paragraphGyoudori: boolean; /** * Paragraph justification. */ paragraphJustification: ParagraphJustificationOptions; /** * Paragraph kashida width. 0 is none, 1 is short, 2 is medium, 3 is long */ paragraphKashidaWidth: number; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphShadingBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomLeftCornerRadius: number | string; /** * The distance to offset the bottom edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph shading. */ paragraphShadingBottomOrigin: ParagraphShadingBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphShadingBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomRightCornerRadius: number | string; /** * If true, forces the shading of the paragraph to be clipped with respect to * frame shape. */ paragraphShadingClipToFrame: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * shading. Can return: Swatch or String. */ paragraphShadingColor: Swatch | string; /** * The distance to offset the left edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingLeftOffset: number | string; /** * If true, the paragraph shading is On. */ paragraphShadingOn: boolean; /** * If true, the paragraph shading will overprint. */ paragraphShadingOverprint: boolean; /** * The distance to offset the right edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingRightOffset: number | string; /** * If true, suppress printing of the shading of the paragraph. */ paragraphShadingSuppressPrinting: boolean; /** * The tint (as a percentage) of the paragraph shading. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphShadingTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphShadingTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopLeftCornerRadius: number | string; /** * The distance to offset the top edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph shading. */ paragraphShadingTopOrigin: ParagraphShadingTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphShadingTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopRightCornerRadius: number | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph shading. */ paragraphShadingWidth: ParagraphShadingWidthEnum; /** * A collection of paragraphs. */ readonly paragraphs: Paragraphs; /** * The parent of the Paragraph (a XmlStory, TextPath, TextFrame, * EndnoteTextFrame, Text, InsertionPoint, TextStyleRange, Paragraph, * TextColumn, Line, Word, Character, Story, Cell, XMLElement, Footnote, Note, * Change or HiddenText). */ readonly parent: Cell | Change | Character | EndnoteTextFrame | Footnote | InsertionPoint | Line | Note | Paragraph | Story | Text | TextColumn | TextFrame | TextPath | TextStyleRange | Word | XMLElement | HiddenText | XmlStory; /** * The story that contains the text. */ readonly parentStory: Story; /** * An array of the text frames that contain the text. Can return: Array of * TextFrames or TextPaths. */ readonly parentTextFrames: (TextFrames | TextPaths)[]; /** * The text size. * @remarks Measurement unit — also accepts a string such as "12mm". */ pointSize: number | string; /** * A collection of polygons. */ readonly polygons: Polygons; /** * The text position relative to the baseline. */ position: Position; /** * The OpenType positional form. */ positionalForm: PositionalForms; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The hyphenation style chosen for the provider. */ providerHyphenationStyle: HyphenationStyleEnum; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * If true, disallows line breaks in numbers. If false, lines can break between * digits in multi-digit numbers. */ rensuuji: boolean; /** * The width of the right indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ rightIndent: number | string; /** * If true, rotates Roman characters in vertical text. */ rotateSingleByteCharacters: boolean; /** * The ruby alignment. */ rubyAlignment: RubyAlignments; /** * If true, auto aligns ruby. */ rubyAutoAlign: boolean; /** * If true, automatically scales ruby to the specified percent of parent text * size. For information on specifying a percent, see ruby parent scaling * percent. */ rubyAutoScaling: boolean; /** * If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to * fit one em. */ rubyAutoTcyAutoScale: boolean; /** * The number of digits included in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyDigits: number; /** * If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyIncludeRoman: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby * characters. Can return: Swatch or String. */ rubyFill: Swatch | string; /** * If true, ruby is on. */ rubyFlag: boolean; /** * The font applied to ruby characters. Can return: Font or String. */ rubyFont: Font | string; /** * The size (in points) of ruby characters. */ rubyFontSize: number; /** * The font style of ruby characters. Can return: String or NothingEnum * enumerator. */ rubyFontStyle: string | NothingEnum; /** * If true, uses OpenType Pro fonts for ruby. */ rubyOpenTypePro: boolean; /** * If true, constrains ruby overhang to the specified amount. For information * on specifying an amount, see ruby parent overhang amount. */ rubyOverhang: boolean; /** * The method of overprinting the ruby fill. */ rubyOverprintFill: AdornmentOverprint; /** * The method of overprinting the ruby stroke. */ rubyOverprintStroke: AdornmentOverprint; /** * The amount by which ruby characters can overhang the parent text. */ rubyParentOverhangAmount: RubyOverhang; /** * The amount (as a percentage) to scale the parent text size to determine the * ruby text size. */ rubyParentScalingPercent: number; /** * The ruby spacing relative to the parent text. */ rubyParentSpacing: RubyParentSpacing; /** * The position of ruby characters relative to the parent text. */ rubyPosition: RubyKentenPosition; /** * The ruby string contents. */ rubyString: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * ruby characters. Can return: Swatch or String. */ rubyStroke: Swatch | string; /** * The stroke tint (as a percentage) of ruby characters. */ rubyStrokeTint: number; /** * The tint (as a percentage) of the ruby fill color. (Range: 0 to 100) * @remarks Range: 0 to 100 */ rubyTint: number; /** * The ruby type. */ rubyType: RubyTypes; /** * The stroke weight (in points) of ruby characters. */ rubyWeight: number; /** * The amount of horizontal space between ruby and parent characters. */ rubyXOffset: number; /** * The horizontal size of ruby characters, specified as a percent of the * original size. */ rubyXScale: number; /** * The amount of vertical space between ruby and parent characters. */ rubyYOffset: number; /** * The vertical size of ruby characters, specified as a percent of the original * size. */ rubyYScale: number; /** * If true, places a rule above the paragraph. */ ruleAbove: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule above. Can return: Swatch or String. */ ruleAboveColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule above. Note: Valid only when the paragraph rule above * type is not solid. Can return: Swatch or String. */ ruleAboveGapColor: Swatch | string; /** * If true, the stroke gap of the paragraph rule above will overprint. Note: * Valid only the rule above type is not solid. */ ruleAboveGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule. * (Range: 0 to 100) Note: Valid only when the rule above type is not solid. * @remarks Range: 0 to 100 */ ruleAboveGapTint: number; /** * The distance to indent the left edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLeftIndent: number | string; /** * The line weight of the rule above. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLineWeight: number | string; /** * The amount to offset the paragraph rule above from the baseline of the first * line the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveOffset: number | string; /** * If true, the paragraph rule above will overprint. */ ruleAboveOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleAboveTint: number; /** * The stroke type of the rule above the paragraph. Can return: StrokeStyle or * String. */ ruleAboveType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule above. */ ruleAboveWidth: RuleWidth; /** * If true, applies a paragraph rule below. */ ruleBelow: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule below. Can return: Swatch or String. */ ruleBelowColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule below. Note: Valid only when the paragraph rule below * type is not solid. Can return: Swatch or String. */ ruleBelowGapColor: Swatch | string; /** * If true, the gap color of the rule below will overprint. */ ruleBelowGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule * below. (Range: 0 to 100) Note: Valid only when the paragraph rule below type * is not solid. * @remarks Range: 0 to 100 */ ruleBelowGapTint: number; /** * The distance to indent the left edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLeftIndent: number | string; /** * The line weight of the rule below. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLineWeight: number | string; /** * The amount to offset the the paragraph rule below from the baseline of the * last line of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowOffset: number | string; /** * If true, the rule below will overprint. */ ruleBelowOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleBelowTint: number; /** * The stroke type of the rule below the paragraph. Can return: StrokeStyle or * String. */ ruleBelowType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule below. */ ruleBelowWidth: RuleWidth; /** * The space between paragraphs using same style. Can return: Unit or Spacing * enumerator. */ sameParaStyleSpacing: number | Spacing; /** * If true, the line changes size when characters are scaled. */ scaleAffectsLineHeight: boolean; /** * If true, applies shatai rotation. */ shataiAdjustRotation: boolean; /** * If true, adjusts shatai tsume. */ shataiAdjustTsume: boolean; /** * The shatai lens angle (in degrees). */ shataiDegreeAngle: number; /** * The amount (as a percentage) of shatai obliquing to apply. */ shataiMagnification: number; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * The alignment to use for lines that contain a single word. */ singleWordJustification: SingleWordJustification; /** * The skew angle of the Paragraph. */ skew: number; /** * The height of the paragraph space below. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceAfter: number | string; /** * The height of the paragraph space above. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceBefore: number | string; /** * The minimum space after a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceAfter: number | string; /** * The minimum space before a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceBefore: number | string; /** * Whether a paragraph should be a single column, span columns or split columns */ spanColumnType: SpanColumnTypeOptions; /** * The number of columns a paragraph spans or the number of split columns. Can * return: Short Integer (1 - 40) or SpanColumnCountOptions enumerator. */ spanSplitColumnCount: number | SpanColumnCountOptions; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The inside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnInsideGutter: number | string; /** * The outside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnOutsideGutter: number | string; /** * The location at which to start the paragraph. */ startParagraph: StartParagraph; /** * The swatch (color, gradient, tint, or mixed ink) applied to the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughGapColor: Swatch | string; /** * If true, the gap color of the strikethrough stroke will overprint. Note: * Valid when strike through type is not solid. */ strikeThroughGapOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 * to 100) Note: Valid when strike through type is not solid. * @remarks Range: 0 to 100 */ strikeThroughGapTint: number; /** * The amount by which to offset the strikethrough stroke from the text * baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughOffset: number | string; /** * If true, the strikethrough stroke will overprint. */ strikeThroughOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ strikeThroughTint: number; /** * The stroke type of the strikethrough stroke. Can return: StrokeStyle or * String. */ strikeThroughType: StrokeStyle | string; /** * The stroke weight of the strikethrough stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughWeight: number | string; /** * If true, draws a strikethrough line through the text. */ strikeThru: boolean; /** * The stroke alignment applied to the text. */ strokeAlignment: TextStrokeAlign; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the Paragraph. Can also accept: String. */ strokeColor: Swatch | string; /** * The tint (as a percentage) of the stroke color of the Paragraph. (To specify * a tint percentage, use a number in the range of 0 to 100; to use the * inherited or overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * The stroke weight applied to the characters of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * If true, the applied style has been overridden with additional attributes. */ readonly styleOverridden: boolean; /** * A list of the tab stops in the paragraph. Can return: Array of Arrays of * Property Name/Value Pairs. */ tabList: any[][][]; /** * A collection of tab stops. */ readonly tabStops: TabStops; /** * A collection of tables. */ readonly tables: Tables; /** * If true, makes the character horizontal in vertical text. */ tatechuyoko: boolean; /** * The horizontal offset for horizontal characters in vertical text. */ tatechuyokoXOffset: number; /** * The vertical offset for horizontal characters in vertical text. */ tatechuyokoYOffset: number; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text columns. */ readonly textColumns: TextColumns; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * A collection of text style ranges. */ readonly textStyleRanges: TextStyleRanges; /** * A collection of text variable instances. */ readonly textVariableInstances: TextVariableInstances; /** * A collection of text objects. */ readonly texts: Texts; /** * The amount by which to loosen or tighten a block of text, specified in * thousands of an em. */ tracking: number; /** * The amount of space after each character. */ trailingAki: number; /** * If true, ideographic spaces will not wrap to the next line like text * characters. */ treatIdeographicSpaceAsSpace: boolean; /** * The amount of horizontal character compression. */ tsume: number; /** * If true, underlines the text. */ underline: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the underline * stroke. . Can return: Swatch or String. */ underlineColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * underline stroke. Note: Valid when underline type is not solid. Can return: * Swatch or String. */ underlineGapColor: Swatch | string; /** * If true, the gap color of the underline stroke will overprint. */ underlineGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of the underline stroke. (Range: * 0 to 100) Note: Valid when underline type is not solid. * @remarks Range: 0 to 100 */ underlineGapTint: number; /** * The amount by which to offset the underline from the text baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineOffset: number | string; /** * If true, the underline stroke color will overprint. */ underlineOverprint: boolean; /** * The underline stroke tint (as a percentage). (Range: 0 to 100) * @remarks Range: 0 to 100 */ underlineTint: number; /** * The stroke type of the underline stroke. Can return: StrokeStyle or String. */ underlineType: StrokeStyle | string; /** * The stroke weight of the underline stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineWeight: number | string; /** * The vertical scaling applied to the Paragraph. */ verticalScale: number; /** * If true, turns on warichu. */ warichu: boolean; /** * The warichu alignment. */ warichuAlignment: WarichuAlignment; /** * The minimum number of characters allowed after a line break. */ warichuCharsAfterBreak: number; /** * The minimum number of characters allowed before a line break. */ warichuCharsBeforeBreak: number; /** * The gap between lines of warichu characters. */ warichuLineSpacing: number; /** * The number of lines of warichu within a single normal line. */ warichuLines: number; /** * The amount (as a percentage) to scale parent text size to determine warichu * size. */ warichuSize: number; /** * A collection of words. */ readonly words: Words; /** * The x (horizontal) offset for diacritic adjustment. */ xOffsetDiacritic: number; /** * The y (vertical) offset for diacritic adjustment. */ yOffsetDiacritic: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Apply a character style. * @param using The character style to apply. */ applyCharacterStyle(using: CharacterStyle): void; /** * Apply one or more conditions. * @param using The condition(s) to apply * @param removeExisting If true, remove existing conditions. (Optional) */ applyConditions(using: Condition[], removeExisting?: boolean): void; /** * Apply a paragraph style. * @param using The paragraph style to apply. * @param clearingOverrides If true, clear any text attributes before applying the style. (Optional) */ applyParagraphStyle(using: ParagraphStyle, clearingOverrides?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds glyphs that match the find what value and replaces the glyphs with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value and replaces the text * with the change character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeTransliterate(reverseOrder?: boolean): Text[]; /** * Sets the case of the text. * @param using The text case option. */ changecase(using: ChangecaseMode): void; /** * Clears the specified types of override. * @param overridesToClear The types of override to clear. (Optional) */ clearOverrides(overridesToClear?: OverrideType): void; /** * Convert bullets and numbering to text. */ convertBulletsAndNumberingToText(): void; /** * Converts the text to a note. */ convertToNote(): Note; /** * Converts the text to a table. * @param columnSeparator The character that starts a new column in the new table. (Optional) * @param rowSeparator The character starts a new row in the new table. (Optional) * @param numberOfColumns The number of columns in the table. Note: Valid only when the column and row separator characters are the same. (Optional) */ convertToTable(columnSeparator?: string, rowSeparator?: string, numberOfColumns?: number): Table; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Paragraph. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Paragraph. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Converts text to outlines. Each line of text becomes a polygon object. When * the converted text is a single letter that has no internal spaces or * detached parts, the polygon contains only a single path. Note: To determine * whether a font allows the creation of outlines, see allow outlines. * @param deleteOriginal If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) */ createOutlines(deleteOriginal?: boolean): PageItem[]; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Paragraph. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create thumbnail for selected text using the applied style and overrides * with the given properties. * @param previewText Text to use as sample * @param pointSize Text font size (in points) * @param space Color space RGB, CMYK or LAB * @param colorValue Color values * @param to The path to the export file. * @param charOrParaStyle The applied style type to use. */ createStyleThumbnailWithProperties(previewText: string, pointSize: number, space: ColorSpace, colorValue: number[], to: File, charOrParaStyle: StyleType): boolean; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Paragraph. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create thumbnail for selected text with the given properties. * @param previewText Text to use as sample * @param pointSize Text font size (in points) * @param space Color space RGB, CMYK or LAB * @param colorValue Color values * @param to The path to the export file. */ createThumbnailWithProperties(previewText: string, pointSize: number, space: ColorSpace, colorValue: number[], to: File): boolean; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Paragraph. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Duplicates the text in the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional) */ duplicate(to: LocationOptions, reference?: Cell | Column | Row | Story | Table | Text | PageItem): Text; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Finds glyphs that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGrep(reverseOrder?: boolean): Text[]; /** * Finds hyperlink sources that intersecting with specified text range. * @param sortOrder The sort order of found ranges. (Optional) */ findHyperlinks(sortOrder?: RangeSortOrder): HyperlinkTextSource[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findTransliterate(reverseOrder?: boolean): Text[]; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Paragraph[]; /** * If true, Nth design axis of variable font is hidden. * @param nthAxisIndex Index of design axis. */ isNthDesignAxisHidden(nthAxisIndex: number): boolean; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the text to the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional) */ move(to: LocationOptions, reference?: Cell | Column | Row | Story | Table | Text | PageItem): Text; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Recomposes the text in the Paragraph. */ recompose(): void; /** * Deletes the Paragraph. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Selects the object. * @param existingSelection The selection status of the Paragraph in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Set Nth design axis of a variable font. * @param nthAxisIndex Index of design axis. * @param nthAxisValue Value of nth design axis. */ setNthDesignAxis(nthAxisIndex: number, nthAxisValue: number): void; /** * Jump to the text range. */ showText(): void; /** * If true, text has local overrides * @param charOrParaStyle Style type to look at. * @param charStyleAsOverride Whether to consider character styles as overrides or not (Optional) */ textHasOverrides(charOrParaStyle: StyleType, charStyleAsOverride?: boolean): boolean; /** * Generates a string which, if executed, will return the Paragraph. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for specifying basis of the bottom origin of the paragraph border. */ declare enum ParagraphBorderBottomOriginEnum { /** * Makes the paragraph border bottom origin based on baseline of the text in * the paragraph. */ BASELINE_BOTTOM_ORIGIN = 1886601826, /** * Makes the paragraph border bottom origin based on descent of the text in the * paragraph. */ DESCENT_BOTTOM_ORIGIN = 1886601828, } /** * Options for specifying basis of the width of the paragraph border. */ declare enum ParagraphBorderEnum { /** * Makes the paragraph border based on width of the column. */ COLUMN_WIDTH = 1265399652, /** * Makes the paragraph border based on width of lines of text in the paragraph. */ TEXT_WIDTH = 1886681207, } /** * Options for specifying basis of the top origin of the paragraph border. */ declare enum ParagraphBorderTopOriginEnum { /** * Makes the paragraph border top origin based on ascent of the text in the * paragraph. */ ASCENT_TOP_ORIGIN = 1886606433, /** * Makes the paragraph border top origin based on baseline of the text in the * paragraph. */ BASELINE_TOP_ORIGIN = 1886606434, /** * Makes the paragraph border top origin based on leading of the text in the * paragraph. */ LEADING_TOP_ORIGIN = 1885492332, } /** * Paragraph destination of a cross reference. */ declare class ParagraphDestination extends HyperlinkTextDestination { /** * The text or insertion point that the hyperlink points to. Can also accept: * Text. */ destinationText: InsertionPoint | Text; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, the hyperlink is hidden. */ readonly hidden: boolean; /** * The unique ID of the ParagraphDestination. */ readonly id: number; /** * The index of the ParagraphDestination within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the ParagraphDestination. */ name: string; /** * The parent of the ParagraphDestination (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ParagraphDestination[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the ParagraphDestination. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Jumps to the hyperlink destination. */ showDestination(): void; /** * Generates a string which, if executed, will return the ParagraphDestination. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of paragraph destinations. */ declare class ParagraphDestinations { /** Returns the ParagraphDestination with the specified index or name. */ [index: number]: ParagraphDestination; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new paragraph destination. * @param destination The text or insertion point inside the paragraph that the cross reference points to. The insertion point is always adjusted to the beginning of the paragraph. * @param withProperties Initial values for properties of the new ParagraphDestination (Optional) */ add(destination: Text, withProperties?: Object): ParagraphDestination; /** * Returns any ParagraphDestination in the collection. */ anyItem(): ParagraphDestination; /** * Displays the number of elements in the ParagraphDestination. */ count(): number; /** * Returns every ParagraphDestination in the collection. */ everyItem(): ParagraphDestination; /** * Returns the first ParagraphDestination in the collection. */ firstItem(): ParagraphDestination; /** * Returns the ParagraphDestination with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): ParagraphDestination; /** * Returns the ParagraphDestination with the specified ID. * @param id The ID. */ itemByID(id: number): ParagraphDestination; /** * Returns the ParagraphDestination with the specified name. * @param name The name. */ itemByName(name: string): ParagraphDestination; /** * Returns the ParagraphDestinations within the specified range. * @param from The ParagraphDestination, index, or name at the beginning of the range. Can accept: ParagraphDestination, Long Integer or String. * @param to The ParagraphDestination, index, or name at the end of the range. Can accept: ParagraphDestination, Long Integer or String. */ itemByRange(from: number | ParagraphDestination | string, to: number | ParagraphDestination | string): ParagraphDestination[]; /** * Returns the last ParagraphDestination in the collection. */ lastItem(): ParagraphDestination; /** * Returns the middle ParagraphDestination in the collection. */ middleItem(): ParagraphDestination; /** * Returns the ParagraphDestination whose index follows the specified * ParagraphDestination in the collection. * @param obj The ParagraphDestination whose index comes before the desired ParagraphDestination. */ nextItem(obj: ParagraphDestination): ParagraphDestination; /** * Returns the ParagraphDestination with the index previous to the specified * index. * @param obj The index of the ParagraphDestination that follows the desired ParagraphDestination. */ previousItem(obj: ParagraphDestination): ParagraphDestination; /** * Generates a string which, if executed, will return the ParagraphDestination. */ toSource(): string; } /** * Paragraph direction. */ declare enum ParagraphDirectionOptions { /** * Left to Right paragraph direction */ LEFT_TO_RIGHT_DIRECTION = 1278366308, /** * Right to Left paragraph direction */ RIGHT_TO_LEFT_DIRECTION = 1379028068, } /** * Paragraph justification. */ declare enum ParagraphJustificationOptions { /** * Arabic justification */ ARABIC_JUSTIFICATION = 1886019954, /** * Default justification */ DEFAULT_JUSTIFICATION = 1886020709, /** * Naskh justification */ NASKH_JUSTIFICATION = 1886023265, /** * Kashidas. Use naskh justification if you want to also use Justifcation * Alternates. */ NASKH_KASHIDA_JUSTIFICATION = 1886023275, /** * Fractional Kashidas. Use naskh justification if you want to also use * Justifcation Alternates. */ NASKH_KASHIDA_JUSTIFICATION_FRAC = 1886021227, /** * Kashidas without Stretched Connections. */ NASKH_TATWEEL_JUSTIFICATION = 1886023284, /** * Fractional Kashidas without Stretched Connections. */ NASKH_TATWEEL_JUSTIFICATION_FRAC = 1886021236, } /** * Options for specifying basis of the bottom origin of the paragraph shading. */ declare enum ParagraphShadingBottomOriginEnum { /** * Makes the paragraph shading bottom origin based on baseline of the text in * the paragraph. */ BASELINE_BOTTOM_ORIGIN = 1886601826, /** * Makes the paragraph shading bottom origin based on descent of the text in * the paragraph. */ DESCENT_BOTTOM_ORIGIN = 1886601828, } /** * Options for specifying basis of the top origin of the paragraph shading. */ declare enum ParagraphShadingTopOriginEnum { /** * Makes the paragraph shading top origin based on ascent of the text in the * paragraph. */ ASCENT_TOP_ORIGIN = 1886606433, /** * Makes the paragraph shading top origin based on baseline of the text in the * paragraph. */ BASELINE_TOP_ORIGIN = 1886606434, /** * Makes the paragraph shading top origin based on leading of the text in the * paragraph. */ LEADING_TOP_ORIGIN = 1885492332, } /** * Options for specifying basis of the width of the paragraph shading. */ declare enum ParagraphShadingWidthEnum { /** * Makes the paragraph shading based on width of the column. */ COLUMN_WIDTH = 1265399652, /** * Makes the paragraph shading based on width of lines of text in the * paragraph. */ TEXT_WIDTH = 1886681207, } /** * A paragraph style. */ declare class ParagraphStyle { /** * If true, aligns the baseline of the text to the baseline grid. */ alignToBaseline: boolean; /** * If true, words unassociated with a hyphenation dictionary can break to the * next line on any character. */ allowArbitraryHyphenation: boolean; /** * The font applied to the ParagraphStyle, specified as either a font object or * the name of font family. Can return: Font or String. */ appliedFont: Font | string; /** * The language of the text. Can return: LanguageWithVendors or Language. Can * also accept: String. */ appliedLanguage: LanguageWithVendors | string | Language; /** * The list to be part of. Can return: NumberingList or String. */ appliedNumberingList: NumberingList | string; /** * The percent of the type size to use for auto leading. (Range: 0 to 500). * @remarks Range: 0 to 500 */ autoLeading: number; /** * The number of half-width characters at or below which the characters * automatically run horizontally in vertical text. */ autoTcy: number; /** * If true, auto tcy includes Roman characters. */ autoTcyIncludeRoman: boolean; /** * If true or set to an enumeration value, balances ragged lines. Note: Not * valid with a single-line text composer. Can return: Boolean or * BalanceLinesStyle enumerator. */ balanceRaggedLines: boolean | BalanceLinesStyle; /** * The style that this style is based on. Can return: ParagraphStyle or String. */ basedOn: ParagraphStyle | string; /** * The baseline shift applied to the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ baselineShift: number | string; /** * Bullet character. */ readonly bulletChar: Bullet; /** * The alignment of the bullet character. */ bulletsAlignment: ListAlignment; /** * List type for bullets and numbering. */ bulletsAndNumberingListType: ListType; /** * The character style to be used for the text after string. Can return: * CharacterStyle or String. */ bulletsCharacterStyle: CharacterStyle | string; /** * The text after string expression for bullets. */ bulletsTextAfter: string; /** * If true, adds the double period (..), ellipse (...), and double hyphen (--) * to the selected kinsoku set. Note: Valid only when a kinsoku set is in * effect. */ bunriKinshi: boolean; /** * The capitalization scheme. */ capitalization: Capitalization; /** * The alignment of small characters to the largest character in the line. */ characterAlignment: CharacterAlignment; /** * The direction of the character. */ characterDirection: CharacterDirectionOptions; /** * The rotation angle (in degrees) of individual characters. Note: The rotation * is counterclockwise. */ characterRotation: number; /** * If true, uses grid tracking to track non-Roman characters in CJK grids. */ cjkGridTracking: boolean; /** * The text composer to use to compose the text. */ composer: string; /** * Value of Design Axes */ designAxes: number[]; /** * The desired width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ desiredGlyphScaling: number; /** * The desired letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) */ desiredLetterSpacing: number; /** * The desired word spacing, specified as a percentage of the font word space * value. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ desiredWordSpacing: number; /** * Position of diacriticical characters. */ diacriticPosition: DiacriticPositionOptions; /** * The digits type. */ digitsType: DigitsTypeOptions; /** * The number of characters to drop cap. * @remarks Range: 0 to 150 */ dropCapCharacters: number; /** * The number of lines to drop cap. * @remarks Range: 0 to 25 */ dropCapLines: number; /** * The character style to apply to the drop cap. Can also accept: String. */ dropCapStyle: CharacterStyle | string; /** * Details about the drop cap based on the glyph outlines. 1 = left side * bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid. */ dropcapDetail: number; /** * Emit CSS */ emitCss: boolean; /** * The stroke join type applied to the characters of the text. */ endJoin: OutlineJoin; /** * The epub aria role as recommended by IDPF */ epubAriaRole: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * ParagraphStyle. . Can also accept: String. */ fillColor: Swatch | string; /** * The tint (as a percentage) of the fill color of the ParagraphStyle. (To * specify a tint percentage, use a number in the range of 0 to 100; to use the * inherited or overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * The amount to indent the first line. * @remarks Measurement unit — also accepts a string such as "12mm". */ firstLineIndent: number | string; /** * The name of the font style. */ fontStyle: string; /** * The glyph variant to substitute for standard glyphs. */ glyphForm: AlternateGlyphForms; /** * The angle of a linear gradient applied to the fill of the text. (Range: -180 * to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the text. */ gradientFillLength: number; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the text. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the text. */ gradientStrokeLength: number; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * If true, aligns only the first line to the frame grid or baseline grid. If * false, aligns all lines to the grid. */ gridAlignFirstLineOnly: boolean; /** * The alignment to the frame grid or baseline grid. */ gridAlignment: GridAlignment; /** * The manual gyoudori setting. */ gridGyoudori: number; /** * The horizontal scaling applied to the ParagraphStyle. */ horizontalScale: number; /** * The relative desirability of better spacing vs. fewer hyphens. A lower value * results in greater use of hyphens. (Range: 0 to 100) * @remarks Range: 0 to 10 */ hyphenWeight: number; /** * If true, allows the last word in a text column to be hyphenated. */ hyphenateAcrossColumns: boolean; /** * The mininum number of letters at the beginning of a word that can be broken * by a hyphen. * @remarks Range: 1 to 15 */ hyphenateAfterFirst: number; /** * The minimum number of letters at the end of a word that can be broken by a * hyphen. * @remarks Range: 1 to 15 */ hyphenateBeforeLast: number; /** * If true, allows hyphenation of capitalized words. */ hyphenateCapitalizedWords: boolean; /** * The maximum number of hyphens that can appear on consecutive lines. To * specify unlimited consecutive lines, use zero. * @remarks Range: 0 to 25 */ hyphenateLadderLimit: number; /** * If true, allows hyphenation in the last word in a paragraph. Note: Valid * only when hyphenation is true. */ hyphenateLastWord: boolean; /** * The minimum number of letters a word must have in order to qualify for * hyphenation. * @remarks Range: 3 to 25 */ hyphenateWordsLongerThan: number; /** * If true, allows hyphenation. */ hyphenation: boolean; /** * The amount of white space allowed at the end of a line of non-justified text * before hypenation begins. Note: Valid when composer is single-line composer. * @remarks Measurement unit — also accepts a string such as "12mm". */ hyphenationZone: number | string; /** * The unique ID of the ParagraphStyle. */ readonly id: number; /** * If true, ignores optical edge alignment for the paragraph. */ ignoreEdgeAlignment: boolean; /** * If true, the style was imported from another document. */ readonly imported: boolean; /** * If true, class attribute will be generated for the style */ includeClass: boolean; /** * The index of the ParagraphStyle within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The number of grid squares in which to arrange the text. */ jidori: number; /** * The paragraph alignment. */ justification: Justification; /** * Use of Kashidas for justification */ kashidas: KashidasOptions; /** * If true, keeps all lines of the paragraph together. If false, allows * paragraphs to break across pages or columns. */ keepAllLinesTogether: boolean; /** * The minimum number of lines to keep together in a paragraph before allowing * a page break. * @remarks Range: 1 to 50 */ keepFirstLines: number; /** * The minimum number of lines to keep together in a paragraph after a page * break. * @remarks Range: 1 to 50 */ keepLastLines: number; /** * If true, keeps a specified number of lines together when the paragraph * breaks across columns or text frames. */ keepLinesTogether: boolean; /** * If true, forces the rule above the paragraph to remain in the frame bounds. * Note: Valid only when rule above is true. */ keepRuleAboveInFrame: boolean; /** * The minimum number of lines to keep with the next paragraph. * @remarks Range: 0 to 5 */ keepWithNext: number; /** * If the first line in the paragraph should be kept with the last line of * previous paragraph. */ keepWithPrevious: boolean; /** * The alignment of kenten characters relative to the parent characters. */ kentenAlignment: KentenAlignment; /** * The character set used for the custom kenten character. Note: Valid only * when kenten kind is custom. */ kentenCharacterSet: KentenCharacterSet; /** * The character used for kenten. Note: Valid only when kenten kind is custom. */ kentenCustomCharacter: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of * kenten characters. Can return: Swatch or String. */ kentenFillColor: Swatch | string; /** * The font to use for kenten characters. Can return: Font or String. */ kentenFont: Font | string; /** * The size (in points) of kenten characters. */ kentenFontSize: number; /** * The font style of kenten characters. Can return: String or NothingEnum * enumerator. */ kentenFontStyle: string | NothingEnum; /** * The style of kenten characters. */ kentenKind: KentenCharacter; /** * The method of overprinting the kenten fill. */ kentenOverprintFill: AdornmentOverprint; /** * The method of overprinting the kenten stroke. */ kentenOverprintStroke: AdornmentOverprint; /** * The distance between kenten characters and their parent characters. */ kentenPlacement: number; /** * The kenten position relative to the parent character. */ kentenPosition: RubyKentenPosition; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * kenten characters. Can return: Swatch or String. */ kentenStrokeColor: Swatch | string; /** * The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenStrokeTint: number; /** * The fill tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenTint: number; /** * The stroke weight (in points) of kenten characters. */ kentenWeight: number; /** * The horizontal size of kenten characters as a percent of the original size. */ kentenXScale: number; /** * The vertical size of kenten charachers as a percent of the original size. */ kentenYScale: number; /** * The type of pair kerning. */ kerningMethod: string; /** * The keyboard direction of the character. */ keyboardDirection: CharacterDirectionOptions; /** * The type of hanging punctuation to allow. Note: Valid only when a kinsoku * set is in effect. */ kinsokuHangType: KinsokuHangTypes; /** * The kinsoku set that determines legitimate line breaks. Can return: * KinsokuTable, KinsokuSet enumerator or String. */ kinsokuSet: KinsokuSet | KinsokuTable | string; /** * The type of kinsoku processing for preventing kinsoku characters from * beginning or ending a line. Note: Valid only when a kinsoku set is defined. */ kinsokuType: KinsokuType; /** * A property that can be set to any string. */ label: string; /** * The amount to indent the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ lastLineIndent: number | string; /** * The leading applied to the text. Can return: Unit or Leading enumerator. */ leading: number | Leading; /** * The amount of space before each character. */ leadingAki: number; /** * The point from which leading is measured from line to line. */ leadingModel: LeadingModel; /** * The width of the left indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ leftIndent: number | string; /** * If true, replaces specific character combinations (e.g., fl, fi) with * ligature characters. */ ligatures: boolean; /** * The maximum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ maximumGlyphScaling: number; /** * The maximum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ maximumLetterSpacing: number; /** * The maximum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ maximumWordSpacing: number; /** * If true, consecutive para borders with completely similar properties are * merged. */ mergeConsecutiveParaBorders: boolean; /** * The minimum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ minimumGlyphScaling: number; /** * The minimum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ minimumLetterSpacing: number; /** * The minimum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ minimumWordSpacing: number; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 0 to 1000 */ miterLimit: number; /** * The mojikumi table. For information, see mojikumi table defaults. Can * return: MojikumiTable, String or MojikumiTableDefaults enumerator. */ mojikumi: MojikumiTable | string | MojikumiTableDefaults; /** * The name of the ParagraphStyle. */ name: string; /** * A collection of nested GREP styles. */ readonly nestedGrepStyles: NestedGrepStyles; /** * A collection of nested line styles. */ readonly nestedLineStyles: NestedLineStyles; /** * A collection of nested styles. */ readonly nestedStyles: NestedStyles; /** * The style to apply to new paragraphs that follow paragraphs tagged with this * style. */ nextStyle: ParagraphStyle; /** * If true, keeps the text on the same line. */ noBreak: boolean; /** * The alignment of the number. */ numberingAlignment: ListAlignment; /** * If true, apply the numbering restart policy. */ numberingApplyRestartPolicy: boolean; /** * The character style to be used for the number string. Can return: * CharacterStyle or String. */ numberingCharacterStyle: CharacterStyle | string; /** * Continue the numbering at this level. */ numberingContinue: boolean; /** * The number string expression for numbering. */ numberingExpression: string; /** * Numbering format options. Can return: NumberingStyle enumerator or String. */ numberingFormat: NumberingStyle | string; /** * The level of the paragraph. */ numberingLevel: number; /** * Numbering restart policies. */ readonly numberingRestartPolicies: NumberingRestartPolicy; /** * Determines starting number in a numbered list. */ numberingStartAt: number; /** * If true, uses contextual alternate forms in OpenType fonts. */ otfContextualAlternate: boolean; /** * If true, uses discretionary ligatures in OpenType fonts. */ otfDiscretionaryLigature: boolean; /** * The figure style in OpenType fonts. */ otfFigureStyle: OTFFigureStyle; /** * If true, uses fractions in OpenType fonts. */ otfFraction: boolean; /** * If true, switches hiragana fonts, which have different glyphs for horizontal * and vertical. */ otfHVKana: boolean; /** * If true, use historical forms in OpenType fonts. */ otfHistorical: boolean; /** * If true, use alternate justification forms in OpenType fonts */ otfJustificationAlternate: boolean; /** * If true, uses localized forms in OpenType fonts. */ otfLocale: boolean; /** * If true, uses mark positioning in OpenType fonts. */ otfMark: boolean; /** * If true, uses ordinals in OpenType fonts. */ otfOrdinal: boolean; /** * If true, use overlapping swash forms in OpenType fonts */ otfOverlapSwash: boolean; /** * If true, kerns according to proportional CJK metrics in OpenType fonts. */ otfProportionalMetrics: boolean; /** * If true, applies italics to half-width alphanumerics. */ otfRomanItalics: boolean; /** * If true, use a slashed zeroes in OpenType fonts. */ otfSlashedZero: boolean; /** * If true, use stretched alternate forms in OpenType fonts */ otfStretchedAlternate: boolean; /** * If true, use stylistic alternate forms in OpenType fonts */ otfStylisticAlternate: boolean; /** * The stylistic sets to use in OpenType fonts. */ otfStylisticSets: number; /** * If true, uses swash forms in OpenType fonts. */ otfSwash: boolean; /** * If true, uses titling forms in OpenType fonts. */ otfTitling: boolean; /** * If true, the fill color of the characters will overprint. */ overprintFill: boolean; /** * If true, the stroke of the characters will overprint. */ overprintStroke: boolean; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphBorderBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLeftCornerRadius: number | string; /** * The bottom line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLineWeight: number | string; /** * The distance to offset the bottom edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph border. */ paragraphBorderBottomOrigin: ParagraphBorderBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphBorderBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomRightCornerRadius: number | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * stroke. Can return: Swatch or String. */ paragraphBorderColor: Swatch | string; /** * If true, then paragraph border is also displayed at the points where the * paragraph splits across frames or columns. */ paragraphBorderDisplayIfSplits: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * border gap. Note: Valid only when the border type is not solid. Can return: * Swatch or String. */ paragraphBorderGapColor: Swatch | string; /** * If true, the paragraph border gap will overprint. Note: Valid only when * border type is not solid. */ paragraphBorderGapOverprint: boolean; /** * The tint (as a percentage) of the paragraph border gap. Note: Valid only * when the border type is not solid. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderGapTint: number; /** * The left line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftLineWeight: number | string; /** * The distance to offset the left edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftOffset: number | string; /** * If true, the paragraph border is on. */ paragraphBorderOn: boolean; /** * If true, the paragraph border will overprint. */ paragraphBorderOverprint: boolean; /** * The right line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightLineWeight: number | string; /** * The distance to offset the right edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightOffset: number | string; /** * The end shape of an open path. */ paragraphBorderStrokeEndCap: EndCap; /** * The corner join applied to the ParagraphStyle. */ paragraphBorderStrokeEndJoin: EndJoin; /** * The tint (as a percentage) of the paragraph stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphBorderTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLeftCornerRadius: number | string; /** * The top line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLineWeight: number | string; /** * The distance to offset the top edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph border. */ paragraphBorderTopOrigin: ParagraphBorderTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphBorderTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopRightCornerRadius: number | string; /** * The type of the border for the paragraph. Can return: StrokeStyle or String. */ paragraphBorderType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph border. */ paragraphBorderWidth: ParagraphBorderEnum; /** * Paragraph direction. */ paragraphDirection: ParagraphDirectionOptions; /** * If true, the gyoudori mode applies to the entire paragraph. If false, the * gyoudori mode applies to each line in the paragraph. */ paragraphGyoudori: boolean; /** * Paragraph justification. */ paragraphJustification: ParagraphJustificationOptions; /** * Paragraph kashida width. 0 is none, 1 is short, 2 is medium, 3 is long */ paragraphKashidaWidth: number; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphShadingBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomLeftCornerRadius: number | string; /** * The distance to offset the bottom edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph shading. */ paragraphShadingBottomOrigin: ParagraphShadingBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphShadingBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomRightCornerRadius: number | string; /** * If true, forces the shading of the paragraph to be clipped with respect to * frame shape. */ paragraphShadingClipToFrame: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * shading. Can return: Swatch or String. */ paragraphShadingColor: Swatch | string; /** * The distance to offset the left edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingLeftOffset: number | string; /** * If true, the paragraph shading is On. */ paragraphShadingOn: boolean; /** * If true, the paragraph shading will overprint. */ paragraphShadingOverprint: boolean; /** * The distance to offset the right edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingRightOffset: number | string; /** * If true, suppress printing of the shading of the paragraph. */ paragraphShadingSuppressPrinting: boolean; /** * The tint (as a percentage) of the paragraph shading. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphShadingTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphShadingTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopLeftCornerRadius: number | string; /** * The distance to offset the top edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph shading. */ paragraphShadingTopOrigin: ParagraphShadingTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphShadingTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopRightCornerRadius: number | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph shading. */ paragraphShadingWidth: ParagraphShadingWidthEnum; /** * The parent of the ParagraphStyle (a Document, Application or * ParagraphStyleGroup). */ readonly parent: Application | Document | ParagraphStyleGroup; /** * The text size. * @remarks Measurement unit — also accepts a string such as "12mm". */ pointSize: number | string; /** * The text position relative to the baseline. */ position: Position; /** * The OpenType positional form. */ positionalForm: PositionalForms; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * The color to use for preview, specified either as an array of three doubles, * each in the range 0 to 255 and representing R, G, and B values, or as a UI * color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator or * NothingEnum enumerator. */ previewColor: (number[][] | NothingEnum | UIColors)[]; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The hyphenation style chosen for the provider. */ providerHyphenationStyle: HyphenationStyleEnum; /** * If true, disallows line breaks in numbers. If false, lines can break between * digits in multi-digit numbers. */ rensuuji: boolean; /** * The width of the right indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ rightIndent: number | string; /** * If true, rotates Roman characters in vertical text. */ rotateSingleByteCharacters: boolean; /** * The ruby alignment. */ rubyAlignment: RubyAlignments; /** * If true, auto aligns ruby. */ rubyAutoAlign: boolean; /** * If true, automatically scales ruby to the specified percent of parent text * size. For information on specifying a percent, see ruby parent scaling * percent. */ rubyAutoScaling: boolean; /** * If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to * fit one em. */ rubyAutoTcyAutoScale: boolean; /** * The number of digits included in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyDigits: number; /** * If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyIncludeRoman: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby * characters. Can return: Swatch or String. */ rubyFill: Swatch | string; /** * The font applied to ruby characters. Can return: Font or String. */ rubyFont: Font | string; /** * The size (in points) of ruby characters. */ rubyFontSize: number; /** * The font style of ruby characters. Can return: String or NothingEnum * enumerator. */ rubyFontStyle: string | NothingEnum; /** * If true, uses OpenType Pro fonts for ruby. */ rubyOpenTypePro: boolean; /** * If true, constrains ruby overhang to the specified amount. For information * on specifying an amount, see ruby parent overhang amount. */ rubyOverhang: boolean; /** * The method of overprinting the ruby fill. */ rubyOverprintFill: AdornmentOverprint; /** * The method of overprinting the ruby stroke. */ rubyOverprintStroke: AdornmentOverprint; /** * The amount by which ruby characters can overhang the parent text. */ rubyParentOverhangAmount: RubyOverhang; /** * The amount (as a percentage) to scale the parent text size to determine the * ruby text size. */ rubyParentScalingPercent: number; /** * The ruby spacing relative to the parent text. */ rubyParentSpacing: RubyParentSpacing; /** * The position of ruby characters relative to the parent text. */ rubyPosition: RubyKentenPosition; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * ruby characters. Can return: Swatch or String. */ rubyStroke: Swatch | string; /** * The stroke tint (as a percentage) of ruby characters. */ rubyStrokeTint: number; /** * The tint (as a percentage) of the ruby fill color. (Range: 0 to 100) * @remarks Range: 0 to 100 */ rubyTint: number; /** * The ruby type. */ rubyType: RubyTypes; /** * The stroke weight (in points) of ruby characters. */ rubyWeight: number; /** * The amount of horizontal space between ruby and parent characters. */ rubyXOffset: number; /** * The horizontal size of ruby characters, specified as a percent of the * original size. */ rubyXScale: number; /** * The amount of vertical space between ruby and parent characters. */ rubyYOffset: number; /** * The vertical size of ruby characters, specified as a percent of the original * size. */ rubyYScale: number; /** * If true, places a rule above the paragraph. */ ruleAbove: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule above. Can return: Swatch or String. */ ruleAboveColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule above. Note: Valid only when the paragraph rule above * type is not solid. Can return: Swatch or String. */ ruleAboveGapColor: Swatch | string; /** * If true, the stroke gap of the paragraph rule above will overprint. Note: * Valid only the rule above type is not solid. */ ruleAboveGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule. * (Range: 0 to 100) Note: Valid only when the rule above type is not solid. * @remarks Range: 0 to 100 */ ruleAboveGapTint: number; /** * The distance to indent the left edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLeftIndent: number | string; /** * The line weight of the rule above. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLineWeight: number | string; /** * The amount to offset the paragraph rule above from the baseline of the first * line the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveOffset: number | string; /** * If true, the paragraph rule above will overprint. */ ruleAboveOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleAboveTint: number; /** * The stroke type of the rule above the paragraph. Can return: StrokeStyle or * String. */ ruleAboveType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule above. */ ruleAboveWidth: RuleWidth; /** * If true, applies a paragraph rule below. */ ruleBelow: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule below. Can return: Swatch or String. */ ruleBelowColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule below. Note: Valid only when the paragraph rule below * type is not solid. Can return: Swatch or String. */ ruleBelowGapColor: Swatch | string; /** * If true, the gap color of the rule below will overprint. */ ruleBelowGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule * below. (Range: 0 to 100) Note: Valid only when the paragraph rule below type * is not solid. * @remarks Range: 0 to 100 */ ruleBelowGapTint: number; /** * The distance to indent the left edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLeftIndent: number | string; /** * The line weight of the rule below. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLineWeight: number | string; /** * The amount to offset the the paragraph rule below from the baseline of the * last line of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowOffset: number | string; /** * If true, the rule below will overprint. */ ruleBelowOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleBelowTint: number; /** * The stroke type of the rule below the paragraph. Can return: StrokeStyle or * String. */ ruleBelowType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule below. */ ruleBelowWidth: RuleWidth; /** * The space between paragraphs using same style. Can return: Unit or Spacing * enumerator. */ sameParaStyleSpacing: number | Spacing; /** * If true, the line changes size when characters are scaled. */ scaleAffectsLineHeight: boolean; /** * If true, applies shatai rotation. */ shataiAdjustRotation: boolean; /** * If true, adjusts shatai tsume. */ shataiAdjustTsume: boolean; /** * The shatai lens angle (in degrees). */ shataiDegreeAngle: number; /** * The amount (as a percentage) of shatai obliquing to apply. */ shataiMagnification: number; /** * The alignment to use for lines that contain a single word. */ singleWordJustification: SingleWordJustification; /** * The skew angle of the ParagraphStyle. */ skew: number; /** * The height of the paragraph space below. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceAfter: number | string; /** * The height of the paragraph space above. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceBefore: number | string; /** * The minimum space after a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceAfter: number | string; /** * The minimum space before a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceBefore: number | string; /** * Whether a paragraph should be a single column, span columns or split columns */ spanColumnType: SpanColumnTypeOptions; /** * The number of columns a paragraph spans or the number of split columns. Can * return: Short Integer (1 - 40) or SpanColumnCountOptions enumerator. */ spanSplitColumnCount: number | SpanColumnCountOptions; /** * The inside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnInsideGutter: number | string; /** * The outside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnOutsideGutter: number | string; /** * Split Document (EPUB only) */ splitDocument: boolean; /** * The location at which to start the paragraph. */ startParagraph: StartParagraph; /** * The swatch (color, gradient, tint, or mixed ink) applied to the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughGapColor: Swatch | string; /** * If true, the gap color of the strikethrough stroke will overprint. Note: * Valid when strike through type is not solid. */ strikeThroughGapOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 * to 100) Note: Valid when strike through type is not solid. * @remarks Range: 0 to 100 */ strikeThroughGapTint: number; /** * The amount by which to offset the strikethrough stroke from the text * baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughOffset: number | string; /** * If true, the strikethrough stroke will overprint. */ strikeThroughOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ strikeThroughTint: number; /** * The stroke type of the strikethrough stroke. Can return: StrokeStyle or * String. */ strikeThroughType: StrokeStyle | string; /** * The stroke weight of the strikethrough stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughWeight: number | string; /** * If true, draws a strikethrough line through the text. */ strikeThru: boolean; /** * The stroke alignment applied to the text. */ strokeAlignment: TextStrokeAlign; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the ParagraphStyle. Can also accept: String. */ strokeColor: Swatch | string; /** * The tint (as a percentage) of the stroke color of the ParagraphStyle. (To * specify a tint percentage, use a number in the range of 0 to 100; to use the * inherited or overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * The stroke weight applied to the characters of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of style export tag maps. */ readonly styleExportTagMaps: StyleExportTagMaps; /** * A unique id that can be assigned to a style. This can be used to * differentiate between the styles. Internal use only. */ styleUniqueId: string; /** * A list of the tab stops in the paragraph. Can return: Array of Arrays of * Property Name/Value Pairs. */ tabList: any[][][]; /** * A collection of tab stops. */ readonly tabStops: TabStops; /** * If true, makes the character horizontal in vertical text. */ tatechuyoko: boolean; /** * The horizontal offset for horizontal characters in vertical text. */ tatechuyokoXOffset: number; /** * The vertical offset for horizontal characters in vertical text. */ tatechuyokoYOffset: number; /** * The amount by which to loosen or tighten a block of text, specified in * thousands of an em. */ tracking: number; /** * The amount of space after each character. */ trailingAki: number; /** * If true, ideographic spaces will not wrap to the next line like text * characters. */ treatIdeographicSpaceAsSpace: boolean; /** * The amount of horizontal character compression. */ tsume: number; /** * If true, underlines the text. */ underline: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the underline * stroke. . Can return: Swatch or String. */ underlineColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * underline stroke. Note: Valid when underline type is not solid. Can return: * Swatch or String. */ underlineGapColor: Swatch | string; /** * If true, the gap color of the underline stroke will overprint. */ underlineGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of the underline stroke. (Range: * 0 to 100) Note: Valid when underline type is not solid. * @remarks Range: 0 to 100 */ underlineGapTint: number; /** * The amount by which to offset the underline from the text baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineOffset: number | string; /** * If true, the underline stroke color will overprint. */ underlineOverprint: boolean; /** * The underline stroke tint (as a percentage). (Range: 0 to 100) * @remarks Range: 0 to 100 */ underlineTint: number; /** * The stroke type of the underline stroke. Can return: StrokeStyle or String. */ underlineType: StrokeStyle | string; /** * The stroke weight of the underline stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineWeight: number | string; /** * The vertical scaling applied to the ParagraphStyle. */ verticalScale: number; /** * If true, turns on warichu. */ warichu: boolean; /** * The warichu alignment. */ warichuAlignment: WarichuAlignment; /** * The minimum number of characters allowed after a line break. */ warichuCharsAfterBreak: number; /** * The minimum number of characters allowed before a line break. */ warichuCharsBeforeBreak: number; /** * The gap between lines of warichu characters. */ warichuLineSpacing: number; /** * The number of lines of warichu within a single normal line. */ warichuLines: number; /** * The amount (as a percentage) to scale parent text size to determine warichu * size. */ warichuSize: number; /** * The x (horizontal) offset for diacritic adjustment. */ xOffsetDiacritic: number; /** * The y (vertical) offset for diacritic adjustment. */ yOffsetDiacritic: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Convert bullets and numbering to text. */ convertBulletsAndNumberingToText(): void; /** * Create thumbnail for selected text with the given properties. * @param previewText Text to use as sample * @param pointSize Text font size (in points) * @param space Color space RGB, CMYK or LAB * @param colorValue Color values * @param to The path to the export file. */ createThumbnailWithProperties(previewText: string, pointSize: number, space: ColorSpace, colorValue: number[], to: File): boolean; /** * Duplicates the ParagraphStyle. */ duplicate(): ParagraphStyle; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Deletes the paragraph style forcefully. For internal use only. * @param replacingWith The style to apply in place of the deleted style. (Optional) */ forceDelete(replacingWith?: ParagraphStyle): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ParagraphStyle[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * If true, Nth design axis of variable font is hidden. * @param nthAxisIndex Index of design axis. */ isNthDesignAxisHidden(nthAxisIndex: number): boolean; /** * Moves the style to the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: ParagraphStyle, ParagraphStyleGroup, CharacterStyle, CharacterStyleGroup, CellStyle, CellStyleGroup, TableStyle, TableStyleGroup, Document or Application. (Optional) */ move(to: LocationOptions, reference?: CellStyle | CellStyleGroup | CharacterStyle | CharacterStyleGroup | Document | ParagraphStyle | ParagraphStyleGroup | TableStyle | TableStyleGroup | Application): ParagraphStyle; /** * Deletes the style. * @param replacingWith The style to apply in place of the deleted style. (Optional) */ remove(replacingWith?: ParagraphStyle): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Set Nth design axis of a variable font. * @param nthAxisIndex Index of design axis. * @param nthAxisValue Value of nth design axis. */ setNthDesignAxis(nthAxisIndex: number, nthAxisValue: number): void; /** * Generates a string which, if executed, will return the ParagraphStyle. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A paragraph style group. */ declare class ParagraphStyleGroup { /** * Lists all paragraph styles (regardless of their group). */ readonly allParagraphStyles: ParagraphStyle[]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the ParagraphStyleGroup. */ readonly id: number; /** * The index of the ParagraphStyleGroup within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the ParagraphStyleGroup. */ name: string; /** * A collection of paragraph style groups. */ readonly paragraphStyleGroups: ParagraphStyleGroups; /** * A collection of paragraph styles. */ readonly paragraphStyles: ParagraphStyles; /** * The parent of the ParagraphStyleGroup (a Document, Application or * ParagraphStyleGroup). */ readonly parent: Application | Document | ParagraphStyleGroup; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the ParagraphStyleGroup. */ duplicate(): ParagraphStyleGroup; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ParagraphStyleGroup[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Moves the style to the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: ParagraphStyle, ParagraphStyleGroup, CharacterStyle, CharacterStyleGroup, CellStyle, CellStyleGroup, TableStyle, TableStyleGroup, Document or Application. (Optional) */ move(to: LocationOptions, reference?: CellStyle | CellStyleGroup | CharacterStyle | CharacterStyleGroup | Document | ParagraphStyle | ParagraphStyleGroup | TableStyle | TableStyleGroup | Application): ParagraphStyleGroup; /** * Deletes the style. * @param replacingWith The style to apply in place of the deleted style. Can accept: ParagraphStyle or CharacterStyle. (Optional) */ remove(replacingWith?: ParagraphStyle | CharacterStyle): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ParagraphStyleGroup. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of paragraph style groups. */ declare class ParagraphStyleGroups { /** Returns the ParagraphStyleGroup with the specified index or name. */ [index: number]: ParagraphStyleGroup; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new ParagraphStyleGroup. * @param withProperties Initial values for properties of the new ParagraphStyleGroup (Optional) */ add(withProperties?: Object): ParagraphStyleGroup; /** * Returns any ParagraphStyleGroup in the collection. */ anyItem(): ParagraphStyleGroup; /** * Displays the number of elements in the ParagraphStyleGroup. */ count(): number; /** * Returns every ParagraphStyleGroup in the collection. */ everyItem(): ParagraphStyleGroup; /** * Returns the first ParagraphStyleGroup in the collection. */ firstItem(): ParagraphStyleGroup; /** * Returns the ParagraphStyleGroup with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): ParagraphStyleGroup; /** * Returns the ParagraphStyleGroup with the specified ID. * @param id The ID. */ itemByID(id: number): ParagraphStyleGroup; /** * Returns the ParagraphStyleGroup with the specified name. * @param name The name. */ itemByName(name: string): ParagraphStyleGroup; /** * Returns the ParagraphStyleGroups within the specified range. * @param from The ParagraphStyleGroup, index, or name at the beginning of the range. Can accept: ParagraphStyleGroup, Long Integer or String. * @param to The ParagraphStyleGroup, index, or name at the end of the range. Can accept: ParagraphStyleGroup, Long Integer or String. */ itemByRange(from: number | ParagraphStyleGroup | string, to: number | ParagraphStyleGroup | string): ParagraphStyleGroup[]; /** * Returns the last ParagraphStyleGroup in the collection. */ lastItem(): ParagraphStyleGroup; /** * Returns the middle ParagraphStyleGroup in the collection. */ middleItem(): ParagraphStyleGroup; /** * Returns the ParagraphStyleGroup whose index follows the specified * ParagraphStyleGroup in the collection. * @param obj The ParagraphStyleGroup whose index comes before the desired ParagraphStyleGroup. */ nextItem(obj: ParagraphStyleGroup): ParagraphStyleGroup; /** * Returns the ParagraphStyleGroup with the index previous to the specified * index. * @param obj The index of the ParagraphStyleGroup that follows the desired ParagraphStyleGroup. */ previousItem(obj: ParagraphStyleGroup): ParagraphStyleGroup; /** * Generates a string which, if executed, will return the ParagraphStyleGroup. */ toSource(): string; } /** * A collection of paragraph styles. */ declare class ParagraphStyles { /** Returns the ParagraphStyle with the specified index or name. */ [index: number]: ParagraphStyle; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new ParagraphStyle. * @param withProperties Initial values for properties of the new ParagraphStyle (Optional) */ add(withProperties?: Object): ParagraphStyle; /** * Returns any ParagraphStyle in the collection. */ anyItem(): ParagraphStyle; /** * Displays the number of elements in the ParagraphStyle. */ count(): number; /** * Returns every ParagraphStyle in the collection. */ everyItem(): ParagraphStyle; /** * Returns the first ParagraphStyle in the collection. */ firstItem(): ParagraphStyle; /** * Returns the ParagraphStyle with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): ParagraphStyle; /** * Returns the ParagraphStyle with the specified ID. * @param id The ID. */ itemByID(id: number): ParagraphStyle; /** * Returns the ParagraphStyle with the specified name. * @param name The name. */ itemByName(name: string): ParagraphStyle; /** * Returns the ParagraphStyles within the specified range. * @param from The ParagraphStyle, index, or name at the beginning of the range. Can accept: ParagraphStyle, Long Integer or String. * @param to The ParagraphStyle, index, or name at the end of the range. Can accept: ParagraphStyle, Long Integer or String. */ itemByRange(from: number | ParagraphStyle | string, to: number | ParagraphStyle | string): ParagraphStyle[]; /** * Returns the last ParagraphStyle in the collection. */ lastItem(): ParagraphStyle; /** * Returns the middle ParagraphStyle in the collection. */ middleItem(): ParagraphStyle; /** * Returns the ParagraphStyle whose index follows the specified ParagraphStyle * in the collection. * @param obj The ParagraphStyle whose index comes before the desired ParagraphStyle. */ nextItem(obj: ParagraphStyle): ParagraphStyle; /** * Returns the ParagraphStyle with the index previous to the specified index. * @param obj The index of the ParagraphStyle that follows the desired ParagraphStyle. */ previousItem(obj: ParagraphStyle): ParagraphStyle; /** * Generates a string which, if executed, will return the ParagraphStyle. */ toSource(): string; } /** * A collection of paragraphs. */ declare class Paragraphs { /** Returns the Paragraph with the specified index or name. */ [index: number]: Paragraph; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Paragraph in the collection. */ anyItem(): Paragraph; /** * Displays the number of elements in the Paragraph. */ count(): number; /** * Returns every Paragraph in the collection. */ everyItem(): Paragraph; /** * Returns the first Paragraph in the collection. */ firstItem(): Paragraph; /** * Returns the Paragraph with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Paragraph; /** * Returns the Paragraphs within the specified range. * @param from The Paragraph, index, or name at the beginning of the range. Can accept: Paragraph, Long Integer or String. * @param to The Paragraph, index, or name at the end of the range. Can accept: Paragraph, Long Integer or String. */ itemByRange(from: number | Paragraph | string, to: number | Paragraph | string): Paragraph[]; /** * Returns the last Paragraph in the collection. */ lastItem(): Paragraph; /** * Returns the middle Paragraph in the collection. */ middleItem(): Paragraph; /** * Returns the Paragraph whose index follows the specified Paragraph in the * collection. * @param obj The Paragraph whose index comes before the desired Paragraph. */ nextItem(obj: Paragraph): Paragraph; /** * Returns the Paragraph with the index previous to the specified index. * @param obj The index of the Paragraph that follows the desired Paragraph. */ previousItem(obj: Paragraph): Paragraph; /** * Generates a string which, if executed, will return the Paragraph. */ toSource(): string; } /** * Pasteboard preferences. */ declare class PasteboardPreference extends Preference { /** * The color of bleed guides, specified either as an array of three doubles, * each in the range 0 to 255, representing R, G, and B values, or as a UI * color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. */ bleedGuideColor: (number[][] | UIColors)[]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * If true, match the Preview Background color to Theme Color, else use the * color-value specified in Preview Background color drop down. */ matchPreviewBackgroundToThemeColor: boolean; /** * The parent of the PasteboardPreference (a Application or Document). */ readonly parent: Application | Document; /** * The minimum horizontal and vertical pasteboard margins. A horizontal margin * of -1 means one document page width * @remarks Measurement unit — also accepts a string such as "12mm". */ pasteboardMargins: (number | string)[]; /** * The color of the preview background, specified either as an array of three * doubles, each in the range 0 to 255, representing R, G, and B values, or as * a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. */ previewBackgroundColor: (number[][] | UIColors)[]; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The color of slug guides, specified either as an array of three doubles, * each in the range 0 to 255, representing R, G, and B values, or as a UI * color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. */ slugGuideColor: (number[][] | UIColors)[]; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PasteboardPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the PasteboardPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A path. */ declare class Path { /** * A list of the coordinates of all of the path points on the path, including * anchor points and left- and right-direction points. When creating a path * using this property, supply either a list of anchor point coordinates ([[x1, * y1], [x2, y2], ...]) or a list of anchor point, left-direction point, and * right-direction point coordinates ([[[x1, y1], [x2, y2], [x3, y3]], [[x4, * y4], [x5, y5], [x6, y6]], ...]). Note: Providing only anchor points results * in a path on which all of the path points are connected with straight line * segments; supplying the positions of left- and right-direction points * specifies curved line segments. Can return: Array of Arrays of 2 Units. */ entirePath: number[][][][]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the Path within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the Path (a SplineItem, Polygon, GraphicLine, Rectangle, Oval, * TextFrame, EndnoteTextFrame, MediaItem, Sound, Movie, Button, * MultiStateObject, ClippingPathSettings, TextWrapPreference or FlexObject). */ readonly parent: Button | ClippingPathSettings | EndnoteTextFrame | GraphicLine | MediaItem | Movie | MultiStateObject | Oval | Polygon | Rectangle | Sound | TextFrame | TextWrapPreference | FlexObject | SplineItem; /** * A collection of path points. */ readonly pathPoints: PathPoints; /** * The path type. */ pathType: PathType; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Path[]; /** * Deletes the Path. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Reverses the path. */ reverse(): void; /** * Generates a string which, if executed, will return the Path. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A path point of a path. */ declare class PathPoint { /** * The location of the path point on the page, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ anchor: (number | string)[]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the PathPoint within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The left-direction point, which controls the curve of the line segment * preceding the path point on the path, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ leftDirection: (number | string)[]; /** * The parent of the PathPoint (a Path). */ readonly parent: Path; /** * The path point type. */ pointType: PointType; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The right-direction point, which controls the curve of the line segment * following the path point on the path, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ rightDirection: (number | string)[]; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PathPoint[]; /** * Join this path point to another path point. The two points must be end * points and their paths combined into a single path on a single page item. * @param reference The reference object. The path point to join to * @param given The join option to use. (Optional) */ join(reference: PathPoint, given?: JoinOptions): void; /** * Deletes the PathPoint. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the PathPoint. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of path points. */ declare class PathPoints { /** Returns the PathPoint with the specified index or name. */ [index: number]: PathPoint; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new PathPoint. * @param withProperties Initial values for properties of the new PathPoint (Optional) */ add(withProperties?: Object): PathPoint; /** * Returns any PathPoint in the collection. */ anyItem(): PathPoint; /** * Displays the number of elements in the PathPoint. */ count(): number; /** * Returns every PathPoint in the collection. */ everyItem(): PathPoint; /** * Returns the first PathPoint in the collection. */ firstItem(): PathPoint; /** * Returns the PathPoint with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): PathPoint; /** * Returns the PathPoints within the specified range. * @param from The PathPoint, index, or name at the beginning of the range. Can accept: PathPoint, Long Integer or String. * @param to The PathPoint, index, or name at the end of the range. Can accept: PathPoint, Long Integer or String. */ itemByRange(from: number | PathPoint | string, to: number | PathPoint | string): PathPoint[]; /** * Returns the last PathPoint in the collection. */ lastItem(): PathPoint; /** * Returns the middle PathPoint in the collection. */ middleItem(): PathPoint; /** * Returns the PathPoint whose index follows the specified PathPoint in the * collection. * @param obj The PathPoint whose index comes before the desired PathPoint. */ nextItem(obj: PathPoint): PathPoint; /** * Returns the PathPoint with the index previous to the specified index. * @param obj The index of the PathPoint that follows the desired PathPoint. */ previousItem(obj: PathPoint): PathPoint; /** * Generates a string which, if executed, will return the PathPoint. */ toSource(): string; } /** * Path type options. */ declare enum PathType { /** * The path is a closed path. */ CLOSED_PATH = 1668051812, /** * The path is an open path. */ OPEN_PATH = 1869639280, } /** * Options for aligning text to the path's stroke. */ declare enum PathTypeAlignments { /** * The text is aligned to the bottom of the path stroke. */ BOTTOM_PATH_ALIGNMENT = 1885430367, /** * The text is aligned to the center of the path stroke. */ CENTER_PATH_ALIGNMENT = 1885430623, /** * The text is aligned to the top of the path stroke. */ TOP_PATH_ALIGNMENT = 1885434975, } /** * A collection of paths. */ declare class Paths { /** Returns the Path with the specified index or name. */ [index: number]: Path; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new Path. * @param withProperties Initial values for properties of the new Path (Optional) */ add(withProperties?: Object): Path; /** * Returns any Path in the collection. */ anyItem(): Path; /** * Displays the number of elements in the Path. */ count(): number; /** * Returns every Path in the collection. */ everyItem(): Path; /** * Returns the first Path in the collection. */ firstItem(): Path; /** * Returns the Path with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Path; /** * Returns the Paths within the specified range. * @param from The Path, index, or name at the beginning of the range. Can accept: Path, Long Integer or String. * @param to The Path, index, or name at the end of the range. Can accept: Path, Long Integer or String. */ itemByRange(from: number | Path | string, to: number | Path | string): Path[]; /** * Returns the last Path in the collection. */ lastItem(): Path; /** * Returns the middle Path in the collection. */ middleItem(): Path; /** * Returns the Path whose index follows the specified Path in the collection. * @param obj The Path whose index comes before the desired Path. */ nextItem(obj: Path): Path; /** * Returns the Path with the index previous to the specified index. * @param obj The index of the Path that follows the desired Path. */ previousItem(obj: Path): Path; /** * Generates a string which, if executed, will return the Path. */ toSource(): string; } /** * PDF export display title options. */ declare enum PdfDisplayTitleOptions { /** * Uses document title. */ DISPLAY_DOCUMENT_TITLE = 1148413044, /** * Uses file name. */ DISPLAY_FILE_NAME = 1148413550, } /** * PDF export magnification options. */ declare enum PdfMagnificationOptions { /** * Uses the actual size. */ ACTUAL_SIZE = 2053206906, /** * Uses default magnification. */ DEFAULT_VALUE = 1147563124, /** * Uses 50 percent magnification option. */ FIFTY_PERCENT = 2053531248, /** * Uses the fit height magnification option. */ FIT_HEIGHT = 1212437352, /** * Uses the fit page magnification option. */ FIT_PAGE = 2053534832, /** * Uses the fit visible magnification option. */ FIT_VISIBLE = 1212437334, /** * Uses the fit width magnification option. */ FIT_WIDTH = 1212437335, /** * Uses 100 percent magnification option. */ ONE_HUNDRED_PERCENT = 2053533544, /** * Uses 75 percent magnification option. */ SEVENTY_FIVE_PERCENT = 2053534566, /** * Uses 25 percent magnification option. */ TWENTY_FIVE_PERCENT = 2053534822, } /** * A percentage entry control featuring both a pop-up menu and an entry field. */ declare class PercentCombobox extends Widget { /** * The default value in an editbox control. Note: Do not specify both edit * contents and edit value. If both are specified, the one that occurs later in * the script is used. */ editContents: string; /** * The real number default value of the editbox or combobox. Note: For * measurement controls, the value is interpreted in points. The points value * is converted to edit units when the dialog opens. Note: Do not specify both * edit value and edit contents. If both are specified, the one that occurs * later in the script is used. */ editValue: number; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the PercentCombobox. */ readonly id: number; /** * The index of the PercentCombobox within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The amount to increment/decrement the value when a user selects the control * and holds down the Shift key while pressing an arrow key on the keyboard. */ largeNudge: number; /** * The maximum value that a user is allowed to type in a numeric editbox or * combobox. Note: The value for a measurement editbox or combobox is * interpreted in points, regardless of the edit units specified for the * control. The points value is converted automatically to the edit unit when * the dialog is opened. */ maximumValue: number; /** * The width of the control. For an editbox or combobox, specifies the minimum * width of the box. */ minWidth: number; /** * The minumim value that a user is allowed to type in a numeric editbox or * combobox. Note: The value for a measurement editbox or combobox is * interpreted in points, regardless of the edit units specified for the * control. The points value is converted automatically to the edit unit when * the dialog is opened. */ minimumValue: number; /** * The parent of the PercentCombobox (a DialogColumn, DialogRow, EnablingGroup * or BorderPanel). */ readonly parent: DialogRow | EnablingGroup | BorderPanel | DialogColumn; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The amount to increment/decrement the value when the user selects the * control and presses an arrow key on the keyboard. */ smallNudge: number; /** * The menu items on a dropdown or combobox control, as an array of strings. */ stringList: string[]; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PercentCombobox[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the PercentCombobox. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of percent comboboxes. */ declare class PercentComboboxes { /** Returns the PercentCombobox with the specified index or name. */ [index: number]: PercentCombobox; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new PercentCombobox. * @param withProperties Initial values for properties of the new PercentCombobox (Optional) */ add(withProperties?: Object): PercentCombobox; /** * Returns any PercentCombobox in the collection. */ anyItem(): PercentCombobox; /** * Displays the number of elements in the PercentCombobox. */ count(): number; /** * Returns every PercentCombobox in the collection. */ everyItem(): PercentCombobox; /** * Returns the first PercentCombobox in the collection. */ firstItem(): PercentCombobox; /** * Returns the PercentCombobox with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): PercentCombobox; /** * Returns the PercentCombobox with the specified ID. * @param id The ID. */ itemByID(id: number): PercentCombobox; /** * Returns the PercentComboboxes within the specified range. * @param from The PercentCombobox, index, or name at the beginning of the range. Can accept: PercentCombobox, Long Integer or String. * @param to The PercentCombobox, index, or name at the end of the range. Can accept: PercentCombobox, Long Integer or String. */ itemByRange(from: number | PercentCombobox | string, to: number | PercentCombobox | string): PercentCombobox[]; /** * Returns the last PercentCombobox in the collection. */ lastItem(): PercentCombobox; /** * Returns the middle PercentCombobox in the collection. */ middleItem(): PercentCombobox; /** * Returns the PercentCombobox whose index follows the specified * PercentCombobox in the collection. * @param obj The PercentCombobox whose index comes before the desired PercentCombobox. */ nextItem(obj: PercentCombobox): PercentCombobox; /** * Returns the PercentCombobox with the index previous to the specified index. * @param obj The index of the PercentCombobox that follows the desired PercentCombobox. */ previousItem(obj: PercentCombobox): PercentCombobox; /** * Generates a string which, if executed, will return the PercentCombobox. */ toSource(): string; } /** * A percentage entry field. */ declare class PercentEditbox extends Widget { /** * The default value in an editbox control. Note: Do not specify both edit * contents and edit value. If both are specified, the one that occurs later in * the script is used. */ editContents: string; /** * The real number default value of the editbox or combobox. Note: For * measurement controls, the value is interpreted in points. The points value * is converted to edit units when the dialog opens. Note: Do not specify both * edit value and edit contents. If both are specified, the one that occurs * later in the script is used. */ editValue: number; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the PercentEditbox. */ readonly id: number; /** * The index of the PercentEditbox within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The amount to increment/decrement the value when a user selects the control * and holds down the Shift key while pressing an arrow key on the keyboard. */ largeNudge: number; /** * The maximum value that a user is allowed to type in a numeric editbox or * combobox. Note: The value for a measurement editbox or combobox is * interpreted in points, regardless of the edit units specified for the * control. The points value is converted automatically to the edit unit when * the dialog is opened. */ maximumValue: number; /** * The width of the control. For an editbox or combobox, specifies the minimum * width of the box. */ minWidth: number; /** * The minumim value that a user is allowed to type in a numeric editbox or * combobox. Note: The value for a measurement editbox or combobox is * interpreted in points, regardless of the edit units specified for the * control. The points value is converted automatically to the edit unit when * the dialog is opened. */ minimumValue: number; /** * The parent of the PercentEditbox (a DialogColumn, DialogRow, EnablingGroup * or BorderPanel). */ readonly parent: DialogRow | EnablingGroup | BorderPanel | DialogColumn; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The amount to increment/decrement the value when the user selects the * control and presses an arrow key on the keyboard. */ smallNudge: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PercentEditbox[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the PercentEditbox. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of percent editboxes. */ declare class PercentEditboxes { /** Returns the PercentEditbox with the specified index or name. */ [index: number]: PercentEditbox; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new PercentEditbox. * @param withProperties Initial values for properties of the new PercentEditbox (Optional) */ add(withProperties?: Object): PercentEditbox; /** * Returns any PercentEditbox in the collection. */ anyItem(): PercentEditbox; /** * Displays the number of elements in the PercentEditbox. */ count(): number; /** * Returns every PercentEditbox in the collection. */ everyItem(): PercentEditbox; /** * Returns the first PercentEditbox in the collection. */ firstItem(): PercentEditbox; /** * Returns the PercentEditbox with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): PercentEditbox; /** * Returns the PercentEditbox with the specified ID. * @param id The ID. */ itemByID(id: number): PercentEditbox; /** * Returns the PercentEditboxes within the specified range. * @param from The PercentEditbox, index, or name at the beginning of the range. Can accept: PercentEditbox, Long Integer or String. * @param to The PercentEditbox, index, or name at the end of the range. Can accept: PercentEditbox, Long Integer or String. */ itemByRange(from: number | PercentEditbox | string, to: number | PercentEditbox | string): PercentEditbox[]; /** * Returns the last PercentEditbox in the collection. */ lastItem(): PercentEditbox; /** * Returns the middle PercentEditbox in the collection. */ middleItem(): PercentEditbox; /** * Returns the PercentEditbox whose index follows the specified PercentEditbox * in the collection. * @param obj The PercentEditbox whose index comes before the desired PercentEditbox. */ nextItem(obj: PercentEditbox): PercentEditbox; /** * Returns the PercentEditbox with the index previous to the specified index. * @param obj The index of the PercentEditbox that follows the desired PercentEditbox. */ previousItem(obj: PercentEditbox): PercentEditbox; /** * Generates a string which, if executed, will return the PercentEditbox. */ toSource(): string; } /** * Performance metric options. */ declare enum PerformanceMetricOptions { /** * AGMXShowTime */ AGMXSHOWTIME = 1095191924, /** * Number of attachable events that have been dispatched. */ ATTACHABLE_EVENT_COUNT = 1095058292, /** * Number of attached scripts that have been executed. */ ATTACHED_SCRIPTS_COUNT = 1095975796, /** * BIB Allocations */ BIB_ALLOCATIONS = 1112097345, /** * BIB Allocations peak */ BIB_ALLOCATIONS_PEAK = 1111576683, /** * BIB cache */ BIB_CACHE = 1112097379, /** * BIB cache peak */ BIB_CACHE_PEAK = 1111707755, /** * change manager update call count */ CHANGE_MANAGER_UPDATE_CALL_COUNT = 1129137012, /** * change manager update call time */ CHANGE_MANAGER_UPDATE_CALL_TIME = 1129141357, /** * The core allocation count. */ CORE_ALLOCATION_COUNT = 1128361059, /** * The core memory size. */ CORE_MEMORY_SIZE = 1129539962, /** * The CPU time. */ CPU_TIME = 1668314484, /** * The current memory mark. */ CURRENT_MEMORY_MARK = 1296921195, /** * database file bytes read */ DATABASE_FILE_BYTES_READ = 1145197156, /** * database file bytes written */ DATABASE_FILE_BYTES_WRITTEN = 1145198450, /** * database file page reads */ DATABASE_FILE_PAGE_READS = 1145194098, /** * database file read time */ DATABASE_FILE_READ_TIME = 1145197172, /** * database file write time */ DATABASE_FILE_WRITE_TIME = 1145198452, /** * database instantiate count */ DATABASE_INSTANTIATE_COUNT = 1145194862, /** * database new UID count */ DATABASE_NEW_UID_COUNT = 1145197929, /** * Total amount of time spent dispatching attachable events. */ DISPATCH_EVENT_TIME = 1145394285, /** * draw manager draw time */ DRAW_MANAGER_DRAW_TIME = 1145918573, /** * draw manager number of interrupts */ DRAW_MANAGER_NUMBER_OF_INTERRUPTS = 1145915758, /** * drop shadow file read bytes */ DROP_SHADOW_FILE_READ_BYTES = 1145459298, /** * drop shadow file read time */ DROP_SHADOW_FILE_READ_TIME = 1145459316, /** * drop shadow file write bytes */ DROP_SHADOW_FILE_WRITE_BYTES = 1145460578, /** * drop shadow file write time */ DROP_SHADOW_FILE_WRITE_TIME = 1145460596, /** * drop shadow memory read bytes */ DROP_SHADOW_MEMORY_READ_BYTES = 1146311266, /** * drop shadow memory read time */ DROP_SHADOW_MEMORY_READ_TIME = 1146311284, /** * drop shadow memory write bytes */ DROP_SHADOW_MEMORY_WRITE_BYTES = 1146312546, /** * drop shadow memory write time */ DROP_SHADOW_MEMORY_WRITE_TIME = 1146312564, /** * galley composition count */ GALLEY_COMPOSITION_COUNT = 1195590516, /** * galley composition time */ GALLEY_COMPOSITION_TIME = 1195594861, /** * The GDI object count. */ GDI_OBJECT_COUNT = 1195657582, /** * The handle count. */ HANDLE_COUNT = 1212378740, /** * heap allocations */ HEAP_ALLOCATIONS = 1212247148, /** * heap allocations peak */ HEAP_ALLOCATIONS_PEAK = 1212239979, /** * image cache allocations */ IMAGE_CACHE_ALLOCATIONS = 1231897409, /** * image cache allocations peak */ IMAGE_CACHE_ALLOCATIONS_PEAK = 1229144427, /** * image cache file bytes read */ IMAGE_CACHE_FILE_BYTES_READ = 1231901284, /** * image cache file bytes written */ IMAGE_CACHE_FILE_BYTES_WRITTEN = 1231902578, /** * image cache file read time */ IMAGE_CACHE_FILE_READ_TIME = 1229148772, /** * image cache file write time */ IMAGE_CACHE_FILE_WRITE_TIME = 1229150066, /** * instance cache purge count */ INSTANCE_CACHE_PURGE_COUNT = 1229148259, /** * layout composition count */ LAYOUT_COMPOSITION_COUNT = 1279476596, /** * layout composition time */ LAYOUT_COMPOSITION_TIME = 1279480941, /** * memory purge count */ MEMORY_PURGE_COUNT = 1297105780, /** * memory purge time */ MEMORY_PURGE_TIME = 1297110125, /** * minisave count */ MINISAVE_COUNT = 1297302388, /** * new snapshot time */ NEW_SNAPSHOT_TIME = 1397651284, /** * The number of threads. */ NUMBER_OF_THREADS = 1853122674, /** * The overall system CPU. */ OVERALL_SYSTEM_CPU = 1399025781, /** * The overall user CPU. */ OVERALL_USER_CPU = 1432580213, /** * PDF allocactions */ PDF_ALLOCACTIONS = 1346651713, /** * PDF allocactions peak */ PDF_ALLOCACTIONS_PEAK = 1346650475, /** * process IO bytes read */ PROCESS_IO_BYTES_READ = 1229935204, /** * process IO bytes written */ PROCESS_IO_BYTES_WRITTEN = 1229936498, /** * The resident memory size. */ RESIDENT_MEMORY_SIZE = 1381198202, /** * snapshot count */ SNAPSHOT_COUNT = 1397965684, /** * snapshot read write byte count */ SNAPSHOT_READ_WRITE_BYTE_COUNT = 1397905251, /** * snapshot read write time */ SNAPSHOT_READ_WRITE_TIME = 1397905268, /** * The virtual memory size. */ VIRTUAL_MEMORY_SIZE = 1448307066, /** * VXferAlloc */ VXFERALLOC = 1448633921, /** * VXferAllocPeak */ VXFERALLOCPEAK = 1448624491, /** * VXferBytesRead */ VXFERBYTESREAD = 1448633938, /** * VXferBytesWritten */ VXFERBYTESWRITTEN = 1448633943, /** * VXferFileBytesRead */ VXFERFILEBYTESREAD = 1447445106, /** * VXFerFileBytesWritten */ VXFERFILEBYTESWRITTEN = 1447445111, /** * VXferReadTime */ VXFERREADTIME = 1448628852, /** * VXferWriteTime */ VXFERWRITETIME = 1448630132, /** * XMP filter time */ XMP_FILTER_TIME = 1481461876, } /** * Represents the place gun. */ declare class PlaceGun extends Preference { /** * A collection of buttons. */ readonly buttons: Buttons; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * A collection of EPS files. */ readonly epss: EPSs; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * A collection of form fields. */ readonly formFields: FormFields; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * A collection of groups. */ readonly groups: Groups; /** * A collection of bitmap images in any bitmap file format (including TIFF, * JPEG, or GIF). */ readonly images: Images; /** * Imported InDesign pages. */ readonly importedPages: ImportedPages; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * Whether the place gun is currently loaded with content for placing. */ readonly loaded: boolean; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the PlaceGun (a Document). */ readonly parent: Document; /** * A collection of PDF files. */ readonly pdfs: PDFs; /** * A collection of PICT graphics. */ readonly picts: PICTs; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * A collection of IDML snippets. */ readonly snippets: Snippets; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * A collection of WMF graphics. */ readonly wmfs: WMFs; /** * Delete the contents of the place gun. */ abortPlaceGun(): void; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PlaceGun[]; /** * Load the place gun with one or more files. * @param fileName One or more files to place. Can accept: File or Array of Files. * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ loadPlaceGun(fileName: (File | File[])[], showingOptions?: boolean, withProperties?: Object): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Rotate the contents of the place gun. * @param direction Which direction to rotate the contents (Optional) */ rotate(direction?: RotationDirection): void; /** * Generates a string which, if executed, will return the PlaceGun. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * The color profile policy for placed vector files (PDF or EPS). */ declare enum PlacedVectorProfilePolicy { /** * Honors all profiles and output intent. */ HONOR_ALL_PROFILES = 1148217441, /** * Ignores all profiles and output intent. */ IGNORE_ALL = 1148217697, /** * Ignores output intent; honors calibrated spaces. */ IGNORE_OUTPUT_INTENT = 1148217711, } /** * Playback options. */ declare enum PlayOperations { /** * Pauses playback. */ PAUSE = 1885435251, /** * Starts playback. */ PLAY = 1886151033, /** * Resumes playback. */ RESUME = 1919251317, /** * Stops playback. */ STOP = 1937010544, /** * Stops all playback (SWF only). */ STOP_ALL = 1937010785, } /** * The path point type. */ declare enum PointType { /** * The point is a corner point, it has either one direction line, or two * independent direction lines. */ CORNER = 1668443762, /** * The point is a plain point, it has no direction lines. */ PLAIN = 1886151022, /** * The point is a smooth point, it has two direction lines which are parallel. */ SMOOTH = 1936553064, /** * A special type of smooth point with two direction lines of equal length. */ SYMMETRICAL = 1937337709, } /** * A polygon. Any shape that is not a rectangle, ellipse, or graphic line. When * you add a polygon, InDesign creates a regular polygon based on the current * polygon preferences settings. */ declare class Polygon extends SplineItem { /** * Indicates whether the Polygon has been flipped independently of its parent * object and, if yes, the direction in which the Polygon was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the Polygon relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the Polygon relative to its containing object. (Range: * -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the Polygon relative to its containing object. (Range: * -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the Polygon relative to its containing object. */ absoluteVerticalScale: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the Polygon. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the Polygon. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * Anchored object settings. */ readonly anchoredObjectSettings: AnchoredObjectSetting; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the Polygon. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the Polygon. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the Polygon. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * A collection of buttons. */ readonly buttons: Buttons; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * Transparency settings for the content of the Polygon. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The type of content that a frame can contain. */ contentType: ContentType; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the Polygon. */ endJoin: EndJoin; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * A collection of EPS files. */ readonly epss: EPSs; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * Polygon. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the Polygon's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the Polygon. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * A collection of form fields. */ readonly formFields: FormFields; /** * The frame fitting option to apply to placed or pasted content. Can be * applied to a frame, object style, or document or to the application. */ readonly frameFittingOptions: FrameFittingOption; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the Polygon excluding the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the Polygon. (Range: * -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the Polygon. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the Polygon, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the Polygon. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the Polygon. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the Polygon, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * A collection of groups. */ readonly groups: Groups; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the Polygon. */ horizontalScale: number; /** * A collection of embedded HTML page items. */ readonly htmlItems: HtmlItems; /** * The unique ID of the Polygon. */ readonly id: number; /** * A collection of bitmap images in any bitmap file format (including TIFF, * JPEG, or GIF). */ readonly images: Images; /** * Imported InDesign pages. */ readonly importedPages: ImportedPages; /** * Export options for InCopy INCX document format. */ readonly incopyExportOptions: InCopyExportOption; /** * The index of the Polygon within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the Polygon is on. */ itemLayer: Layer; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * Display performance options for the Polygon. */ localDisplaySetting: DisplaySettingOptions; /** * The lock state. */ readonly lockState: LockStateValues; /** * If true, the Polygon is locked. */ locked: boolean; /** * The media items collection. */ readonly mediaItems: MediaItems; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * A collection of movies. */ readonly movies: Movies; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * The name of the Polygon. */ name: string; /** * If true, the Polygon does not print. */ nonprinting: boolean; /** * Export options for the object */ readonly objectExportOptions: ObjectExportOption; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the Polygon's fill color overprints any underlying objects. If * false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the Polygon's stroke color overprints any underlying objects. If * false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the Polygon (a Snippet, ComboBox, ListBox, TextBox, * SignatureField, Spread, MasterSpread, SplineItem, Polygon, GraphicLine, * Rectangle, Oval, Group, State, Cell, Character, PlaceGun or FlexObject). */ readonly parent: Cell | Character | ComboBox | GraphicLine | Group | ListBox | MasterSpread | Oval | PlaceGun | Polygon | Rectangle | SignatureField | SplineItem | Spread | State | TextBox | FlexObject | Snippet; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of paths. */ readonly paths: Paths; /** * A collection of PDF files. */ readonly pdfs: PDFs; /** * A collection of PICT graphics. */ readonly picts: PICTs; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the Polygon. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the Polygon. (Range: -360 to 360) */ shearAngle: number; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * A collection of sound clips. */ readonly sounds: Sounds; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * Title for this InCopy story. */ storyTitle: string; /** * The stroke alignment applied to the Polygon. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the Polygon. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the Polygon. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the Polygon's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * A collection of text paths. */ readonly textPaths: TextPaths; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the Polygon. */ verticalScale: number; /** * If true, the Polygon is visible. */ visible: boolean; /** * The bounds of the Polygon including the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * A collection of WMF graphics. */ readonly wmfs: WMFs; /** * Dispatched after a Polygon is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a Polygon is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Creates a new page item by combining the Polygon with other objects. Deletes * the objects if they do not intersect. * @param with_ The object(s) to add. */ addPath(with_: PageItem[]): PageItem; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the Polygon's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the Polygon that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Brings the Polygon forward one level in its layer. */ bringForward(): void; /** * Brings the Polygon to the front of its layer or in front of a particular * item. * @param reference The reference object to bring the object in front of (must have same parent) (Optional) */ bringToFront(reference?: PageItem): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Checks in the story or stories. * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ checkIn(versionComments?: string, forceSave?: boolean): boolean; /** * Checks out the story. */ checkOut(): boolean; /** * Removes the frame fittings options and resets it to the initial state. */ clearFrameFittingOptions(): void; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the Polygon. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the Polygon to a different shape. * @param given The Polygon's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Polygon. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Polygon. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Polygon. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Polygon. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Polygon. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the Polygon at the specified location or offset. * @param to The location of the new Polygon, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new Polygon from the original Polygon's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Creates a new page item by excluding the overlapping areas of the Polygon * and other objects. * @param with_ The object(s) to exclude. */ excludeOverlapPath(with_: PageItem[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the Polygon. * @param given The axis around which to flip the Polygon. * @param around The point around which to flip the Polygon. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Polygon[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Creates a new page item by intersecting the Polygon with other objects. * Returns an error if the objects do not intersect. * @param with_ The object(s) with which to intersect. */ intersectPath(with_: PageItem[]): PageItem; /** * Creates a compound path by combining the path(s) of the Polygon with the * paths of other objects. * @param with_ The other objects whose paths to include in the new compound path. */ makeCompoundPath(with_: PageItem[]): PageItem; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Creates a new page item by reverse subtracting the overlapping areas of the * Polygon and other objects. * @param with_ The object(s) to reverse subtract. */ minusBack(with_: PageItem[]): PageItem; /** * Moves the Polygon to a new location. Note: Either the 'to' or 'by' parameter * is required; if both parameters are defined, only the to value is used. * @param to The new location of the Polygon,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the Polygon relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Releases a compound path. */ releaseCompoundPath(): PageItem[]; /** * Deletes the Polygon. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Reverts the document to its state at the last save operation. */ revert(): boolean; /** * Selects the object. * @param existingSelection The selection status of the Polygon in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Sends the Polygon back one level in its layer. */ sendBackward(): void; /** * Sends the Polygon to the back of its layer or behind a particular item (must * have same parent). * @param reference The reference object to send the object behind (Optional) */ sendToBack(reference?: PageItem): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new Polygon (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Creates a new page item by subtracting the overlapping areas of the Polygon * and other objects. * @param with_ The object(s) to subtract. */ subtractPath(with_: PageItem[]): PageItem; /** * Generates a string which, if executed, will return the Polygon. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the Polygon using the last transformation performed on any * object. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgain(): string[]; /** * Transforms the Polygon using the last transformation performed on any * Polygon. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgainIndividually(): string[]; /** * Transforms the Polygon using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the Polygon using the last sequence of transformations performed * on any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * Default settings to use when creating a polygon. */ declare class PolygonPreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The star inset percentage for the sides of a polygon. (Range: 0 to 100) * @remarks Range: 0 to 100 */ insetPercentage: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The number of sides for a polygon. (Range: 3 to 100) * @remarks Range: 3 to 100 */ numberOfSides: number; /** * The parent of the PolygonPreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PolygonPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the PolygonPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of polygons. */ declare class Polygons { /** Returns the Polygon with the specified index or name. */ [index: number]: Polygon; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new Polygon. * @param layer The layer on which to create the Polygon. (Optional) * @param numberOfSides The number of sides to give the Polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage applied to the Polygon. (Optional) * @param at The location at which to insert the Polygon relative to the reference object or within the container object. (Optional) * @param reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) * @param withProperties Initial values for properties of the new Polygon (Optional) */ add(layer?: Layer, numberOfSides?: number, insetPercentage?: number, at?: LocationOptions, reference?: Document | Layer | MasterSpread | Page | Spread | PageItem, withProperties?: Object): Polygon; /** * Returns any Polygon in the collection. */ anyItem(): Polygon; /** * Displays the number of elements in the Polygon. */ count(): number; /** * Returns every Polygon in the collection. */ everyItem(): Polygon; /** * Returns the first Polygon in the collection. */ firstItem(): Polygon; /** * Returns the Polygon with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Polygon; /** * Returns the Polygon with the specified ID. * @param id The ID. */ itemByID(id: number): Polygon; /** * Returns the Polygon with the specified name. * @param name The name. */ itemByName(name: string): Polygon; /** * Returns the Polygons within the specified range. * @param from The Polygon, index, or name at the beginning of the range. Can accept: Polygon, Long Integer or String. * @param to The Polygon, index, or name at the end of the range. Can accept: Polygon, Long Integer or String. */ itemByRange(from: number | Polygon | string, to: number | Polygon | string): Polygon[]; /** * Returns the last Polygon in the collection. */ lastItem(): Polygon; /** * Returns the middle Polygon in the collection. */ middleItem(): Polygon; /** * Returns the Polygon whose index follows the specified Polygon in the * collection. * @param obj The Polygon whose index comes before the desired Polygon. */ nextItem(obj: Polygon): Polygon; /** * Returns the Polygon with the index previous to the specified index. * @param obj The index of the Polygon that follows the desired Polygon. */ previousItem(obj: Polygon): Polygon; /** * Generates a string which, if executed, will return the Polygon. */ toSource(): string; } /** * Text position options. */ declare enum Position { /** * Normal position */ NORMAL = 1852797549, /** * For OpenType fonts, shrinks the text but keeps text on the main text * baseline. Note: Valid only for numeric characters. */ OT_DENOMINATOR = 1884247140, /** * For OpenType fonts, shrinks the text but keeps the top of the characters * aligned with the top of the main text. Note: Valid only for numeric * characters. */ OT_NUMERATOR = 1884247150, /** * For OpenType fonts, uses--if available--lowered glyphs that are sized * correctly relative to the surrounding characters. */ OT_SUBSCRIPT = 1884247138, /** * For OpenType fonts, uses--if available--raised glyphs that are sized * correctly relative to the surrounding characters. */ OT_SUPERSCRIPT = 1884247155, /** * Subscripts the text. */ SUBSCRIPT = 1935831907, /** * Superscripts the text. */ SUPERSCRIPT = 1936749411, } /** * Position attribute which you want to control. */ declare enum PositionAttributes { /** * Both X and Y of position. */ BOTH_X_Y_ATTRIBUTE = 1698855001, /** * X attribute of position. */ X_ATTRIBUTE = 1700282735, /** * Y attribute of position. */ Y_ATTRIBUTE = 1700348271, } /** * OpenType positional form options. */ declare enum PositionalForms { /** * Calculated forms. */ CALCULATE = 1634756205, /** * Final form. */ FINAL = 1718185569, /** * Initial form. */ INITIAL = 1768843636, /** * Isolated form. */ ISOLATED = 1769172844, /** * Medial form. */ MEDIAL = 1835361385, /** * None. */ NONE = 1852796517, } /** * Printer PostScript level options. */ declare enum PostScriptLevels { /** * Level 2 PostScript. */ LEVEL_2 = 1347636274, /** * Level 3 PostScript. */ LEVEL_3 = 1347636275, } /** * A preferences object. */ declare class Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the Preference (a Application, Document, Book, DataMerge, * XmlStory, Spread, FindChangeTransparencySetting, * FindChangeStrokeTransparencySetting, FindChangeFillTransparencySetting, * FindChangeContentTransparencySetting, HtmlItem, FlexObject, SignatureField, * TextBox, RadioButton, ListBox, ComboBox, CheckBox, MultiStateObject, Button, * FormField, Sound, Movie, MediaItem, EPSText, Polygon, GraphicLine, * Rectangle, Oval, SplineItem, SVG, ImportedPage, PICT, WMF, PDF, EPS, Image, * Graphic, Group, EndnoteTextFrame, TextFrame, PageItem, PageItemDefault, * TransparencySetting, StrokeTransparencySetting, FillTransparencySetting, * ContentTransparencySetting, FindObjectPreference, ChangeObjectPreference, * Story, TextVariable, TextWrapPreference, Page, Link, ObjectStyle, * MasterSpread, NamedGrid, TextDefault, ParagraphStyle, InsertionPoint, * TextStyleRange, Paragraph, TextColumn, Line, Word, Character, Text, * FindTextPreference, ChangeTextPreference, FindGrepPreference, * ChangeGrepPreference, FindTransliteratePreference or * ChangeTransliteratePreference). */ readonly parent: Book | Button | ChangeGrepPreference | ChangeObjectPreference | ChangeTextPreference | Character | CheckBox | ComboBox | ContentTransparencySetting | DataMerge | Document | EPS | EPSText | EndnoteTextFrame | FillTransparencySetting | FindChangeContentTransparencySetting | FindChangeFillTransparencySetting | FindChangeStrokeTransparencySetting | FindChangeTransparencySetting | FindGrepPreference | FindObjectPreference | FindTextPreference | FindTransliteratePreference | FlexObject | FormField | Graphic | GraphicLine | Group | HtmlItem | Image | ImportedPage | InsertionPoint | Line | Link | ListBox | MasterSpread | MediaItem | Movie | MultiStateObject | NamedGrid | ObjectStyle | Oval | PDF | PICT | Page | PageItem | PageItemDefault | Paragraph | ParagraphStyle | Polygon | RadioButton | Rectangle | SVG | SignatureField | Sound | SplineItem | Spread | Story | StrokeTransparencySetting | Text | TextBox | TextColumn | TextDefault | TextFrame | TextStyleRange | TextVariable | TextWrapPreference | TransparencySetting | WMF | Word | XmlStory | Application | ChangeTransliteratePreference; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Preference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Preference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of preferences objects. */ declare class Preferences { /** Returns the Preference with the specified index or name. */ [index: number]: Preference; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Preference in the collection. */ anyItem(): Preference; /** * Displays the number of elements in the Preference. */ count(): number; /** * Returns every Preference in the collection. */ everyItem(): Preference; /** * Returns the first Preference in the collection. */ firstItem(): Preference; /** * Returns the Preference with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Preference; /** * Returns the Preferences within the specified range. * @param from The Preference, index, or name at the beginning of the range. Can accept: Preference, Long Integer or String. * @param to The Preference, index, or name at the end of the range. Can accept: Preference, Long Integer or String. */ itemByRange(from: number | Preference | string, to: number | Preference | string): Preference[]; /** * Returns the last Preference in the collection. */ lastItem(): Preference; /** * Returns the middle Preference in the collection. */ middleItem(): Preference; /** * Returns the Preference whose index follows the specified Preference in the * collection. * @param obj The Preference whose index comes before the desired Preference. */ nextItem(obj: Preference): Preference; /** * Returns the Preference with the index previous to the specified index. * @param obj The index of the Preference that follows the desired Preference. */ previousItem(obj: Preference): Preference; /** * Generates a string which, if executed, will return the Preference. */ toSource(): string; } /** * Preflight book options. */ declare class PreflightBookOption extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the PreflightBookOption (a Application or Book). */ readonly parent: Application | Book; /** * If true, include objects that do not print when preflighting. */ preflightIncludeNonprintingObjects: boolean; /** * If true, include objects on pasteboard when preflighting. */ preflightIncludeObjectsOnPasteboard: boolean; /** * The policy for preflighting applied when opening a document or book, whether * to use embedded profile or the another profile when the preflight is turned * on. */ preflightProfilePolicy: PreflightProfileOptions; /** * The pages or documents to preflight, specified either as an enumeration or a * string. To specify a range, separate page numbers in the string with a * hyphen (-). To specify separate pages, separate page numbers in the string * with a comma (,). Can return: PreflightScopeOptions enumerator or String. */ preflightScope: PreflightScopeOptions | string; /** * Which layers to preflight. */ preflightWhichLayers: PreflightLayerOptions; /** * The working preflight profile. Can return: PreflightProfile or String. */ preflightWorkingProfile: PreflightProfile | string; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PreflightBookOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the PreflightBookOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Preflight layer options. */ declare enum PreflightLayerOptions { /** * Preflight all layers */ PREFLIGHT_ALL_LAYERS = 1886142796, /** * Preflight visible layers */ PREFLIGHT_VISIBLE_LAYERS = 1886148172, /** * Preflight visible and printable layers */ PREFLIGHT_VISIBLE_PRINTABLE_LAYERS = 1886148176, } /** * Preflight options. */ declare class PreflightOption extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the PreflightOption (a Application or Document). */ readonly parent: Application | Document; /** * If true, embed working profile when creating new document. */ preflightEmbedWorkingProfile: boolean; /** * If true, include objects that do not print when preflighting. */ preflightIncludeNonprintingObjects: boolean; /** * If true, include objects on pasteboard when preflighting. */ preflightIncludeObjectsOnPasteboard: boolean; /** * If true, preflight is turned off for all documents or for this document. */ preflightOff: boolean; /** * The policy for preflighting applied when opening a document or book, whether * to use embedded profile or the another profile when the preflight is turned * on. */ preflightProfilePolicy: PreflightProfileOptions; /** * The pages or documents to preflight, specified either as an enumeration or a * string. To specify a range, separate page numbers in the string with a * hyphen (-). To specify separate pages, separate page numbers in the string * with a comma (,). Can return: PreflightScopeOptions enumerator or String. */ preflightScope: PreflightScopeOptions | string; /** * Which layers to preflight. */ preflightWhichLayers: PreflightLayerOptions; /** * The working preflight profile. Can return: PreflightProfile or String. */ preflightWorkingProfile: PreflightProfile | string; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PreflightOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the PreflightOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * An active preflight process. */ declare class PreflightProcess { /** * The aggregated results found by the process. Can return: Ordered array * containing documentName:String, profileName:String, results:Array of Ordered * array containing parentNodeID:Long Integer, errorName:String, * pageNumber:String, errorInfo:String, errorDetail:Array of Ordered array * containing label:String, description:String. */ readonly aggregatedResults: (any[] | string)[]; /** * The preflight profile the process is using. */ readonly appliedProfile: PreflightProfile; /** * The description of the PreflightProcess. */ readonly description: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the PreflightProcess within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the PreflightProcess (a Application). */ readonly parent: Application; /** * A string containing a description of all elements visited by the process. */ readonly processInventory: string; /** * The results found by the process as a large string. */ readonly processResults: string; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The target document the process is inspecting. */ readonly targetObject: Document; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PreflightProcess[]; /** * Deletes the PreflightProcess. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Saves a report of the completed preflight process. * @param to The preflight report to save to. * @param autoOpen If true, automatically open the report after creation. (Optional) */ saveReport(to: File, autoOpen?: boolean): void; /** * Generates a string which, if executed, will return the PreflightProcess. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Waits for the process to finish, up to an optional maximum amount of time. * No other processes get cycles during this time. * @param waitTime The maximum time to wait, in seconds; if omitted, waits until completion no matter how long it takes. (Optional) */ waitForProcess(waitTime?: number): boolean; } /** * A collection of preflight processes. */ declare class PreflightProcesses { /** Returns the PreflightProcess with the specified index or name. */ [index: number]: PreflightProcess; /** * The number of objects in the collection. */ readonly length: number; /** * Adds a new preflight process. * @param targetObject The document the process should inspect. * @param appliedProfile The preflight profile that should be used. * @param preflightOptions The preflight options that should be used. (Optional) * @param withProperties Initial values for properties of the new PreflightProcess (Optional) */ add(targetObject: Document, appliedProfile: PreflightProfile, preflightOptions?: PreflightOption, withProperties?: Object): PreflightProcess; /** * Returns any PreflightProcess in the collection. */ anyItem(): PreflightProcess; /** * Displays the number of elements in the PreflightProcess. */ count(): number; /** * Returns every PreflightProcess in the collection. */ everyItem(): PreflightProcess; /** * Returns the first PreflightProcess in the collection. */ firstItem(): PreflightProcess; /** * Returns the PreflightProcess with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): PreflightProcess; /** * Returns the PreflightProcesses within the specified range. * @param from The PreflightProcess, index, or name at the beginning of the range. Can accept: PreflightProcess, Long Integer or String. * @param to The PreflightProcess, index, or name at the end of the range. Can accept: PreflightProcess, Long Integer or String. */ itemByRange(from: number | PreflightProcess | string, to: number | PreflightProcess | string): PreflightProcess[]; /** * Returns the last PreflightProcess in the collection. */ lastItem(): PreflightProcess; /** * Returns the middle PreflightProcess in the collection. */ middleItem(): PreflightProcess; /** * Returns the PreflightProcess whose index follows the specified * PreflightProcess in the collection. * @param obj The PreflightProcess whose index comes before the desired PreflightProcess. */ nextItem(obj: PreflightProcess): PreflightProcess; /** * Returns the PreflightProcess with the index previous to the specified index. * @param obj The index of the PreflightProcess that follows the desired PreflightProcess. */ previousItem(obj: PreflightProcess): PreflightProcess; /** * Generates a string which, if executed, will return the PreflightProcess. */ toSource(): string; } /** * A preflight profile. */ declare class PreflightProfile { /** * The description of the PreflightProfile. */ description: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the PreflightProfile. */ readonly id: number; /** * The index of the PreflightProfile within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the PreflightProfile. */ name: string; /** * The parent of the PreflightProfile (a Application or Document). */ readonly parent: Application | Document; /** * A collection of preflight profile rules. */ readonly preflightProfileRules: PreflightProfileRules; /** * A collection of preflight rule instances. */ readonly preflightRuleInstances: PreflightRuleInstances; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the PreflightProfile. */ duplicate(): PreflightProfile; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PreflightProfile[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the PreflightProfile. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Saves this preflight profile to a InDesign preflight profile file. * @param to The preflight profile file to save to. */ save(to: File): void; /** * Generates a string which, if executed, will return the PreflightProfile. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Unembed this profile. */ unembed(): void; /** * Update the preflight profile by copying from another profile. * @param using The preflight profile to copy. Can accept: String or PreflightProfile. (Optional) */ update(using?: string | PreflightProfile): void; } /** * Preflight Profile options. */ declare enum PreflightProfileOptions { /** * Preflight using the embedded profile. */ USE_EMBEDDED_PROFILE = 1885619533, /** * Preflight using working profile. */ USE_WORKING_PROFILE = 1885622342, } /** * A preflight profile rule. */ declare class PreflightProfileRule { /** * The description of the PreflightProfileRule. */ readonly description: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Indicates whether or not the preflight rule is disabled, set for error, * warning, or information level feedback. */ flag: PreflightRuleFlag; /** * The rule ID for this rule. */ readonly id: string; /** * The index of the PreflightProfileRule within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the PreflightProfileRule. */ readonly name: string; /** * The parent of the PreflightProfileRule (a PreflightProfile). */ readonly parent: PreflightProfile; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of prefight rule data objects. */ readonly ruleDataObjects: RuleDataObjects; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PreflightProfileRule[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the PreflightProfileRule. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the PreflightProfileRule. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of preflight profile rules. */ declare class PreflightProfileRules { /** Returns the PreflightProfileRule with the specified index or name. */ [index: number]: PreflightProfileRule; /** * The number of objects in the collection. */ readonly length: number; /** * Adds a new preflight rule to the profile. * @param id The ID of the rule to be added * @param withProperties Initial values for properties of the new PreflightProfileRule (Optional) */ add(id: string, withProperties?: Object): any; /** * Returns any PreflightProfileRule in the collection. */ anyItem(): PreflightProfileRule; /** * Displays the number of elements in the PreflightProfileRule. */ count(): number; /** * Returns every PreflightProfileRule in the collection. */ everyItem(): PreflightProfileRule; /** * Returns the first PreflightProfileRule in the collection. */ firstItem(): PreflightProfileRule; /** * Returns the PreflightProfileRule with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): PreflightProfileRule; /** * Returns the PreflightProfileRule with the specified ID. * @param id The ID. */ itemByID(id: number): PreflightProfileRule; /** * Returns the PreflightProfileRule with the specified name. * @param name The name. */ itemByName(name: string): PreflightProfileRule; /** * Returns the PreflightProfileRules within the specified range. * @param from The PreflightProfileRule, index, or name at the beginning of the range. Can accept: PreflightProfileRule, Long Integer or String. * @param to The PreflightProfileRule, index, or name at the end of the range. Can accept: PreflightProfileRule, Long Integer or String. */ itemByRange(from: number | PreflightProfileRule | string, to: number | PreflightProfileRule | string): PreflightProfileRule[]; /** * Returns the last PreflightProfileRule in the collection. */ lastItem(): PreflightProfileRule; /** * Returns the middle PreflightProfileRule in the collection. */ middleItem(): PreflightProfileRule; /** * Returns the PreflightProfileRule whose index follows the specified * PreflightProfileRule in the collection. * @param obj The PreflightProfileRule whose index comes before the desired PreflightProfileRule. */ nextItem(obj: PreflightProfileRule): PreflightProfileRule; /** * Returns the PreflightProfileRule with the index previous to the specified * index. * @param obj The index of the PreflightProfileRule that follows the desired PreflightProfileRule. */ previousItem(obj: PreflightProfileRule): PreflightProfileRule; /** * Generates a string which, if executed, will return the PreflightProfileRule. */ toSource(): string; } /** * A collection of preflight profiles. */ declare class PreflightProfiles { /** Returns the PreflightProfile with the specified index or name. */ [index: number]: PreflightProfile; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new PreflightProfile. * @param withProperties Initial values for properties of the new PreflightProfile (Optional) */ add(withProperties?: Object): PreflightProfile; /** * Returns any PreflightProfile in the collection. */ anyItem(): PreflightProfile; /** * Displays the number of elements in the PreflightProfile. */ count(): number; /** * Returns every PreflightProfile in the collection. */ everyItem(): PreflightProfile; /** * Returns the first PreflightProfile in the collection. */ firstItem(): PreflightProfile; /** * Returns the PreflightProfile with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): PreflightProfile; /** * Returns the PreflightProfile with the specified ID. * @param id The ID. */ itemByID(id: number): PreflightProfile; /** * Returns the PreflightProfile with the specified name. * @param name The name. */ itemByName(name: string): PreflightProfile; /** * Returns the PreflightProfiles within the specified range. * @param from The PreflightProfile, index, or name at the beginning of the range. Can accept: PreflightProfile, Long Integer or String. * @param to The PreflightProfile, index, or name at the end of the range. Can accept: PreflightProfile, Long Integer or String. */ itemByRange(from: number | PreflightProfile | string, to: number | PreflightProfile | string): PreflightProfile[]; /** * Returns the last PreflightProfile in the collection. */ lastItem(): PreflightProfile; /** * Returns the middle PreflightProfile in the collection. */ middleItem(): PreflightProfile; /** * Returns the PreflightProfile whose index follows the specified * PreflightProfile in the collection. * @param obj The PreflightProfile whose index comes before the desired PreflightProfile. */ nextItem(obj: PreflightProfile): PreflightProfile; /** * Returns the PreflightProfile with the index previous to the specified index. * @param obj The index of the PreflightProfile that follows the desired PreflightProfile. */ previousItem(obj: PreflightProfile): PreflightProfile; /** * Generates a string which, if executed, will return the PreflightProfile. */ toSource(): string; } /** * A preflight rule */ declare class PreflightRule { /** * The description of the PreflightRule. */ readonly description: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, the preflight rule is fully supported. */ fullFeature: boolean; /** * The rule ID for this rule. */ readonly id: string; /** * The index of the PreflightRule within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the PreflightRule. */ readonly name: string; /** * The parent of the PreflightRule (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PreflightRule[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the PreflightRule. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * The flag indicating whether the rule is disabled, set for error, warning, or * just informational. */ declare enum PreflightRuleFlag { /** * Treat as error if rule check failed. */ RETURN_AS_ERROR = 1699890546, /** * Treat as information only if rule check failed. */ RETURN_AS_INFORMATIONAL = 1699893865, /** * Treat as warning if rule check failed. */ RETURN_AS_WARNING = 1699893879, /** * Rule is currently disabled. */ RULE_IS_DISABLED = 1699890274, } /** * A preflight rule instance. */ declare class PreflightRuleInstance extends PreflightProfileRule { /** * The description of the PreflightRuleInstance. */ readonly description: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Indicates whether or not the preflight rule is disabled, set for error, * warning, or information level feedback. */ flag: PreflightRuleFlag; /** * The rule ID for this rule. */ readonly id: string; /** * The index of the PreflightRuleInstance within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the PreflightRuleInstance. */ readonly name: string; /** * The parent of the PreflightRuleInstance (a PreflightProfile). */ readonly parent: PreflightProfile; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of prefight rule data objects. */ readonly ruleDataObjects: RuleDataObjects; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PreflightRuleInstance[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the PreflightRuleInstance. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * PreflightRuleInstance. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of preflight rule instances. */ declare class PreflightRuleInstances { /** Returns the PreflightRuleInstance with the specified index or name. */ [index: number]: PreflightRuleInstance; /** * The number of objects in the collection. */ readonly length: number; /** * Adds a new preflight rule to the profile. * @param id The ID of the rule to be added * @param withProperties Initial values for properties of the new PreflightRuleInstance (Optional) */ add(id: string, withProperties?: Object): any; /** * Returns any PreflightRuleInstance in the collection. */ anyItem(): PreflightRuleInstance; /** * Displays the number of elements in the PreflightRuleInstance. */ count(): number; /** * Returns every PreflightRuleInstance in the collection. */ everyItem(): PreflightRuleInstance; /** * Returns the first PreflightRuleInstance in the collection. */ firstItem(): PreflightRuleInstance; /** * Returns the PreflightRuleInstance with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): PreflightRuleInstance; /** * Returns the PreflightRuleInstance with the specified ID. * @param id The ID. */ itemByID(id: number): PreflightRuleInstance; /** * Returns the PreflightRuleInstance with the specified name. * @param name The name. */ itemByName(name: string): PreflightRuleInstance; /** * Returns the PreflightRuleInstances within the specified range. * @param from The PreflightRuleInstance, index, or name at the beginning of the range. Can accept: PreflightRuleInstance, Long Integer or String. * @param to The PreflightRuleInstance, index, or name at the end of the range. Can accept: PreflightRuleInstance, Long Integer or String. */ itemByRange(from: number | PreflightRuleInstance | string, to: number | PreflightRuleInstance | string): PreflightRuleInstance[]; /** * Returns the last PreflightRuleInstance in the collection. */ lastItem(): PreflightRuleInstance; /** * Returns the middle PreflightRuleInstance in the collection. */ middleItem(): PreflightRuleInstance; /** * Returns the PreflightRuleInstance whose index follows the specified * PreflightRuleInstance in the collection. * @param obj The PreflightRuleInstance whose index comes before the desired PreflightRuleInstance. */ nextItem(obj: PreflightRuleInstance): PreflightRuleInstance; /** * Returns the PreflightRuleInstance with the index previous to the specified * index. * @param obj The index of the PreflightRuleInstance that follows the desired PreflightRuleInstance. */ previousItem(obj: PreflightRuleInstance): PreflightRuleInstance; /** * Generates a string which, if executed, will return the * PreflightRuleInstance. */ toSource(): string; } /** * A collection of preflight rules. */ declare class PreflightRules { /** Returns the PreflightRule with the specified index or name. */ [index: number]: PreflightRule; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any PreflightRule in the collection. */ anyItem(): PreflightRule; /** * Displays the number of elements in the PreflightRule. */ count(): number; /** * Returns every PreflightRule in the collection. */ everyItem(): PreflightRule; /** * Returns the first PreflightRule in the collection. */ firstItem(): PreflightRule; /** * Returns the PreflightRule with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): PreflightRule; /** * Returns the PreflightRule with the specified ID. * @param id The ID. */ itemByID(id: number): PreflightRule; /** * Returns the PreflightRule with the specified name. * @param name The name. */ itemByName(name: string): PreflightRule; /** * Returns the PreflightRules within the specified range. * @param from The PreflightRule, index, or name at the beginning of the range. Can accept: PreflightRule, Long Integer or String. * @param to The PreflightRule, index, or name at the end of the range. Can accept: PreflightRule, Long Integer or String. */ itemByRange(from: number | PreflightRule | string, to: number | PreflightRule | string): PreflightRule[]; /** * Returns the last PreflightRule in the collection. */ lastItem(): PreflightRule; /** * Returns the middle PreflightRule in the collection. */ middleItem(): PreflightRule; /** * Returns the PreflightRule whose index follows the specified PreflightRule in * the collection. * @param obj The PreflightRule whose index comes before the desired PreflightRule. */ nextItem(obj: PreflightRule): PreflightRule; /** * Returns the PreflightRule with the index previous to the specified index. * @param obj The index of the PreflightRule that follows the desired PreflightRule. */ previousItem(obj: PreflightRule): PreflightRule; /** * Generates a string which, if executed, will return the PreflightRule. */ toSource(): string; } /** * Preflight scope options. */ declare enum PreflightScopeOptions { /** * Include all documents in the book preflight. */ PREFLIGHT_ALL_DOCUMENTS = 1885552964, /** * Include all pages in the preflight. */ PREFLIGHT_ALL_PAGES = 1885552976, /** * Include only selected document for book preflight. */ PREFLIGHT_SELECTED_DOCUMENTS = 1885557572, } /** * Preserve Appearance from Layout Options */ declare enum PreserveAppearanceFromLayoutEnum { /** * Export preferences will be honoured */ PRESERVE_APPEARANCE_DEFAULT = 1349665893, /** * Container & content both will be rasterized, if can be */ PRESERVE_APPEARANCE_RASTERIZE_CONTAINER = 1349669490, /** * Content will be rasterized, if can be */ PRESERVE_APPEARANCE_RASTERIZE_CONTENT = 1349669492, /** * Exiting image will be used */ PRESERVE_APPEARANCE_USE_EXISTING_IMAGE = 1349670245, } /** * Options for preview pages. */ declare enum PreviewPagesOptions { /** * All pages. */ ALL_PAGES = 1886547553, /** * First ten pages. */ FIRST_10_PAGES = 1180192871, /** * First two pages. */ FIRST_2_PAGES = 1177702503, /** * First five pages. */ FIRST_5_PAGES = 1177899111, /** * First page. */ FIRST_PAGE = 1700947536, } /** * Preview size options. */ declare enum PreviewSizeOptions { /** * Extra large preview (1024 x 1024). */ EXTRA_LARGE = 1162629234, /** * Large preview (512 x 512). */ LARGE = 1281446002, /** * Medium preview (256 x 256). */ MEDIUM = 1701727588, /** * Small preview (128 x 128). */ SMALL = 1399672946, } /** * Preview image file format options. */ declare enum PreviewTypes { /** * Does not save a preview image. */ NONE = 1852796517, /** * Saves the preview in TIFF format. */ TIFF_PREVIEW = 1164997734, } /** * Print booklet options. */ declare class PrintBookletOption extends Preference { /** * If true, automatically adjust margins to fit the specified printer's marks * and bleed area. */ autoAdjustMargins: boolean; /** * The amount of bleed between pages. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedBetweenPages: number | string; /** * The type of booklet. */ bookletType: BookletTypeOptions; /** * Bottom margin of the printed booklet. * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomMargin: number | string; /** * The amount of creep (binding adjustment based on paper thickness) to add. * @remarks Measurement unit — also accepts a string such as "12mm". */ creep: number | string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * Left margin of the printed booklet. * @remarks Measurement unit — also accepts a string such as "12mm". */ leftMargin: number | string; /** * If true, make all margins equal to the top margin. */ marginsUniformSize: boolean; /** * The pages to print, specified either as an enumeration or a string. To * specify a range, separate page numbers in the string with a hyphen (-). To * specify separate pages, separate page numbers in the string with a comma * (,). Can return: PageRange enumerator or String. */ pageRange: PageRange | string; /** * The parent of the PrintBookletOption (a Document). */ readonly parent: Document; /** * If true, print blank spreads. */ printBlankPrinterSpreads: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Right margin of the printed booklet. * @remarks Measurement unit — also accepts a string such as "12mm". */ rightMargin: number | string; /** * The signature size of booklet (for perfect binding). */ signatureSize: SignatureSizeOptions; /** * The amount of space between pages. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceBetweenPages: number | string; /** * Top margin of the printed booklet. * @remarks Measurement unit — also accepts a string such as "12mm". */ topMargin: number | string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PrintBookletOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the PrintBookletOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Print booklet preferences. */ declare class PrintBookletPrintPreference extends Preference { /** * The current printer preset type. Can return: PrinterPresetTypes enumerator * or PrinterPreset. */ activePrinterPreset: PrinterPresetTypes | PrinterPreset; /** * If true, prints all printer marks. If false, prints specified printer marks. */ allPrinterMarks: boolean; /** * If true, uses bitmap printing. */ bitmapPrinting: boolean; /** * The resolution for bitmap printing. (Range: 72 to 1200) Note: Valid when * bitmap printing is true. * @remarks Range: 72 to 1200 */ bitmapResolution: number; /** * The angle override for black ink. (Range: 0 to 360) * @remarks Range: 0 to 360 */ blackAngle: number; /** * The frequency override for black ink. (Range: 1 to 500) * @remarks Range: 1 to 500 */ blackFrequency: number; /** * The height of the bleed area at the bottom of the page. Note: Valid only * when use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedBottom: number | string; /** * If true, forces all bleed area settings to be the same, using the most * recent bleed measurement setting. If false, allows bleed top, bleed bottom, * bleed inside, and bleed outside to have different measurements. */ bleedChain: boolean; /** * The width of the bleed area at the inside of the page. Note: Valid only when * use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedInside: number | string; /** * If true, print bleed marks. */ bleedMarks: boolean; /** * The width of the bleed area at the outside of the page. Note: Valid only * when use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedOutside: number | string; /** * The height of the bleed area at the top of the page. Note: Valid only when * use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedTop: number | string; /** * If true, collate printed copies. */ collating: boolean; /** * If true, add small squares of color representing the CMYK inks and tints of * gray in 10% increments. */ colorBars: boolean; /** * The color output mode for composites. Note: Not valid when a * device-independent PPD is specified. */ colorOutput: ColorOutputModes; /** * The screen angle to use when printing composites. (Range: 0 to 360) Note: * Valid only for PostScript or PDF files that use custom screening. * @remarks Range: 0 to 360 */ compositeAngle: number; /** * The screen frequency to use when printing composites. (Range: 1 to 500) * Note: Valid only for PostScript or PDF files that use custom screening. * @remarks Range: 1 to 500 */ compositeFrequency: number; /** * The number of copies to print. Note: Not valid when printer is PostScript * File. */ copies: number; /** * The color-rendering dictionary (CRD), specified as a CRD name or an * enumeration value. Note: Valid only when use color management is true. Can * return: ColorRenderingDictionary enumerator or String. */ crd: ColorRenderingDictionary | string; /** * Prints crop marks that define where the page should be trimmed. */ cropMarks: boolean; /** * The angle override for cyan ink. (Range: 0 to 360) * @remarks Range: 0 to 360 */ cyanAngle: number; /** * The frequency override for cyan ink. (Range: 1 to 500) * @remarks Range: 1 to 500 */ cyanFrequency: number; /** * The format in which to send image data to the printer. */ dataFormat: DataFormat; /** * If true, downloads all fonts listed in the selected PPD. Valid only when * font downloading is complete or subset. */ downloadPPDFonts: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The name of the transparency flattener preset. */ flattenerPresetName: string; /** * The direction in which to flip the printed image. */ flip: Flip; /** * Controls how fonts are downloaded to the printer. */ fontDownloading: FontDownloading; /** * If true, ignores flattener spread overrides. */ ignoreSpreadOverrides: boolean; /** * The rendering intent. Note: Valid only when use color management is true. */ intent: RenderingIntent; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The angle override for magenta ink. (Range: 0 to 360) * @remarks Range: 0 to 360 */ magentaAngle: number; /** * The frequency override for magenta ink. (Range: 1 to 500) * @remarks Range: 1 to 500 */ magentaFrequency: number; /** * The stroke weight (in points) for printer marks. */ markLineWeight: MarkLineWeight; /** * The distance to offset the page marks from the edge of the page. * @remarks Measurement unit — also accepts a string such as "12mm". */ markOffset: number | string; /** * The type of printer marks, either an enum value or the name of a custom * marks file. Can return: MarkTypes enumerator or String. */ markType: MarkTypes | string; /** * If true, prints the document as a negative. */ negative: boolean; /** * If true, replaces bitmap images with OPI links. */ omitBitmaps: boolean; /** * If true, replaces EPS images with OPI links. */ omitEPS: boolean; /** * If true, replaces PDF images with OPI links. */ omitPDF: boolean; /** * If true, prints graphics that are either OPI comments stored in imported EPS * files or linked using OPI comments. For information on linking files using * OPI comments, see omit EPS, omit PDF, or omit bitmaps. */ opiImageReplacement: boolean; /** * If true, prints the filename, page number, current date and time, and color * separation name. */ pageInformationMarks: boolean; /** * The position of the page on the printing medium. Note: Valid only when tile * is false. */ pagePosition: PagePositions; /** * The space between document pages on the printing medium. * @remarks Measurement unit — also accepts a string such as "12mm". */ paperGap: number | string; /** * The paper height. Note: Valid only when paper size is custom or scale mode * is scale width height. Can return: PaperSize enumerator or Unit. */ paperHeight: PaperSize | number; /** * The amount of space to offset the page from the left edge of the imageable * area. * @remarks Measurement unit — also accepts a string such as "12mm". */ paperOffset: number | string; /** * The paper size, specified as either a string or an enumeration. For * information on paper size names, see paper size list. Can return: PaperSizes * enumerator or String. */ paperSize: PaperSizes | string; /** * A list of the available paper sizes. */ readonly paperSizeList: string[]; /** * If true, uses transverse orientation. */ paperTransverse: boolean; /** * The paper width. Note: Valid only when paper size is custom or scale mode is * scale width height. Can return: PaperSize enumerator or Unit. */ paperWidth: PaperSize | number; /** * The parent of the PrintBookletPrintPreference (a Document). */ readonly parent: Document; /** * If true, doing pdf passthrough. */ readonly pdfPassthrough: boolean; /** * The PostScript level of the printer. */ postscriptLevel: PostScriptLevels; /** * The PPD, specified as a PPD name or an enumeration. Can return: PPDValues * enumerator or String. */ ppd: PPDValues | string; /** * Available PPDs. */ readonly ppdList: string[]; /** * If true, preserves uncalibrated color numbers. */ preserveColorNumbers: boolean; /** * If true, prints the black ink. Note: Valid only when trapping is off. */ printBlack: boolean; /** * If true, prints blank pages. Note: Valid only when trapping is off. */ printBlankPages: boolean; /** * If true, prints the cyan ink. Note: Valid only when trapping is off. */ printCyan: boolean; /** * The PostScript file to print to. Note: Valid only when the current printer * is defined as postscript file. */ printFile: File; /** * If true, prints visible guides and baseline grids. Note: Valid only when * trapping is off. */ printGuidesGrids: boolean; /** * The layers to print. */ printLayers: PrintLayerOptions; /** * If true, prints the magenta ink. Note: Valid only when trapping is off. */ printMagenta: boolean; /** * If true, prints non-printing objects. Note: Valid only when trapping is off. */ printNonprinting: boolean; /** * The orientation of the printed page. */ printPageOrientation: PrintPageOrientation; /** * If true, prints the yellow ink. Note: Valid only when trapping is off. */ printYellow: boolean; /** * The current printer. Can return: Printer enumerator or String. */ printer: Printer | string; /** * Available printers. */ readonly printerList: string[]; /** * The color profile. Can return: Profile enumerator or String. */ profile: Profile | string; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, prints small targets outside the page area for aligning color * separations. */ registrationMarks: boolean; /** * If true, prints pages in reverse order. */ reverseOrder: boolean; /** * The amount (as a percentage) that the page height is scaled during printing. * (Range: 0 to 1000) Note: Valid only when scale mode is scale width height. * @remarks Range: 0 to 1000 */ scaleHeight: number; /** * The policy for scaling the page. Note: Valid only when printing from Layout * view. */ scaleMode: ScaleModes; /** * If true, constrains the proportions of the scaling; uses the most recent * value for either scale width or scale height to define both values. Note: * Valid only when scale mode is scale width height. */ scaleProportional: boolean; /** * The amount (as a percentage) that the page width is scaled during printing. * (Range: 0 to 1000) Note: Valid only when scale mode is scale width height. * @remarks Range: 0 to 1000 */ scaleWidth: number; /** * The ink screening settings for composite gray output in PostScript or PDF * format. . Can return: Screeening enumerator or String. */ screening: Screeening | string; /** * Lists the ink screenings available in the PPD. Note: Valid only when color * output is separations or in rip separations. */ readonly screeningList: string[]; /** * The image data sent to the printer or file. */ sendImageData: ImageDataTypes; /** * If true, simulates the effects of overprinting spot inks with different * neutral density values by converting spot colors to process colors for * printing. Note: Not valid when the color output mode is defined to leave * color profiles unchanged. */ simulateOverprint: boolean; /** * The source of the color management system. Note: Valid only when use color * management is true. */ sourceSpace: SourceSpaces; /** * If true, prints all text as black unless text has the color None or Paper or * a color value that equals white. If false, prints colored text, such as blue * hyperlinks, in halftone patterns. Note: Valid only when trapping is off. */ textAsBlack: boolean; /** * The type of trapping. */ trapping: Trapping; /** * If true, uses the bleed area set for the document. */ useDocumentBleedToPrint: boolean; /** * The angle override for yellow ink. (Range: 0 to 360) * @remarks Range: 0 to 360 */ yellowAngle: number; /** * The frequency override for yellow ink. (Range: 1 to 500) * @remarks Range: 1 to 500 */ yellowFrequency: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PrintBookletPrintPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * PrintBookletPrintPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A print event */ declare class PrintEvent extends Event { /** * If true, the event supports the bubbling phase of propagation. */ readonly bubbles: boolean; /** * If true, the default behavior of the event on its target can be canceled. */ readonly cancelable: boolean; /** * The current propagation target of the event. */ readonly currentTarget: any; /** * If true, the default behavior of the event on its target has been canceled. */ readonly defaultPrevented: boolean; /** * UI options for print document */ documentPrintUiOption: DocumentPrintUiOptions[]; /** * The current propagation phase of the event. */ readonly eventPhase: EventPhases; /** * The name of the event. */ readonly eventType: string; /** * The unique ID of the PrintEvent. */ readonly id: number; /** * The index of the PrintEvent within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the PrintEvent (a Document). */ readonly parent: Document; /** * If true, propagation of the event beyond the current target has been * stopped. */ readonly propagationStopped: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The target of the event. */ readonly target: any; /** * The time the event was initialized. */ readonly timeStamp: Date; /** * Dispatched after a PrintEvent is printed. This event bubbles. This event is * not cancelable. */ static readonly AFTER_PRINT: string; /** * Dispatched before a PrintEvent is printed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PRINT: string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PrintEvent[]; /** * Cancels the default behavior of the event on its target. */ preventDefault(): void; /** * Stops propagation of the event beyond the current target. */ stopPropagation(): void; /** * Generates a string which, if executed, will return the PrintEvent. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A behavior object that triggers print for the document. */ declare class PrintFormBehavior extends Behavior { /** * The event which triggers the behavior. */ behaviorEvent: BehaviorEvents; /** * If true, the behavior is enabled. */ enableBehavior: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the PrintFormBehavior. */ readonly id: number; /** * The index of the PrintFormBehavior within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the PrintFormBehavior. */ readonly name: string; /** * The parent of the PrintFormBehavior (a Button, CheckBox, ComboBox, ListBox, * RadioButton, TextBox or SignatureField). */ readonly parent: CheckBox | ComboBox | ListBox | RadioButton | TextBox | Button | SignatureField; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PrintFormBehavior[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the PrintFormBehavior. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the PrintFormBehavior. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of print form behavior objects. */ declare class PrintFormBehaviors { /** Returns the PrintFormBehavior with the specified index or name. */ [index: number]: PrintFormBehavior; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new PrintFormBehavior. * @param withProperties Initial values for properties of the new PrintFormBehavior (Optional) */ add(withProperties?: Object): PrintFormBehavior; /** * Returns any PrintFormBehavior in the collection. */ anyItem(): PrintFormBehavior; /** * Displays the number of elements in the PrintFormBehavior. */ count(): number; /** * Returns every PrintFormBehavior in the collection. */ everyItem(): PrintFormBehavior; /** * Returns the first PrintFormBehavior in the collection. */ firstItem(): PrintFormBehavior; /** * Returns the PrintFormBehavior with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): PrintFormBehavior; /** * Returns the PrintFormBehavior with the specified ID. * @param id The ID. */ itemByID(id: number): PrintFormBehavior; /** * Returns the PrintFormBehavior with the specified name. * @param name The name. */ itemByName(name: string): PrintFormBehavior; /** * Returns the PrintFormBehaviors within the specified range. * @param from The PrintFormBehavior, index, or name at the beginning of the range. Can accept: PrintFormBehavior, Long Integer or String. * @param to The PrintFormBehavior, index, or name at the end of the range. Can accept: PrintFormBehavior, Long Integer or String. */ itemByRange(from: number | PrintFormBehavior | string, to: number | PrintFormBehavior | string): PrintFormBehavior[]; /** * Returns the last PrintFormBehavior in the collection. */ lastItem(): PrintFormBehavior; /** * Returns the middle PrintFormBehavior in the collection. */ middleItem(): PrintFormBehavior; /** * Returns the PrintFormBehavior whose index follows the specified * PrintFormBehavior in the collection. * @param obj The PrintFormBehavior whose index comes before the desired PrintFormBehavior. */ nextItem(obj: PrintFormBehavior): PrintFormBehavior; /** * Returns the PrintFormBehavior with the index previous to the specified * index. * @param obj The index of the PrintFormBehavior that follows the desired PrintFormBehavior. */ previousItem(obj: PrintFormBehavior): PrintFormBehavior; /** * Generates a string which, if executed, will return the PrintFormBehavior. */ toSource(): string; } /** * Print layer options */ declare enum PrintLayerOptions { /** * Prints all layers. */ ALL_LAYERS = 1634495564, /** * Prints all visible layers. */ VISIBLE_LAYERS = 1986622284, /** * Prints only layers that are both visible and printable. */ VISIBLE_PRINTABLE_LAYERS = 1987080780, } /** * Page orientation options. */ declare enum PrintPageOrientation { /** * Landscape. */ LANDSCAPE = 2003395685, /** * Portrait. */ PORTRAIT = 1751738216, /** * Reverse landscape. */ REVERSE_LANDSCAPE = 1869771372, /** * Reverse portrait. */ REVERSE_PORTRAIT = 1869771376, } /** * Print preferences. */ declare class PrintPreference extends Preference { /** * The current printer preset type. Can return: PrinterPresetTypes enumerator * or PrinterPreset. */ activePrinterPreset: PrinterPresetTypes | PrinterPreset; /** * If true, prints all printer marks. If false, prints specified printer marks. */ allPrinterMarks: boolean; /** * If true, uses bitmap printing. */ bitmapPrinting: boolean; /** * The resolution for bitmap printing. (Range: 72 to 1200) Note: Valid when * bitmap printing is true. * @remarks Range: 72 to 1200 */ bitmapResolution: number; /** * The angle override for black ink. (Range: 0 to 360) * @remarks Range: 0 to 360 */ blackAngle: number; /** * The frequency override for black ink. (Range: 1 to 500) * @remarks Range: 1 to 500 */ blackFrequency: number; /** * The height of the bleed area at the bottom of the page. Note: Valid only * when use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedBottom: number | string; /** * If true, forces all bleed area settings to be the same, using the most * recent bleed measurement setting. If false, allows bleed top, bleed bottom, * bleed inside, and bleed outside to have different measurements. */ bleedChain: boolean; /** * The width of the bleed area at the inside of the page. Note: Valid only when * use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedInside: number | string; /** * If true, print bleed marks. */ bleedMarks: boolean; /** * The width of the bleed area at the outside of the page. Note: Valid only * when use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedOutside: number | string; /** * The height of the bleed area at the top of the page. Note: Valid only when * use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedTop: number | string; /** * If true, collate printed copies. */ collating: boolean; /** * If true, add small squares of color representing the CMYK inks and tints of * gray in 10% increments. */ colorBars: boolean; /** * The color output mode for composites. Note: Not valid when a * device-independent PPD is specified. */ colorOutput: ColorOutputModes; /** * The screen angle to use when printing composites. (Range: 0 to 360) Note: * Valid only for PostScript or PDF files that use custom screening. * @remarks Range: 0 to 360 */ compositeAngle: number; /** * The screen frequency to use when printing composites. (Range: 1 to 500) * Note: Valid only for PostScript or PDF files that use custom screening. * @remarks Range: 1 to 500 */ compositeFrequency: number; /** * The number of copies to print. Note: Not valid when printer is PostScript * File. */ copies: number; /** * The color-rendering dictionary (CRD), specified as a CRD name or an * enumeration value. Note: Valid only when use color management is true. Can * return: ColorRenderingDictionary enumerator or String. */ crd: ColorRenderingDictionary | string; /** * Prints crop marks that define where the page should be trimmed. */ cropMarks: boolean; /** * The angle override for cyan ink. (Range: 0 to 360) * @remarks Range: 0 to 360 */ cyanAngle: number; /** * The frequency override for cyan ink. (Range: 1 to 500) * @remarks Range: 1 to 500 */ cyanFrequency: number; /** * The format in which to send image data to the printer. */ dataFormat: DataFormat; /** * If true, downloads all fonts listed in the selected PPD. Valid only when * font downloading is complete or subset. */ downloadPPDFonts: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The name of the transparency flattener preset. */ flattenerPresetName: string; /** * The direction in which to flip the printed image. */ flip: Flip; /** * Controls how fonts are downloaded to the printer. */ fontDownloading: FontDownloading; /** * If true, ignores flattener spread overrides. */ ignoreSpreadOverrides: boolean; /** * If true, includes the slug area in the printed document. */ includeSlugToPrint: boolean; /** * The rendering intent. Note: Valid only when use color management is true. */ intent: RenderingIntent; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The angle override for magenta ink. (Range: 0 to 360) * @remarks Range: 0 to 360 */ magentaAngle: number; /** * The frequency override for magenta ink. (Range: 1 to 500) * @remarks Range: 1 to 500 */ magentaFrequency: number; /** * The stroke weight (in points) for printer marks. */ markLineWeight: MarkLineWeight; /** * The distance to offset the page marks from the edge of the page. * @remarks Measurement unit — also accepts a string such as "12mm". */ markOffset: number | string; /** * The type of printer marks, either an enum value or the name of a custom * marks file. Can return: MarkTypes enumerator or String. */ markType: MarkTypes | string; /** * If true, prints the document as a negative. */ negative: boolean; /** * If true, replaces bitmap images with OPI links. */ omitBitmaps: boolean; /** * If true, replaces EPS images with OPI links. */ omitEPS: boolean; /** * If true, replaces PDF images with OPI links. */ omitPDF: boolean; /** * If true, prints graphics that are either OPI comments stored in imported EPS * files or linked using OPI comments. For information on linking files using * OPI comments, see omit EPS, omit PDF, or omit bitmaps. */ opiImageReplacement: boolean; /** * If true, prints the filename, page number, current date and time, and color * separation name. */ pageInformationMarks: boolean; /** * The position of the page on the printing medium. Note: Valid only when tile * is false. */ pagePosition: PagePositions; /** * The pages to print, specified either as an enumeration or a string. To * specify a range, separate page numbers in the string with a hyphen (-). To * specify separate pages, separate page numbers in the string with a comma * (,). Can return: PageRange enumerator or String. */ pageRange: PageRange | string; /** * The space between document pages on the printing medium. * @remarks Measurement unit — also accepts a string such as "12mm". */ paperGap: number | string; /** * The paper height. Note: Valid only when paper size is custom or scale mode * is scale width height. Can return: PaperSize enumerator or Unit. */ paperHeight: PaperSize | number; /** * The amount of space to offset the page from the left edge of the imageable * area. * @remarks Measurement unit — also accepts a string such as "12mm". */ paperOffset: number | string; /** * The paper size, specified as either a string or an enumeration. For * information on paper size names, see paper size list. Can return: PaperSizes * enumerator or String. */ paperSize: PaperSizes | string; /** * A list of the available paper sizes. */ readonly paperSizeList: string[]; /** * If true, uses transverse orientation. */ paperTransverse: boolean; /** * The paper width. Note: Valid only when paper size is custom or scale mode is * scale width height. Can return: PaperSize enumerator or Unit. */ paperWidth: PaperSize | number; /** * The parent of the PrintPreference (a Book or Document). */ readonly parent: Book | Document; /** * If true, doing pdf passthrough. */ readonly pdfPassthrough: boolean; /** * The PostScript level of the printer. */ postscriptLevel: PostScriptLevels; /** * The PPD, specified as a PPD name or an enumeration. Can return: PPDValues * enumerator or String. */ ppd: PPDValues | string; /** * Available PPDs. */ readonly ppdList: string[]; /** * If true, preserves uncalibrated color numbers. */ preserveColorNumbers: boolean; /** * If true, prints the black ink. Note: Valid only when trapping is off. */ printBlack: boolean; /** * If true, prints blank pages. Note: Valid only when trapping is off. */ printBlankPages: boolean; /** * If true, prints the cyan ink. Note: Valid only when trapping is off. */ printCyan: boolean; /** * The PostScript file to print to. Note: Valid only when the current printer * is defined as postscript file. */ printFile: File; /** * If true, prints visible guides and baseline grids. Note: Valid only when * trapping is off. */ printGuidesGrids: boolean; /** * The layers to print. */ printLayers: PrintLayerOptions; /** * If true, prints the magenta ink. Note: Valid only when trapping is off. */ printMagenta: boolean; /** * If true, prints master pages. */ printMasterPages: boolean; /** * If true, prints non-printing objects. Note: Valid only when trapping is off. */ printNonprinting: boolean; /** * The orientation of the printed page. */ printPageOrientation: PrintPageOrientation; /** * If true, prints each spread with all spread pages on a single sheet. If * false, prints spread pages as separate pages. */ printSpreads: boolean; /** * If true, prints the yellow ink. Note: Valid only when trapping is off. */ printYellow: boolean; /** * The current printer. Can return: Printer enumerator or String. */ printer: Printer | string; /** * Available printers. */ readonly printerList: string[]; /** * The color profile. Can return: Profile enumerator or String. */ profile: Profile | string; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, prints small targets outside the page area for aligning color * separations. */ registrationMarks: boolean; /** * If true, prints pages in reverse order. */ reverseOrder: boolean; /** * The amount (as a percentage) that the page height is scaled during printing. * (Range: 0 to 1000) Note: Valid only when scale mode is scale width height. * @remarks Range: 0 to 1000 */ scaleHeight: number; /** * The policy for scaling the page. Note: Valid only when printing from Layout * view. */ scaleMode: ScaleModes; /** * If true, constrains the proportions of the scaling; uses the most recent * value for either scale width or scale height to define both values. Note: * Valid only when scale mode is scale width height. */ scaleProportional: boolean; /** * The amount (as a percentage) that the page width is scaled during printing. * (Range: 0 to 1000) Note: Valid only when scale mode is scale width height. * @remarks Range: 0 to 1000 */ scaleWidth: number; /** * The ink screening settings for composite gray output in PostScript or PDF * format. . Can return: Screeening enumerator or String. */ screening: Screeening | string; /** * Lists the ink screenings available in the PPD. Note: Valid only when color * output is separations or in rip separations. */ readonly screeningList: string[]; /** * The image data sent to the printer or file. */ sendImageData: ImageDataTypes; /** * The sequence of pages to print. */ sequence: Sequences; /** * If true, simulates the effects of overprinting spot inks with different * neutral density values by converting spot colors to process colors for * printing. Note: Not valid when the color output mode is defined to leave * color profiles unchanged. */ simulateOverprint: boolean; /** * The source of the color management system. Note: Valid only when use color * management is true. */ sourceSpace: SourceSpaces; /** * If true, prints all text as black unless text has the color None or Paper or * a color value that equals white. If false, prints colored text, such as blue * hyperlinks, in halftone patterns. Note: Valid only when trapping is off. */ textAsBlack: boolean; /** * If true, prints thumbnails. Note: Valid only when trapping is off and tile * is false. */ thumbnails: boolean; /** * The number of thumbnails per page. */ thumbnailsPerPage: ThumbsPerPage; /** * If true, tiles pages. */ tile: boolean; /** * The amount of tiling overlap. Note: Valid only when tiling is true and * tiling type is not manual. */ tilingOverlap: number; /** * The tiling type. Note: Valid only when tiling is true. */ tilingType: TilingTypes; /** * The type of trapping. */ trapping: Trapping; /** * If true, uses the bleed area set for the document. */ useDocumentBleedToPrint: boolean; /** * The angle override for yellow ink. (Range: 0 to 360) * @remarks Range: 0 to 360 */ yellowAngle: number; /** * The frequency override for yellow ink. (Range: 1 to 500) * @remarks Range: 1 to 500 */ yellowFrequency: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PrintPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the PrintPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Printer options. */ declare enum Printer { /** * Prints to a PostScript file. */ POSTSCRIPT_FILE = 1886611052, } /** * A preset that contains all of the print settings. */ declare class PrinterPreset { /** * If true, prints all printer marks. If false, prints specified printer marks. */ allPrinterMarks: boolean; /** * If true, uses bitmap printing. */ bitmapPrinting: boolean; /** * The resolution for bitmap printing. (Range: 72 to 1200) Note: Valid when * bitmap printing is true. * @remarks Range: 72 to 1200 */ bitmapResolution: number; /** * The angle override for black ink. (Range: 0 to 360) * @remarks Range: 0 to 360 */ blackAngle: number; /** * The frequency override for black ink. (Range: 1 to 500) * @remarks Range: 1 to 500 */ blackFrequency: number; /** * The height of the bleed area at the bottom of the page. Note: Valid only * when use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedBottom: number | string; /** * If true, forces all bleed area settings to be the same, using the most * recent bleed measurement setting. If false, allows bleed top, bleed bottom, * bleed inside, and bleed outside to have different measurements. */ bleedChain: boolean; /** * The width of the bleed area at the inside of the page. Note: Valid only when * use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedInside: number | string; /** * If true, print bleed marks. */ bleedMarks: boolean; /** * The width of the bleed area at the outside of the page. Note: Valid only * when use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedOutside: number | string; /** * The height of the bleed area at the top of the page. Note: Valid only when * use document bleed to print is true. * @remarks Measurement unit — also accepts a string such as "12mm". */ bleedTop: number | string; /** * If true, collate printed copies. */ collating: boolean; /** * If true, add small squares of color representing the CMYK inks and tints of * gray in 10% increments. */ colorBars: boolean; /** * The color output mode for composites. Note: Not valid when a * device-independent PPD is specified. */ colorOutput: ColorOutputModes; /** * The screen angle to use when printing composites. (Range: 0 to 360) Note: * Valid only for PostScript or PDF files that use custom screening. * @remarks Range: 0 to 360 */ compositeAngle: number; /** * The screen frequency to use when printing composites. (Range: 1 to 500) * Note: Valid only for PostScript or PDF files that use custom screening. * @remarks Range: 1 to 500 */ compositeFrequency: number; /** * The number of copies to print. Note: Not valid when printer is PostScript * File. */ copies: number; /** * The color-rendering dictionary (CRD), specified as a CRD name or an * enumeration value. Note: Valid only when use color management is true. Can * return: ColorRenderingDictionary enumerator or String. */ crd: ColorRenderingDictionary | string; /** * Prints crop marks that define where the page should be trimmed. */ cropMarks: boolean; /** * The angle override for cyan ink. (Range: 0 to 360) * @remarks Range: 0 to 360 */ cyanAngle: number; /** * The frequency override for cyan ink. (Range: 1 to 500) * @remarks Range: 1 to 500 */ cyanFrequency: number; /** * The format in which to send image data to the printer. */ dataFormat: DataFormat; /** * If true, downloads all fonts listed in the selected PPD. Valid only when * font downloading is complete or subset. */ downloadPPDFonts: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The name of the transparency flattener preset. */ flattenerPresetName: string; /** * The direction in which to flip the printed image. */ flip: Flip; /** * Controls how fonts are downloaded to the printer. */ fontDownloading: FontDownloading; /** * If true, ignores flattener spread overrides. */ ignoreSpreadOverrides: boolean; /** * If true, includes the slug area in the printed document. */ includeSlugToPrint: boolean; /** * The index of the PrinterPreset within its containing object. */ readonly index: number; /** * The rendering intent. Note: Valid only when use color management is true. */ intent: RenderingIntent; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The angle override for magenta ink. (Range: 0 to 360) * @remarks Range: 0 to 360 */ magentaAngle: number; /** * The frequency override for magenta ink. (Range: 1 to 500) * @remarks Range: 1 to 500 */ magentaFrequency: number; /** * The stroke weight (in points) for printer marks. */ markLineWeight: MarkLineWeight; /** * The distance to offset the page marks from the edge of the page. * @remarks Measurement unit — also accepts a string such as "12mm". */ markOffset: number | string; /** * The type of printer marks, either an enum value or the name of a custom * marks file. Can return: MarkTypes enumerator or String. */ markType: MarkTypes | string; /** * The name of the PrinterPreset. */ name: string; /** * If true, prints the document as a negative. */ negative: boolean; /** * If true, replaces bitmap images with OPI links. */ omitBitmaps: boolean; /** * If true, replaces EPS images with OPI links. */ omitEPS: boolean; /** * If true, replaces PDF images with OPI links. */ omitPDF: boolean; /** * If true, prints graphics that are either OPI comments stored in imported EPS * files or linked using OPI comments. For information on linking files using * OPI comments, see omit EPS, omit PDF, or omit bitmaps. */ opiImageReplacement: boolean; /** * If true, prints the filename, page number, current date and time, and color * separation name. */ pageInformationMarks: boolean; /** * The position of the page on the printing medium. Note: Valid only when tile * is false. */ pagePosition: PagePositions; /** * The space between document pages on the printing medium. * @remarks Measurement unit — also accepts a string such as "12mm". */ paperGap: number | string; /** * The paper height. Note: Valid only when paper size is custom or scale mode * is scale width height. Can return: PaperSize enumerator or Unit. */ paperHeight: PaperSize | number; /** * The amount of space to offset the page from the left edge of the imageable * area. * @remarks Measurement unit — also accepts a string such as "12mm". */ paperOffset: number | string; /** * The paper size, specified as either a string or an enumeration. For * information on paper size names, see paper size list. Can return: PaperSizes * enumerator or String. */ paperSize: PaperSizes | string; /** * A list of the available paper sizes. */ readonly paperSizeList: string[]; /** * If true, uses transverse orientation. */ paperTransverse: boolean; /** * The paper width. Note: Valid only when paper size is custom or scale mode is * scale width height. Can return: PaperSize enumerator or Unit. */ paperWidth: PaperSize | number; /** * The parent of the PrinterPreset (a Application). */ readonly parent: Application; /** * The PostScript level of the printer. */ postscriptLevel: PostScriptLevels; /** * The PPD, specified as a PPD name or an enumeration. Can return: PPDValues * enumerator or String. */ ppd: PPDValues | string; /** * Available PPDs. */ readonly ppdList: string[]; /** * If true, prints the black ink. Note: Valid only when trapping is off. */ printBlack: boolean; /** * If true, prints blank pages. Note: Valid only when trapping is off. */ printBlankPages: boolean; /** * If true, prints the cyan ink. Note: Valid only when trapping is off. */ printCyan: boolean; /** * The PostScript file to print to. Note: Valid only when the current printer * is defined as postscript file. */ printFile: File; /** * If true, prints visible guides and baseline grids. Note: Valid only when * trapping is off. */ printGuidesGrids: boolean; /** * The layers to print. */ printLayers: PrintLayerOptions; /** * If true, prints the magenta ink. Note: Valid only when trapping is off. */ printMagenta: boolean; /** * If true, prints master pages. */ printMasterPages: boolean; /** * If true, prints non-printing objects. Note: Valid only when trapping is off. */ printNonprinting: boolean; /** * The orientation of the printed page. */ printPageOrientation: PrintPageOrientation; /** * If true, prints each spread with all spread pages on a single sheet. If * false, prints spread pages as separate pages. */ printSpreads: boolean; /** * If true, prints the yellow ink. Note: Valid only when trapping is off. */ printYellow: boolean; /** * The current printer. Can return: Printer enumerator or String. */ printer: Printer | string; /** * Available printers. */ readonly printerList: string[]; /** * The color profile. Can return: Profile enumerator or String. */ profile: Profile | string; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, prints small targets outside the page area for aligning color * separations. */ registrationMarks: boolean; /** * If true, prints pages in reverse order. */ reverseOrder: boolean; /** * The amount (as a percentage) that the page height is scaled during printing. * (Range: 0 to 1000) Note: Valid only when scale mode is scale width height. * @remarks Range: 0 to 1000 */ scaleHeight: number; /** * The policy for scaling the page. Note: Valid only when printing from Layout * view. */ scaleMode: ScaleModes; /** * If true, constrains the proportions of the scaling; uses the most recent * value for either scale width or scale height to define both values. Note: * Valid only when scale mode is scale width height. */ scaleProportional: boolean; /** * The amount (as a percentage) that the page width is scaled during printing. * (Range: 0 to 1000) Note: Valid only when scale mode is scale width height. * @remarks Range: 0 to 1000 */ scaleWidth: number; /** * The ink screening settings for composite gray output in PostScript or PDF * format. . Can return: Screeening enumerator or String. */ screening: Screeening | string; /** * Lists the ink screenings available in the PPD. Note: Valid only when color * output is separations or in rip separations. */ readonly screeningList: string[]; /** * The image data sent to the printer or file. */ sendImageData: ImageDataTypes; /** * The sequence of pages to print. */ sequence: Sequences; /** * If true, simulates the effects of overprinting spot inks with different * neutral density values by converting spot colors to process colors for * printing. Note: Not valid when the color output mode is defined to leave * color profiles unchanged. */ simulateOverprint: boolean; /** * The source of the color management system. Note: Valid only when use color * management is true. */ sourceSpace: SourceSpaces; /** * If true, prints all text as black unless text has the color None or Paper or * a color value that equals white. If false, prints colored text, such as blue * hyperlinks, in halftone patterns. Note: Valid only when trapping is off. */ textAsBlack: boolean; /** * If true, prints thumbnails. Note: Valid only when trapping is off and tile * is false. */ thumbnails: boolean; /** * The number of thumbnails per page. */ thumbnailsPerPage: ThumbsPerPage; /** * If true, tiles pages. */ tile: boolean; /** * The amount of tiling overlap. Note: Valid only when tiling is true and * tiling type is not manual. */ tilingOverlap: number; /** * The tiling type. Note: Valid only when tiling is true. */ tilingType: TilingTypes; /** * The type of trapping. */ trapping: Trapping; /** * If true, uses the bleed area set for the document. */ useDocumentBleedToPrint: boolean; /** * The angle override for yellow ink. (Range: 0 to 360) * @remarks Range: 0 to 360 */ yellowAngle: number; /** * The frequency override for yellow ink. (Range: 1 to 500) * @remarks Range: 1 to 500 */ yellowFrequency: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the PrinterPreset. */ duplicate(): PrinterPreset; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PrinterPreset[]; /** * Deletes the PrinterPreset. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the PrinterPreset. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Printer preset options. */ declare enum PrinterPresetTypes { /** * A custom printer preset. */ CUSTOM = 1131639917, /** * The default printer preset. */ DEFAULT_VALUE = 1147563124, } /** * A collection of printer presets. */ declare class PrinterPresets { /** Returns the PrinterPreset with the specified index or name. */ [index: number]: PrinterPreset; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new PrinterPreset. * @param withProperties Initial values for properties of the new PrinterPreset (Optional) */ add(withProperties?: Object): PrinterPreset; /** * Returns any PrinterPreset in the collection. */ anyItem(): PrinterPreset; /** * Displays the number of elements in the PrinterPreset. */ count(): number; /** * Returns every PrinterPreset in the collection. */ everyItem(): PrinterPreset; /** * Returns the first PrinterPreset in the collection. */ firstItem(): PrinterPreset; /** * Returns the PrinterPreset with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): PrinterPreset; /** * Returns the PrinterPreset with the specified name. * @param name The name. */ itemByName(name: string): PrinterPreset; /** * Returns the PrinterPresets within the specified range. * @param from The PrinterPreset, index, or name at the beginning of the range. Can accept: PrinterPreset, Long Integer or String. * @param to The PrinterPreset, index, or name at the end of the range. Can accept: PrinterPreset, Long Integer or String. */ itemByRange(from: number | PrinterPreset | string, to: number | PrinterPreset | string): PrinterPreset[]; /** * Returns the last PrinterPreset in the collection. */ lastItem(): PrinterPreset; /** * Returns the middle PrinterPreset in the collection. */ middleItem(): PrinterPreset; /** * Returns the PrinterPreset whose index follows the specified PrinterPreset in * the collection. * @param obj The PrinterPreset whose index comes before the desired PrinterPreset. */ nextItem(obj: PrinterPreset): PrinterPreset; /** * Returns the PrinterPreset with the index previous to the specified index. * @param obj The index of the PrinterPreset that follows the desired PrinterPreset. */ previousItem(obj: PrinterPreset): PrinterPreset; /** * Generates a string which, if executed, will return the PrinterPreset. */ toSource(): string; } /** * Color profile options. */ declare enum Profile { /** * No CMS profile is used. */ NO_CMS = 1970499183, /** * Uses the PostScript CMS profile. */ POSTSCRIPT_CMS = 1970303843, /** * Uses the document profile. */ USE_DOCUMENT = 1967419235, /** * Uses the working profile. */ WORKING = 1466921579, } /** * Options for proofing colors. */ declare enum ProofingType { /** * Allows creation of a custom proofing setup for a specific output condition. */ CUSTOM = 1131639917, /** * Creates a soft proof of colors using the document's CMYK profile. */ DOCUMENT_CMYK = 1347708003, /** * Turns off soft proof display. */ PROOF_OFF = 1347710822, /** * Creates a soft proof of colors using the current CMYK working space. */ WORKING_CMYK = 1347712867, } /** * publish export option for cover image. */ declare enum PublishCoverEnum { /** * Rasterize chosen page as cover image. */ CHOSEN_PAGE = 1701013072, /** * Use external image as cover image. */ EXTERNAL_IMAGE = 1700952169, /** * Rasterize first page as cover image. */ FIRST_PAGE = 1700947536, } /** * Publish export preferences. */ declare class PublishExportPreference extends Preference { /** * The epub cover image file path. */ coverImageFile: string; /** * The cover page. */ coverPage: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The color palette for GIF conversion. Note: Not valid when image conversion * is JPEG. */ gifOptionsPalette: GIFOptionsPalette; /** * The file format to use for converted images. Note: Valid only when copy * optimized images and/or copy formatted images is true. */ imageConversion: ImageConversion; /** * The export resolution */ imageExportResolution: ImageResolution; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The quality of converted JPEG images. Note: Not valid when image conversion * is GIF. */ jpegOptionsQuality: JPEGOptionsQuality; /** * The parent of the PublishExportPreference (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The publish cover option. */ publishCover: PublishCoverEnum; /** * The publish description. */ publishDescription: string; /** * The file name. */ publishFileName: string; /** * the publish format. */ publishFormat: PublishFormatEnum; /** * The publish page range. */ publishPageRange: string; /** * The publish page range format. */ publishPageRangeFormat: PageRangeFormat; /** * If PDF should be uploaded while publishing. */ publishPdf: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): PublishExportPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * PublishExportPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Choices for publish format. */ declare enum PublishFormatEnum { /** * publish by pages. */ PUBLISH_BY_PAGES = 1700950134, /** * publish by spread. */ PUBLISH_BY_SPREAD = 1700950902, } /** * A qualified XML name, containing the URI and the local name. */ declare class QName { /** * The local name part of the qualified name. */ readonly localName: string; /** * The URI part of the qualified name. */ readonly uri: string; /** * Creates a QName object. * @param uri The URI, specified as a Namespace object, an existing QName object, or string. * @param name The local name. Used only if URI is given as a string. */ constructor(uri: any, name?: string); } /** * A radio button. */ declare class RadioButton extends FormField { /** * Indicates whether the RadioButton has been flipped independently of its * parent object and, if yes, the direction in which the RadioButton was * flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the RadioButton relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the RadioButton relative to its containing object. * (Range: -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the RadioButton relative to its containing object. * (Range: -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the RadioButton relative to its containing object. */ absoluteVerticalScale: number; /** * The index of the active state in the object's states collection. */ activeStateIndex: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the RadioButton. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the RadioButton. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * Anchored object settings. */ readonly anchoredObjectSettings: AnchoredObjectSetting; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the RadioButton. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the RadioButton. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the RadioButton. */ readonly associatedXMLElement: XMLItem; /** * A collection of behavior objects. */ readonly behaviors: Behaviors; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * If true, the check box/radio button is selected by default in the exported * PDF. */ checkedByDefault: boolean; /** * A collection of clear form behavior objects. */ readonly clearFormBehaviors: ClearFormBehaviors; /** * Transparency settings for the content of the RadioButton. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The description of the RadioButton. */ description: string; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the RadioButton. */ endJoin: EndJoin; /** * A collection of EPS files. */ readonly epss: EPSs; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Export value for the check box/radio button in the exported PDF. */ exportValue: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * RadioButton. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the RadioButton's fill color. (To specify a * tint percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the RadioButton. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the RadioButton excluding the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * A collection of goto anchor behavior objects. */ readonly gotoAnchorBehaviors: GotoAnchorBehaviors; /** * A collection of goto first page behavior objects. */ readonly gotoFirstPageBehaviors: GotoFirstPageBehaviors; /** * A collection of goto last page behavior objects. */ readonly gotoLastPageBehaviors: GotoLastPageBehaviors; /** * A collection of goto next page behavior objects. */ readonly gotoNextPageBehaviors: GotoNextPageBehaviors; /** * A collection of goto next view behavior objects. */ readonly gotoNextViewBehaviors: GotoNextViewBehaviors; /** * A collection of goto previous page behavior objects. */ readonly gotoPreviousPageBehaviors: GotoPreviousPageBehaviors; /** * A collection of goto previous view behavior objects. */ readonly gotoPreviousViewBehaviors: GotoPreviousViewBehaviors; /** * A collection of goto URL behavior objects. */ readonly gotoURLBehaviors: GotoURLBehaviors; /** * The angle of a linear gradient applied to the fill of the RadioButton. * (Range: -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the RadioButton. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the RadioButton, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the RadioButton. * (Range: -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the RadioButton. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the RadioButton, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * A collection of groups. */ readonly groups: Groups; /** * If true, the form field/push button is hidden until triggered in the * exported PDF. */ hiddenUntilTriggered: boolean; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the RadioButton. */ horizontalScale: number; /** * The unique ID of the RadioButton. */ readonly id: number; /** * A collection of bitmap images in any bitmap file format (including TIFF, * JPEG, or GIF). */ readonly images: Images; /** * The index of the RadioButton within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the RadioButton is on. */ itemLayer: Layer; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the RadioButton. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the RadioButton is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * A collection of movie behavior objects. */ readonly movieBehaviors: MovieBehaviors; /** * The name of the RadioButton. */ name: string; /** * If true, the RadioButton does not print. */ nonprinting: boolean; /** * A collection of open file behavior objects. */ readonly openFileBehaviors: OpenFileBehaviors; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the RadioButton's fill color overprints any underlying objects. If * false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the RadioButton's stroke color overprints any underlying objects. * If false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the RadioButton (a Snippet, PlaceGun, FlexObject, Character, * Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval or * Group). */ readonly parent: Character | FlexObject | GraphicLine | MasterSpread | Oval | PlaceGun | Polygon | Rectangle | SplineItem | Spread | Group | Snippet; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of PDF files. */ readonly pdfs: PDFs; /** * A collection of PICT graphics. */ readonly picts: PICTs; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A collection of print form behavior objects. */ readonly printFormBehaviors: PrintFormBehaviors; /** * If true, the form field/push button is printable in the exported PDF. */ printableInPdf: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, the form field is read only in the exported PDF. */ readOnly: boolean; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * If true, the form field is required in the exported PDF. */ required: boolean; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the RadioButton. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the RadioButton. (Range: -360 to 360) */ shearAngle: number; /** * A collection of show/hide fields behavior objects. */ readonly showHideFieldsBehaviors: ShowHideFieldsBehaviors; /** * A collection of sound behavior objects. */ readonly soundBehaviors: SoundBehaviors; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * A collection of states. */ readonly states: States; /** * The stroke alignment applied to the RadioButton. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the RadioButton. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the RadioButton. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the RadioButton's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of submit form behavior objects. */ readonly submitFormBehaviors: SubmitFormBehaviors; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the RadioButton. */ verticalScale: number; /** * A collection of view zoom behavior objects. */ readonly viewZoomBehaviors: ViewZoomBehaviors; /** * If true, the RadioButton is visible. */ visible: boolean; /** * The bounds of the RadioButton including the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * A collection of WMF graphics. */ readonly wmfs: WMFs; /** * Dispatched after a RadioButton is placed. This event bubbles. This event is * not cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a RadioButton is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the RadioButton's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the RadioButton that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Brings the RadioButton forward one level in its layer. */ bringForward(): void; /** * Brings the RadioButton to the front of its layer or in front of a particular * item. * @param reference The reference object to bring the object in front of (must have same parent) (Optional) */ bringToFront(reference?: PageItem): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the RadioButton. Transformations include * rotation, scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the RadioButton to a different shape. * @param given The RadioButton's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Converts the button object to the page item currently in the active state. * Page items from other states will be lost. */ convertToObject(): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new RadioButton. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new RadioButton. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new RadioButton. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new RadioButton. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new RadioButton. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the RadioButton at the specified location or offset. * @param to The location of the new RadioButton, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new RadioButton from the original RadioButton's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the RadioButton. * @param given The axis around which to flip the RadioButton. * @param around The point around which to flip the RadioButton. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): RadioButton[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the RadioButton to a new location. Note: Either the 'to' or 'by' * parameter is required; if both parameters are defined, only the to value is * used. * @param to The new location of the RadioButton,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the RadioButton relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the RadioButton. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the RadioButton in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Sends the RadioButton back one level in its layer. */ sendBackward(): void; /** * Sends the RadioButton to the back of its layer or behind a particular item * (must have same parent). * @param reference The reference object to send the object behind (Optional) */ sendToBack(reference?: PageItem): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new RadioButton (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the RadioButton. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the RadioButton using the last transformation performed on any * object. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgain(): string[]; /** * Transforms the RadioButton using the last transformation performed on any * RadioButton. Transformations include moving, rotating, shearing, scaling, * and flipping. */ transformAgainIndividually(): string[]; /** * Transforms the RadioButton using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the RadioButton using the last sequence of transformations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * A collection of radio buttons. */ declare class RadioButtons { /** Returns the RadioButton with the specified index or name. */ [index: number]: RadioButton; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new RadioButton * @param layer The layer on which to create the RadioButton. (Optional) * @param at The location at which to insert the RadioButton relative to the reference object or within the container object. (Optional) * @param reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) * @param withProperties Initial values for properties of the new RadioButton (Optional) */ add(layer?: Layer, at?: LocationOptions, reference?: Document | Layer | MasterSpread | Page | Spread | PageItem, withProperties?: Object): RadioButton; /** * Returns any RadioButton in the collection. */ anyItem(): RadioButton; /** * Displays the number of elements in the RadioButton. */ count(): number; /** * Returns every RadioButton in the collection. */ everyItem(): RadioButton; /** * Returns the first RadioButton in the collection. */ firstItem(): RadioButton; /** * Returns the RadioButton with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): RadioButton; /** * Returns the RadioButton with the specified ID. * @param id The ID. */ itemByID(id: number): RadioButton; /** * Returns the RadioButton with the specified name. * @param name The name. */ itemByName(name: string): RadioButton; /** * Returns the RadioButtons within the specified range. * @param from The RadioButton, index, or name at the beginning of the range. Can accept: RadioButton, Long Integer or String. * @param to The RadioButton, index, or name at the end of the range. Can accept: RadioButton, Long Integer or String. */ itemByRange(from: number | RadioButton | string, to: number | RadioButton | string): RadioButton[]; /** * Returns the last RadioButton in the collection. */ lastItem(): RadioButton; /** * Returns the middle RadioButton in the collection. */ middleItem(): RadioButton; /** * Returns the RadioButton whose index follows the specified RadioButton in the * collection. * @param obj The RadioButton whose index comes before the desired RadioButton. */ nextItem(obj: RadioButton): RadioButton; /** * Returns the RadioButton with the index previous to the specified index. * @param obj The index of the RadioButton that follows the desired RadioButton. */ previousItem(obj: RadioButton): RadioButton; /** * Generates a string which, if executed, will return the RadioButton. */ toSource(): string; } /** * An individual radiobutton control in a radiobutton group. */ declare class RadiobuttonControl extends Widget { /** * If true, the control is checked by default in the dialog. */ checkedState: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the RadiobuttonControl. */ readonly id: number; /** * The index of the RadiobuttonControl within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The width of the control. For an editbox or combobox, specifies the minimum * width of the box. */ minWidth: number; /** * The parent of the RadiobuttonControl (a RadiobuttonGroup). */ readonly parent: RadiobuttonGroup; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Text that appears in the RadiobuttonControl. */ staticLabel: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): RadiobuttonControl[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the RadiobuttonControl. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of individual radiobutton controls. */ declare class RadiobuttonControls { /** Returns the RadiobuttonControl with the specified index or name. */ [index: number]: RadiobuttonControl; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new RadiobuttonControl. * @param withProperties Initial values for properties of the new RadiobuttonControl (Optional) */ add(withProperties?: Object): RadiobuttonControl; /** * Returns any RadiobuttonControl in the collection. */ anyItem(): RadiobuttonControl; /** * Displays the number of elements in the RadiobuttonControl. */ count(): number; /** * Returns every RadiobuttonControl in the collection. */ everyItem(): RadiobuttonControl; /** * Returns the first RadiobuttonControl in the collection. */ firstItem(): RadiobuttonControl; /** * Returns the RadiobuttonControl with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): RadiobuttonControl; /** * Returns the RadiobuttonControl with the specified ID. * @param id The ID. */ itemByID(id: number): RadiobuttonControl; /** * Returns the RadiobuttonControls within the specified range. * @param from The RadiobuttonControl, index, or name at the beginning of the range. Can accept: RadiobuttonControl, Long Integer or String. * @param to The RadiobuttonControl, index, or name at the end of the range. Can accept: RadiobuttonControl, Long Integer or String. */ itemByRange(from: number | RadiobuttonControl | string, to: number | RadiobuttonControl | string): RadiobuttonControl[]; /** * Returns the last RadiobuttonControl in the collection. */ lastItem(): RadiobuttonControl; /** * Returns the middle RadiobuttonControl in the collection. */ middleItem(): RadiobuttonControl; /** * Returns the RadiobuttonControl whose index follows the specified * RadiobuttonControl in the collection. * @param obj The RadiobuttonControl whose index comes before the desired RadiobuttonControl. */ nextItem(obj: RadiobuttonControl): RadiobuttonControl; /** * Returns the RadiobuttonControl with the index previous to the specified * index. * @param obj The index of the RadiobuttonControl that follows the desired RadiobuttonControl. */ previousItem(obj: RadiobuttonControl): RadiobuttonControl; /** * Generates a string which, if executed, will return the RadiobuttonControl. */ toSource(): string; } /** * A single control that contains one or more radiobutton controls. */ declare class RadiobuttonGroup extends Widget { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the RadiobuttonGroup. */ readonly id: number; /** * The index of the RadiobuttonGroup within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The width of the control. For an editbox or combobox, specifies the minimum * width of the box. */ minWidth: number; /** * The parent of the RadiobuttonGroup (a DialogColumn, DialogRow, EnablingGroup * or BorderPanel). */ readonly parent: DialogRow | EnablingGroup | BorderPanel | DialogColumn; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of individual radiobutton controls. */ readonly radiobuttonControls: RadiobuttonControls; /** * The index of the selection in a radiobutton group. */ selectedButton: number; /** * A collection of widgets. */ readonly widgets: Widgets; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): RadiobuttonGroup[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the RadiobuttonGroup. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of radiobutton groups. */ declare class RadiobuttonGroups { /** Returns the RadiobuttonGroup with the specified index or name. */ [index: number]: RadiobuttonGroup; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new RadiobuttonGroup. * @param withProperties Initial values for properties of the new RadiobuttonGroup (Optional) */ add(withProperties?: Object): RadiobuttonGroup; /** * Returns any RadiobuttonGroup in the collection. */ anyItem(): RadiobuttonGroup; /** * Displays the number of elements in the RadiobuttonGroup. */ count(): number; /** * Returns every RadiobuttonGroup in the collection. */ everyItem(): RadiobuttonGroup; /** * Returns the first RadiobuttonGroup in the collection. */ firstItem(): RadiobuttonGroup; /** * Returns the RadiobuttonGroup with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): RadiobuttonGroup; /** * Returns the RadiobuttonGroup with the specified ID. * @param id The ID. */ itemByID(id: number): RadiobuttonGroup; /** * Returns the RadiobuttonGroups within the specified range. * @param from The RadiobuttonGroup, index, or name at the beginning of the range. Can accept: RadiobuttonGroup, Long Integer or String. * @param to The RadiobuttonGroup, index, or name at the end of the range. Can accept: RadiobuttonGroup, Long Integer or String. */ itemByRange(from: number | RadiobuttonGroup | string, to: number | RadiobuttonGroup | string): RadiobuttonGroup[]; /** * Returns the last RadiobuttonGroup in the collection. */ lastItem(): RadiobuttonGroup; /** * Returns the middle RadiobuttonGroup in the collection. */ middleItem(): RadiobuttonGroup; /** * Returns the RadiobuttonGroup whose index follows the specified * RadiobuttonGroup in the collection. * @param obj The RadiobuttonGroup whose index comes before the desired RadiobuttonGroup. */ nextItem(obj: RadiobuttonGroup): RadiobuttonGroup; /** * Returns the RadiobuttonGroup with the index previous to the specified index. * @param obj The index of the RadiobuttonGroup that follows the desired RadiobuttonGroup. */ previousItem(obj: RadiobuttonGroup): RadiobuttonGroup; /** * Generates a string which, if executed, will return the RadiobuttonGroup. */ toSource(): string; } /** * Sort order for hyperlink ranges. */ declare enum RangeSortOrder { /** * Sort the ranges in ascending order. */ ASCENDING_SORT = 1634952307, /** * Sort the ranges in descending order. */ DESCENDING_SORT = 1685287796, /** * Do not sort the ranges. */ NO_SORT = 1852797812, } /** * PDF export raster resolution options. */ declare enum RasterResolutionOptions { /** * 96 pixels per inch. */ NINETY_SIX_PPI = 1853059184, /** * 144 pixels per inch. */ ONE_HUNDRED_FORTY_FOUR_PPI = 1868984432, /** * 72 pixels per inch. */ SEVENTY_TWO_PPI = 1937010800, } /** * A high-precision numeric entry control featuring both a pop-up menu and an * entry field. */ declare class RealCombobox extends Widget { /** * The default value in an editbox control. Note: Do not specify both edit * contents and edit value. If both are specified, the one that occurs later in * the script is used. */ editContents: string; /** * The real number default value of the editbox or combobox. Note: For * measurement controls, the value is interpreted in points. The points value * is converted to edit units when the dialog opens. Note: Do not specify both * edit value and edit contents. If both are specified, the one that occurs * later in the script is used. */ editValue: number; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the RealCombobox. */ readonly id: number; /** * The index of the RealCombobox within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The amount to increment/decrement the value when a user selects the control * and holds down the Shift key while pressing an arrow key on the keyboard. */ largeNudge: number; /** * The maximum value that a user is allowed to type in a numeric editbox or * combobox. Note: The value for a measurement editbox or combobox is * interpreted in points, regardless of the edit units specified for the * control. The points value is converted automatically to the edit unit when * the dialog is opened. */ maximumValue: number; /** * The width of the control. For an editbox or combobox, specifies the minimum * width of the box. */ minWidth: number; /** * The minumim value that a user is allowed to type in a numeric editbox or * combobox. Note: The value for a measurement editbox or combobox is * interpreted in points, regardless of the edit units specified for the * control. The points value is converted automatically to the edit unit when * the dialog is opened. */ minimumValue: number; /** * The parent of the RealCombobox (a DialogColumn, DialogRow, EnablingGroup or * BorderPanel). */ readonly parent: DialogRow | EnablingGroup | BorderPanel | DialogColumn; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The amount to increment/decrement the value when the user selects the * control and presses an arrow key on the keyboard. */ smallNudge: number; /** * The menu items on a dropdown or combobox control, as an array of strings. */ stringList: string[]; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): RealCombobox[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the RealCombobox. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of real number comboboxes. */ declare class RealComboboxes { /** Returns the RealCombobox with the specified index or name. */ [index: number]: RealCombobox; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new RealCombobox. * @param withProperties Initial values for properties of the new RealCombobox (Optional) */ add(withProperties?: Object): RealCombobox; /** * Returns any RealCombobox in the collection. */ anyItem(): RealCombobox; /** * Displays the number of elements in the RealCombobox. */ count(): number; /** * Returns every RealCombobox in the collection. */ everyItem(): RealCombobox; /** * Returns the first RealCombobox in the collection. */ firstItem(): RealCombobox; /** * Returns the RealCombobox with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): RealCombobox; /** * Returns the RealCombobox with the specified ID. * @param id The ID. */ itemByID(id: number): RealCombobox; /** * Returns the RealComboboxes within the specified range. * @param from The RealCombobox, index, or name at the beginning of the range. Can accept: RealCombobox, Long Integer or String. * @param to The RealCombobox, index, or name at the end of the range. Can accept: RealCombobox, Long Integer or String. */ itemByRange(from: number | RealCombobox | string, to: number | RealCombobox | string): RealCombobox[]; /** * Returns the last RealCombobox in the collection. */ lastItem(): RealCombobox; /** * Returns the middle RealCombobox in the collection. */ middleItem(): RealCombobox; /** * Returns the RealCombobox whose index follows the specified RealCombobox in * the collection. * @param obj The RealCombobox whose index comes before the desired RealCombobox. */ nextItem(obj: RealCombobox): RealCombobox; /** * Returns the RealCombobox with the index previous to the specified index. * @param obj The index of the RealCombobox that follows the desired RealCombobox. */ previousItem(obj: RealCombobox): RealCombobox; /** * Generates a string which, if executed, will return the RealCombobox. */ toSource(): string; } /** * A high-precision numeric entry field. */ declare class RealEditbox extends Widget { /** * The default value in an editbox control. Note: Do not specify both edit * contents and edit value. If both are specified, the one that occurs later in * the script is used. */ editContents: string; /** * The real number default value of the editbox or combobox. Note: For * measurement controls, the value is interpreted in points. The points value * is converted to edit units when the dialog opens. Note: Do not specify both * edit value and edit contents. If both are specified, the one that occurs * later in the script is used. */ editValue: number; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the RealEditbox. */ readonly id: number; /** * The index of the RealEditbox within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The amount to increment/decrement the value when a user selects the control * and holds down the Shift key while pressing an arrow key on the keyboard. */ largeNudge: number; /** * The maximum value that a user is allowed to type in a numeric editbox or * combobox. Note: The value for a measurement editbox or combobox is * interpreted in points, regardless of the edit units specified for the * control. The points value is converted automatically to the edit unit when * the dialog is opened. */ maximumValue: number; /** * The width of the control. For an editbox or combobox, specifies the minimum * width of the box. */ minWidth: number; /** * The minumim value that a user is allowed to type in a numeric editbox or * combobox. Note: The value for a measurement editbox or combobox is * interpreted in points, regardless of the edit units specified for the * control. The points value is converted automatically to the edit unit when * the dialog is opened. */ minimumValue: number; /** * The parent of the RealEditbox (a DialogColumn, DialogRow, EnablingGroup or * BorderPanel). */ readonly parent: DialogRow | EnablingGroup | BorderPanel | DialogColumn; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The amount to increment/decrement the value when the user selects the * control and presses an arrow key on the keyboard. */ smallNudge: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): RealEditbox[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the RealEditbox. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of real number editboxes. */ declare class RealEditboxes { /** Returns the RealEditbox with the specified index or name. */ [index: number]: RealEditbox; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new RealEditbox. * @param withProperties Initial values for properties of the new RealEditbox (Optional) */ add(withProperties?: Object): RealEditbox; /** * Returns any RealEditbox in the collection. */ anyItem(): RealEditbox; /** * Displays the number of elements in the RealEditbox. */ count(): number; /** * Returns every RealEditbox in the collection. */ everyItem(): RealEditbox; /** * Returns the first RealEditbox in the collection. */ firstItem(): RealEditbox; /** * Returns the RealEditbox with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): RealEditbox; /** * Returns the RealEditbox with the specified ID. * @param id The ID. */ itemByID(id: number): RealEditbox; /** * Returns the RealEditboxes within the specified range. * @param from The RealEditbox, index, or name at the beginning of the range. Can accept: RealEditbox, Long Integer or String. * @param to The RealEditbox, index, or name at the end of the range. Can accept: RealEditbox, Long Integer or String. */ itemByRange(from: number | RealEditbox | string, to: number | RealEditbox | string): RealEditbox[]; /** * Returns the last RealEditbox in the collection. */ lastItem(): RealEditbox; /** * Returns the middle RealEditbox in the collection. */ middleItem(): RealEditbox; /** * Returns the RealEditbox whose index follows the specified RealEditbox in the * collection. * @param obj The RealEditbox whose index comes before the desired RealEditbox. */ nextItem(obj: RealEditbox): RealEditbox; /** * Returns the RealEditbox with the index previous to the specified index. * @param obj The index of the RealEditbox that follows the desired RealEditbox. */ previousItem(obj: RealEditbox): RealEditbox; /** * Generates a string which, if executed, will return the RealEditbox. */ toSource(): string; } /** * The records to merge. */ declare enum RecordSelection { /** * Merges all records. */ ALL_RECORDS = 1684881778, /** * Merges the specified record. */ ONE_RECORD = 1684885362, /** * Merges all records in the specified range. */ RANGE = 1684886130, } /** * The number of records per page. */ declare enum RecordsPerPage { /** * Places as many records as fit on a page. */ MULTIPLE_RECORD = 1684884850, /** * Places each record on a new page. */ SINGLE_RECORD = 1684886386, } /** * A rectangle. */ declare class Rectangle extends SplineItem { /** * Indicates whether the Rectangle has been flipped independently of its parent * object and, if yes, the direction in which the Rectangle was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the Rectangle relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the Rectangle relative to its containing object. * (Range: -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the Rectangle relative to its containing object. * (Range: -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the Rectangle relative to its containing object. */ absoluteVerticalScale: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the Rectangle. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the Rectangle. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * Anchored object settings. */ readonly anchoredObjectSettings: AnchoredObjectSetting; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the Rectangle. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the Rectangle. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the Rectangle. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * A collection of buttons. */ readonly buttons: Buttons; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * Transparency settings for the content of the Rectangle. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The type of content that a frame can contain. */ contentType: ContentType; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the Rectangle. */ endJoin: EndJoin; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * A collection of EPS files. */ readonly epss: EPSs; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * Rectangle. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the Rectangle's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the Rectangle. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * A collection of form fields. */ readonly formFields: FormFields; /** * The frame fitting option to apply to placed or pasted content. Can be * applied to a frame, object style, or document or to the application. */ readonly frameFittingOptions: FrameFittingOption; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the Rectangle excluding the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the Rectangle. (Range: * -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the Rectangle. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the Rectangle, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the Rectangle. * (Range: -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the Rectangle. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the Rectangle, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * A collection of groups. */ readonly groups: Groups; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the Rectangle. */ horizontalScale: number; /** * A collection of embedded HTML page items. */ readonly htmlItems: HtmlItems; /** * The unique ID of the Rectangle. */ readonly id: number; /** * A collection of bitmap images in any bitmap file format (including TIFF, * JPEG, or GIF). */ readonly images: Images; /** * Imported InDesign pages. */ readonly importedPages: ImportedPages; /** * Export options for InCopy INCX document format. */ readonly incopyExportOptions: InCopyExportOption; /** * The index of the Rectangle within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the Rectangle is on. */ itemLayer: Layer; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * Display performance options for the Rectangle. */ localDisplaySetting: DisplaySettingOptions; /** * The lock state. */ readonly lockState: LockStateValues; /** * If true, the Rectangle is locked. */ locked: boolean; /** * A collection of math objects. */ readonly mathObjects: MathObjects; /** * The media items collection. */ readonly mediaItems: MediaItems; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * A collection of movies. */ readonly movies: Movies; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * The name of the Rectangle. */ name: string; /** * If true, the Rectangle does not print. */ nonprinting: boolean; /** * Export options for the object */ readonly objectExportOptions: ObjectExportOption; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the Rectangle's fill color overprints any underlying objects. If * false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the Rectangle's stroke color overprints any underlying objects. If * false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the Rectangle (a Snippet, ComboBox, ListBox, TextBox, * SignatureField, Spread, MasterSpread, SplineItem, Polygon, GraphicLine, * Rectangle, Oval, Group, State, Cell, Character, PlaceGun or FlexObject). */ readonly parent: Cell | Character | ComboBox | GraphicLine | Group | ListBox | MasterSpread | Oval | PlaceGun | Polygon | Rectangle | SignatureField | SplineItem | Spread | State | TextBox | FlexObject | Snippet; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of paths. */ readonly paths: Paths; /** * A collection of PDF files. */ readonly pdfs: PDFs; /** * A collection of PICT graphics. */ readonly picts: PICTs; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the Rectangle. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the Rectangle. (Range: -360 to 360) */ shearAngle: number; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * A collection of sound clips. */ readonly sounds: Sounds; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * Title for this InCopy story. */ storyTitle: string; /** * The stroke alignment applied to the Rectangle. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the Rectangle. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the Rectangle. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the Rectangle's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * A collection of text paths. */ readonly textPaths: TextPaths; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the Rectangle. */ verticalScale: number; /** * If true, the Rectangle is visible. */ visible: boolean; /** * The bounds of the Rectangle including the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * A collection of WMF graphics. */ readonly wmfs: WMFs; /** * Dispatched after a Rectangle is placed. This event bubbles. This event is * not cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a Rectangle is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Creates a new page item by combining the Rectangle with other objects. * Deletes the objects if they do not intersect. * @param with_ The object(s) to add. */ addPath(with_: PageItem[]): PageItem; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the Rectangle's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the Rectangle that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Brings the Rectangle forward one level in its layer. */ bringForward(): void; /** * Brings the Rectangle to the front of its layer or in front of a particular * item. * @param reference The reference object to bring the object in front of (must have same parent) (Optional) */ bringToFront(reference?: PageItem): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Checks in the story or stories. * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ checkIn(versionComments?: string, forceSave?: boolean): boolean; /** * Checks out the story. */ checkOut(): boolean; /** * Removes the frame fittings options and resets it to the initial state. */ clearFrameFittingOptions(): void; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the Rectangle. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the Rectangle to a different shape. * @param given The Rectangle's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Rectangle. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Rectangle. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Rectangle. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Rectangle. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Rectangle. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the Rectangle at the specified location or offset. * @param to The location of the new Rectangle, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new Rectangle from the original Rectangle's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Creates a new page item by excluding the overlapping areas of the Rectangle * and other objects. * @param with_ The object(s) to exclude. */ excludeOverlapPath(with_: PageItem[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the Rectangle. * @param given The axis around which to flip the Rectangle. * @param around The point around which to flip the Rectangle. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Rectangle[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Creates a new page item by intersecting the Rectangle with other objects. * Returns an error if the objects do not intersect. * @param with_ The object(s) with which to intersect. */ intersectPath(with_: PageItem[]): PageItem; /** * Creates a compound path by combining the path(s) of the Rectangle with the * paths of other objects. * @param with_ The other objects whose paths to include in the new compound path. */ makeCompoundPath(with_: PageItem[]): PageItem; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Creates a new page item by reverse subtracting the overlapping areas of the * Rectangle and other objects. * @param with_ The object(s) to reverse subtract. */ minusBack(with_: PageItem[]): PageItem; /** * Moves the Rectangle to a new location. Note: Either the 'to' or 'by' * parameter is required; if both parameters are defined, only the to value is * used. * @param to The new location of the Rectangle,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the Rectangle relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Releases a compound path. */ releaseCompoundPath(): PageItem[]; /** * Deletes the Rectangle. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Reverts the document to its state at the last save operation. */ revert(): boolean; /** * Selects the object. * @param existingSelection The selection status of the Rectangle in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Sends the Rectangle back one level in its layer. */ sendBackward(): void; /** * Sends the Rectangle to the back of its layer or behind a particular item * (must have same parent). * @param reference The reference object to send the object behind (Optional) */ sendToBack(reference?: PageItem): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new Rectangle (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Creates a new page item by subtracting the overlapping areas of the * Rectangle and other objects. * @param with_ The object(s) to subtract. */ subtractPath(with_: PageItem[]): PageItem; /** * Generates a string which, if executed, will return the Rectangle. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the Rectangle using the last transformation performed on any * object. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgain(): string[]; /** * Transforms the Rectangle using the last transformation performed on any * Rectangle. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgainIndividually(): string[]; /** * Transforms the Rectangle using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the Rectangle using the last sequence of transformations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * A collection of rectangles. */ declare class Rectangles { /** Returns the Rectangle with the specified index or name. */ [index: number]: Rectangle; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new Rectangle * @param layer The layer on which to create the Rectangle. (Optional) * @param at The location at which to insert the Rectangle relative to the reference object or within the container object. (Optional) * @param reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) * @param withProperties Initial values for properties of the new Rectangle (Optional) */ add(layer?: Layer, at?: LocationOptions, reference?: Document | Layer | MasterSpread | Page | Spread | PageItem, withProperties?: Object): Rectangle; /** * Returns any Rectangle in the collection. */ anyItem(): Rectangle; /** * Displays the number of elements in the Rectangle. */ count(): number; /** * Returns every Rectangle in the collection. */ everyItem(): Rectangle; /** * Returns the first Rectangle in the collection. */ firstItem(): Rectangle; /** * Returns the Rectangle with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Rectangle; /** * Returns the Rectangle with the specified ID. * @param id The ID. */ itemByID(id: number): Rectangle; /** * Returns the Rectangle with the specified name. * @param name The name. */ itemByName(name: string): Rectangle; /** * Returns the Rectangles within the specified range. * @param from The Rectangle, index, or name at the beginning of the range. Can accept: Rectangle, Long Integer or String. * @param to The Rectangle, index, or name at the end of the range. Can accept: Rectangle, Long Integer or String. */ itemByRange(from: number | Rectangle | string, to: number | Rectangle | string): Rectangle[]; /** * Returns the last Rectangle in the collection. */ lastItem(): Rectangle; /** * Returns the middle Rectangle in the collection. */ middleItem(): Rectangle; /** * Returns the Rectangle whose index follows the specified Rectangle in the * collection. * @param obj The Rectangle whose index comes before the desired Rectangle. */ nextItem(obj: Rectangle): Rectangle; /** * Returns the Rectangle with the index previous to the specified index. * @param obj The index of the Rectangle that follows the desired Rectangle. */ previousItem(obj: Rectangle): Rectangle; /** * Generates a string which, if executed, will return the Rectangle. */ toSource(): string; } /** * Provides information about a class. */ declare class Reflection { /** * The long description text. */ readonly description: string; /** * The short description text. */ readonly help: string; /** * An array of method descriptions. */ readonly methods: ReflectionInfo[]; /** * The class name. */ readonly name: string; /** * An array of property descriptions. */ readonly properties: ReflectionInfo[]; /** * Sample code, if present. */ readonly sampleCode: string; /** * A file containing sample code. May be null. */ readonly sampleFile: File; /** * An array of class method descriptions. */ readonly staticMethods: ReflectionInfo[]; /** * An array of class property descriptions. */ readonly staticProperties: ReflectionInfo[]; /** * Finds an element description by name. * @param name The name of the element to find. */ find(name: string): ReflectionInfo; /** * Returns this class information as XML in OMV format. */ toXML(): XML; } /** * Provides information about a method, a property or a method parameters. */ declare class ReflectionInfo { /** * The description of method or function arguments. */ readonly arguments: ReflectionInfo[]; /** * The data type. */ readonly dataType: string; /** * The default value. */ readonly defaultValue: any; /** * The long description text. */ readonly description: string; /** * The short description text. */ readonly help: string; /** * Contains true if the class describes a collection class. */ readonly isCollection: boolean; /** * The maximum value. */ readonly max: number; /** * The minimum value. */ readonly min: number; /** * The element name. */ readonly name: string; /** * The class object that this element belongs to. */ readonly parent: any; /** * Sample code, if present. */ readonly sampleCode: string; /** * A file containing sample code. May be null. */ readonly sampleFile: File; /** * The element type. */ readonly type: string; } /** * Rendering intent options. */ declare enum RenderingIntent { /** * Maintains color accuracy at the expense of preserving relationships between * colors; most suitable for previewing how paper color affects printed colors. */ ABSOLUTE_COLORIMETRIC = 1380540771, /** * Preserves the visual relationship between colors at the expense of actual * color values; most suitable for photographic images with high percentages of * out-of-gamut colors. */ PERCEPTUAL = 1380544611, /** * Compares the extreme highlight of the source color space to that of the * desination color space and shifts all colors accordingly; out-of-gamut * colors are shifted to the closest reproducible color in the destination * color space. */ RELATIVE_COLORIMETRIC = 1380545123, /** * Produces vivid colors at the expense of color accuracy; most suitable for * business graphics such as graphs or charts. */ SATURATION = 1380545377, /** * Uses the current color settings. */ USE_COLOR_SETTINGS = 1380541299, } /** * Page numbering options for book content objects within the book. */ declare enum RepaginateOption { /** * Starts page numbers for each book content object at the next even-numbered * page after the last page of the previous book content object. */ NEXT_EVEN_PAGE = 1164993131, /** * Starts page numbers for each book content object at the next odd-numbered * page after the last page of the previous book content object. */ NEXT_ODD_PAGE = 1332765291, /** * Continues page numbers sequentially from the previous book content object. */ NEXT_PAGE = 1885500011, } /** * A collection of reply objects */ declare class Replies { /** Returns the Reply with the specified index or name. */ [index: number]: Reply; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Reply in the collection. */ anyItem(): Reply; /** * Displays the number of elements in the Reply. */ count(): number; /** * Returns every Reply in the collection. */ everyItem(): Reply; /** * Returns the first Reply in the collection. */ firstItem(): Reply; /** * Returns the Reply with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Reply; /** * Returns the Reply with the specified ID. * @param id The ID. */ itemByID(id: number): Reply; /** * Returns the Reply with the specified name. * @param name The name. */ itemByName(name: string): Reply; /** * Returns the Replies within the specified range. * @param from The Reply, index, or name at the beginning of the range. Can accept: Reply, Long Integer or String. * @param to The Reply, index, or name at the end of the range. Can accept: Reply, Long Integer or String. */ itemByRange(from: number | Reply | string, to: number | Reply | string): Reply[]; /** * Returns the last Reply in the collection. */ lastItem(): Reply; /** * Returns the middle Reply in the collection. */ middleItem(): Reply; /** * Returns the Reply whose index follows the specified Reply in the collection. * @param obj The Reply whose index comes before the desired Reply. */ nextItem(obj: Reply): Reply; /** * Returns the Reply with the index previous to the specified index. * @param obj The index of the Reply that follows the desired Reply. */ previousItem(obj: Reply): Reply; /** * Generates a string which, if executed, will return the Reply. */ toSource(): string; } /** * Reply object. */ declare class Reply { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the Reply. */ readonly id: number; /** * The index of the Reply within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the Reply; this is an alias to the Reply's label property. */ name: string; /** * The parent of the Reply (a PDFComment). */ readonly parent: PDFComment; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The content of the reply */ readonly replyContent: string; /** * The date of the reply */ readonly replyDate: Date; /** * The name of the reviewer who made the reply */ readonly replyReviewer: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Reply[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Reply. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Resize constraints. */ declare enum ResizeConstraints { /** * Inverse proportions */ INVERSE_PROPORTIONS = 1231976016, /** * Keep current proportions */ KEEP_CURRENT_PROPORTIONS = 1264939088, /** * Keep current value */ KEEP_CURRENT_VALUE = 1264939094, /** * Tall proportions */ TALL_PROPORTIONS = 1415670864, /** * Wide proportions */ WIDE_PROPORTIONS = 1466524752, } /** * Resize methods. */ declare enum ResizeMethods { /** * Add additional width and height to current values */ ADDING_CURRENT_DIMENSIONS_TO = 1215264592, /** * Multiply current width and height by the given factors */ MULTIPLYING_CURRENT_DIMENSIONS_BY = 1215264589, /** * Change width and height overriding current values */ REPLACING_CURRENT_DIMENSIONS_WITH = 1215264581, /** * Change width to height ratio keeping the current area */ RESHAPING_AREA_TO_RATIO = 1215264577, /** * Change width to height ratio keeping the current perimeter */ RESHAPING_BORDER_TO_RATIO = 1215264595, } /** * Options for resolving clashes that result from matching style names. */ declare enum ResolveStyleClash { /** * Automatically renames the new style. */ RESOLVE_CLASH_AUTO_RENAME = 2001879873, /** * Uses the existing style. */ RESOLVE_CLASH_USE_EXISTING = 2001879877, /** * Uses the new style. */ RESOLVE_CLASH_USE_NEW = 2001879886, } /** * Restart numbering options. */ declare enum RestartPolicy { /** * Restart numbering after a specific numbering level. */ AFTER_SPECIFIC_LEVEL = 1701737324, /** * Restart numbering after any previous (higher) numbering level. */ ANY_PREVIOUS_LEVEL = 1701732720, /** * Restart numbering after any of a range of numbering levels. */ RANGE_OF_LEVELS = 1701737068, } /** * Options for rotating the contents of the place gun */ declare enum RotationDirection { /** * Rotate the list backward (i.e., move backmost item to front) */ BACKWARD = 1113680759, /** * Rotate the list forward (i.e., move the front item to end) */ FORWARD = 1181708919, } /** * A table row. */ declare class Row { /** * If true, the height of the cell or the cells in the Row can increase or * decrease automatically to fit cell content. Note: Allows cells to grow or * shrink to the maximum or minimum height, if specified. */ autoGrow: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the bottom edge * border stroke. */ bottomEdgeStrokeColor: Swatch; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * bottom edge border stroke. Note: Not valid when bottom edge stroke type is * solid. */ bottomEdgeStrokeGapColor: Swatch; /** * If true, the gap color of the bottom edge border stroke will overprint. * Note: Not valid when bottom edge stroke type is solid. */ bottomEdgeStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the bottom edge border stroke gap color. * (Range: 0 to 100) Note: Not valid when bottom edge stroke type is solid. * @remarks Range: 0 to 100 */ bottomEdgeStrokeGapTint: number; /** * If true, the bottom edge border stroke will overprint. */ bottomEdgeStrokeOverprint: boolean; /** * The tint (as a percentage) of the bottom edge border stroke. */ bottomEdgeStrokeTint: number; /** * The stroke type of the bottom edge. Can also accept: String. */ bottomEdgeStrokeType: StrokeStyle | string; /** * The stroke weight of the bottom edge border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomEdgeStrokeWeight: number | string; /** * The bottom inset of the cell.The API has been deprecated. Use * TextBottomInset or GraphicBottomInset * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomInset: number | string; /** * A collection of table cells. */ readonly cells: Cells; /** * If true, clips the cell's content to width and height of the cell. The API * has been deprecated. Use ClipContentsToTextCell or * ClipContentsToPageItemCell */ clipContentToCell: boolean; /** * If true, clips the graphic cell's content to width and height of the cell. */ clipContentToGraphicCell: boolean; /** * If true, clips the text cell's content to width and height of the cell. */ clipContentToTextCell: boolean; /** * The number of columns that the object spans. */ readonly columnSpan: number; /** * A collection of table columns. */ readonly columns: Columns; /** * The text contents. For rows or columns, when specified as a string, the * sting populates each cell in the row or column; when specified as an array, * the first value in the array populates the left-most cell in the row or the * top-most cell in the column; the next value populates the next cell to the * right (for rows) or the next lowest cell (for columns), and so on. Can * return: PageItem, String, SpecialCharacters enumerator or Array of Strings, * SpecialCharacters enumerators or PageItems. Can also accept: PageItem, * NothingEnum enumerator or Array of Strings, SpecialCharacters enumerators, * NothingEnum enumerators or PageItems. */ contents: (NothingEnum | NothingEnum[] | PageItem | SpecialCharacters | string | string[] | PageItems)[]; /** * If true, draws the diagonal line in front of cell contents. */ diagonalLineInFront: boolean; /** * The diagonal line color, specified as a swatch. */ diagonalLineStrokeColor: Swatch; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * diagonal line stroke. Note: Not valid when diagonal line stroke type is * solid. */ diagonalLineStrokeGapColor: Swatch; /** * If true, the stroke gap of the diagonal line will overprint. Note: Not valid * when diagonal line stroke type is solid. */ diagonalLineStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the diagonal line stroke gap color. Note: Not * valid when diagonal line stroke type is solid. */ diagonalLineStrokeGapTint: number; /** * If true, the diagonal line stroke will overprint. */ diagonalLineStrokeOverprint: boolean; /** * The diagonal line tint (as a percentage). (Range: 0 to 100) * @remarks Range: 0 to 100 */ diagonalLineStrokeTint: number; /** * The stroke type of the diagonal line(s). Can also accept: String. */ diagonalLineStrokeType: StrokeStyle | string; /** * The diagonal line stroke weight. * @remarks Measurement unit — also accepts a string such as "12mm". */ diagonalLineStrokeWeight: number | string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * object. Can also accept: String. */ fillColor: Swatch | string; /** * The tint (as a percentage) of the fill of the object. */ fillTint: number; /** * The distance between the baseline of the text and the top inset of the cell. */ firstBaselineOffset: FirstBaseline; /** * The angle of a linear gradient applied to the fill of the object. (Range: * -180 to 180) */ gradientFillAngle: number; /** * The length (of a linear gradient) or radius (of a radial gradient) applied * to the fill of the object. */ gradientFillLength: number; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the Row, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The bottom inset of the graphic cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ graphicBottomInset: number | string; /** * The left inset of the graphic cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ graphicLeftInset: number | string; /** * The right inset of the graphic cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ graphicRightInset: number | string; /** * The top inset of the graphic cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ graphicTopInset: number | string; /** * The height of the Row. For a table or column, specifies the sum of the row * heights. * @remarks Measurement unit — also accepts a string such as "12mm". */ height: number | string; /** * The index of the Row within its containing object. */ readonly index: number; /** * The color, specified as a swatch, of the inner column border stroke. */ innerColumnStrokeColor: Swatch; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * inner column border stroke. Note: Not valid when inner column stroke type is * solid. */ innerColumnStrokeGapColor: Swatch; /** * If true, the gap color of the inner column border stroke will overprint. * Note: Not valid when inner column stroke type is solid. */ innerColumnStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the inner column border stroke gap color. * (Range: 0 to 100) Note: Not valid when inner column stroke type is solid. * @remarks Range: 0 to 100 */ innerColumnStrokeGapTint: number; /** * If true, the inner column border stroke will overprint. */ innerColumnStrokeOverprint: boolean; /** * The tint (as a percentage) of the inner column border stroke. (Range: 0 to * 100) * @remarks Range: 0 to 100 */ innerColumnStrokeTint: number; /** * The stroke type of the inner column. Can also accept: String. */ innerColumnStrokeType: StrokeStyle | string; /** * The stroke weight of the inner column border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ innerColumnStrokeWeight: number | string; /** * The color, specified as a swatch, of the inner row border stroke. */ innerRowStrokeColor: Swatch; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * inner row border stroke. Note: Not valid when inner row stroke type is * solid. */ innerRowStrokeGapColor: Swatch; /** * If true, the gap color of the inner row border stroke will overprint. Note: * Not valid when inner row stroke type is solid. */ innerRowStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the inner row border stroke. (Range: 0 to 100) * Note: Not valid when inner row stroke type is solid. * @remarks Range: 0 to 100 */ innerRowStrokeGapTint: number; /** * If true, the inner row border stroke will overprint. */ innerRowStrokeOverprint: boolean; /** * The tint (as a percentage) of the inner row border stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ innerRowStrokeTint: number; /** * The stroke type of the inner row. Can also accept: String. */ innerRowStrokeType: StrokeStyle | string; /** * The stroke weight of the inner row border strokes. * @remarks Measurement unit — also accepts a string such as "12mm". */ innerRowStrokeWeight: number | string; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * If true, keeps the row with the next row when the table is split across text * frames or pages. */ keepWithNextRow: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the left edge * border stroke. */ leftEdgeStrokeColor: Swatch; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * left edge border stroke. Note: Not valid when left edge stroke type is * solid. */ leftEdgeStrokeGapColor: Swatch; /** * If true, the gap color of the left edge border stroke will overprint. Note: * Not valid when left edge stroke type is solid. */ leftEdgeStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the left edge border stroke gap color. (Range: * 0 to 100) Note: Not valid when left edge stroke type is solid. * @remarks Range: 0 to 100 */ leftEdgeStrokeGapTint: number; /** * If true, the left edge border stroke will overprint. */ leftEdgeStrokeOverprint: boolean; /** * The tint (as a percentage) of the left edge border stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ leftEdgeStrokeTint: number; /** * The stroke type of the left edge. Can also accept: String. */ leftEdgeStrokeType: StrokeStyle | string; /** * The stroke weight of the left edge border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ leftEdgeStrokeWeight: number | string; /** * The left inset of the cell.The API has been deprecated. Use TextLeftInset or * GraphicLeftInset * @remarks Measurement unit — also accepts a string such as "12mm". */ leftInset: number | string; /** * The maximum height to which cells in the Row may grow. Note: The maximum * height cannot be exceeded even when auto grow is set to true. Also, the * maximum height can affect redistribution. * @remarks Measurement unit — also accepts a string such as "12mm". */ maximumHeight: number | string; /** * The space between the baseline of the text and the top inset of the frame or * cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ minimumFirstBaselineOffset: number | string; /** * The minimum height of the cells in the Row. Note: When auto grow is true, * cells can automatically grow larger than this amount when content is added. * Also, the minimum height can affect redistribution. * @remarks Measurement unit — also accepts a string such as "12mm". */ minimumHeight: number | string; /** * The name of the Row. */ readonly name: string; /** * If true, the story has overset text. */ readonly overflows: boolean; /** * If true, the fill of the object will overprint. */ overprintFill: boolean; /** * The maximum space that can be added between paragraphs in a cell. Note: * Valid only when vertical justification is justified. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphSpacingLimit: number | string; /** * The parent of the Row (a Table). */ readonly parent: Table; /** * The parent column of the cell. */ readonly parentColumn: Column; /** * The parent row of the cell. */ readonly parentRow: Row; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The color, specified as a swatch, of the right edge border stroke. */ rightEdgeStrokeColor: Swatch; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * right edge border stroke. Note: Not valid when right edge stroke type is * solid. */ rightEdgeStrokeGapColor: Swatch; /** * If true, the gap color of the right edge border stroke will overprint. Note: * Not valid when right edge stroke type is solid. */ rightEdgeStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the right edge border stroke gap color. * (Range: 0 to 100) Note: Not valid when right edge stroke type is solid. * @remarks Range: 0 to 100 */ rightEdgeStrokeGapTint: number; /** * If true, the right edge border stroke will overprint. */ rightEdgeStrokeOverprint: boolean; /** * The tint (as a percentage) of the right edge border stroke. (Range: 0 to * 100) * @remarks Range: 0 to 100 */ rightEdgeStrokeTint: number; /** * The stroke type of the right edge. Can also accept: String. */ rightEdgeStrokeType: StrokeStyle | string; /** * The stroke weight of the right edge border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ rightEdgeStrokeWeight: number | string; /** * The right inset of the cell.The API has been deprecated. Use TextLeftInset * or GraphicRightInset * @remarks Measurement unit — also accepts a string such as "12mm". */ rightInset: number | string; /** * The rotation angle (in degrees) of the cell, specified as one of the * following values: 0, 90, 180, or 270. */ rotationAngle: number; /** * The number of rows that the object spans. */ readonly rowSpan: number; /** * The row type. */ rowType: RowTypes; /** * A collection of table rows. */ readonly rows: Rows; /** * Indicates where to start the row. */ startRow: StartParagraph; /** * The bottom inset of the text cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ textBottomInset: number | string; /** * The left inset of the text cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ textLeftInset: number | string; /** * The right inset of the text cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ textRightInset: number | string; /** * The top inset of the text cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ textTopInset: number | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the top edge * border stroke. */ topEdgeStrokeColor: Swatch; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * top edge border stroke. Note: Not valid when top edge stroke type is solid. */ topEdgeStrokeGapColor: Swatch; /** * If true, the gap color of the top edge border stroke will overprint. Note: * Not valid when top edge stroke type is solid. */ topEdgeStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the top edge border stroke gap color. (Range: * 0 to 100) Note: Not valid when top edge stroke type is solid. * @remarks Range: 0 to 100 */ topEdgeStrokeGapTint: number; /** * If true, the top edge border stroke will overprint. */ topEdgeStrokeOverprint: boolean; /** * The tint (as a percentage) of the top edge border stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ topEdgeStrokeTint: number; /** * The stroke type of the top edge. Can also accept: String. */ topEdgeStrokeType: StrokeStyle | string; /** * The stroke weight of the top edge border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ topEdgeStrokeWeight: number | string; /** * The top inset of the cell. The API has been deprecated. Use TextTopInset or * GraphicTopInset * @remarks Measurement unit — also accepts a string such as "12mm". */ topInset: number | string; /** * If true, draws a diagonal line starting from the top left. */ topLeftDiagonalLine: boolean; /** * If true, draws a diagonal line starting from the top right. */ topRightDiagonalLine: boolean; /** * The vertical alignment of cell. */ verticalJustification: VerticalJustification; /** * The width of the Row. For a table or row, specifies the sum of the column * widths. * @remarks Measurement unit — also accepts a string such as "12mm". */ width: number | string; /** * The direction of the text in the cell. */ writingDirection: HorizontalOrVertical; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Finds glyphs that match the find what value and replaces the glyphs with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value and replaces the text * with the change character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeTransliterate(reverseOrder?: boolean): Text[]; /** * Converts text to outlines. Each line of text becomes a polygon object. When * the converted text is a single letter that has no internal spaces or * detached parts, the polygon contains only a single path. Note: To determine * whether a font allows the creation of outlines, see allow outlines. * @param deleteOriginal If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) */ createOutlines(deleteOriginal?: boolean): PageItem[]; /** * Finds glyphs that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findTransliterate(reverseOrder?: boolean): Text[]; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Row[]; /** * Merges the cells. * @param with_ The cell(s) to merge with. Can accept: Cell, Row or Column. (Optional) */ merge(with_?: Cell | Row | Column): Cell; /** * Recomposes the text in the Row. */ recompose(): void; /** * Redistributes the specified range of Rows so that the Rows have a uniform * size. Note: The maximum or minimum height or width specified for some of the * cells in the range may prevent them from being exactly even. * @param using The direction in which to redistribute. * @param thru The last Row in the range. Can accept: Cell, Column or Row. (Optional) */ redistribute(using: HorizontalOrVertical, thru?: Cell | Column | Row): void; /** * Deletes the Row. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Selects the object. * @param existingSelection The selection status of the Row in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Splits the cell along the specified axis. * @param using The direction in which to split the cell. */ split(using: HorizontalOrVertical): void; /** * Generates a string which, if executed, will return the Row. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Unmerges all merged cells in the Row. */ unmerge(): Cell[]; } /** * The row type. */ declare enum RowTypes { /** * Makes the row a body row. */ BODY_ROW = 1161982583, /** * Makes the row a footer row. Note: When setting row type as footer row, the * row must be either the bottom row in the table or adjacent to an existing * footer row. */ FOOTER_ROW = 1162244727, /** * Makes the row a header row. Note: When setting row type as header row, the * row must be either the top row in the table or adjacent to an existing * header row. */ HEADER_ROW = 1162375799, /** * (Read-only) The column's rows are of multiple types. */ MIXED_STATE = 1162703479, } /** * A collection of table rows. */ declare class Rows { /** Returns the Row with the specified index or name. */ [index: number]: Row; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new Row. * @param at The Row's location relative to the reference object or within the table. (Optional) * @param reference The reference object. Note: The reference object must be within the table. Required only when the at value contains before or after. Can accept: Row, Column, Cell or Table. (Optional) * @param withProperties Initial values for properties of the new Row (Optional) */ add(at?: LocationOptions, reference?: Cell | Column | Row | Table, withProperties?: Object): any; /** * Returns any Row in the collection. */ anyItem(): Row; /** * Displays the number of elements in the Row. */ count(): number; /** * Returns every Row in the collection. */ everyItem(): Row; /** * Returns the first Row in the collection. */ firstItem(): Row; /** * Returns the Row with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Row; /** * Returns the Row with the specified name. * @param name The name. */ itemByName(name: string): Row; /** * Returns the Rows within the specified range. * @param from The Row, index, or name at the beginning of the range. Can accept: Row, Long Integer or String. * @param to The Row, index, or name at the end of the range. Can accept: Row, Long Integer or String. */ itemByRange(from: number | Row | string, to: number | Row | string): Row[]; /** * Returns the last Row in the collection. */ lastItem(): Row; /** * Returns the middle Row in the collection. */ middleItem(): Row; /** * Returns the Row whose index follows the specified Row in the collection. * @param obj The Row whose index comes before the desired Row. */ nextItem(obj: Row): Row; /** * Returns the Row with the index previous to the specified index. * @param obj The index of the Row that follows the desired Row. */ previousItem(obj: Row): Row; /** * Generates a string which, if executed, will return the Row. */ toSource(): string; } /** * Ruby alignment options. */ declare enum RubyAlignments { /** * Ruby 1 aki. */ RUBY_1_AKI = 1248997729, /** * Centers ruby relative to the parent text. */ RUBY_CENTER = 1249010548, /** * Ruby equal aki. */ RUBY_EQUAL_AKI = 1249011041, /** * Justifies ruby across the parent text. */ RUBY_FULL_JUSTIFY = 1249011306, /** * Ruby JIS. */ RUBY_JIS = 1249012339, /** * Aligns ruby with the left-most character in the parent text. */ RUBY_LEFT = 1249012838, /** * Aligns ruby with the right-most character in the parent text. */ RUBY_RIGHT = 1249014388, } /** * Options for specifying the kenten or ruby position relative to the parent * character. */ declare enum RubyKentenPosition { /** * Places kenten or ruby to the right and above the parent character. */ ABOVE_RIGHT = 1248551282, /** * Places kenten or ruby to the left and below the parent character. */ BELOW_LEFT = 1248551532, } /** * Ruby overhang options. */ declare enum RubyOverhang { /** * Does not allow ruby overhang. */ NONE = 1852796517, /** * Ruby is overhang one-half the size of one chararacter. */ RUBY_OVERHANG_HALF_CHAR = 1249011811, /** * Ruby overhang is one-half ruby. */ RUBY_OVERHANG_HALF_RUBY = 1249013554, /** * There is no ruby overhang size limit. */ RUBY_OVERHANG_NO_LIMIT = 1249013621, /** * Ruby overhang is the size of one character. */ RUBY_OVERHANG_ONE_CHAR = 1249013603, /** * Ruby overhang is one ruby. */ RUBY_OVERHANG_ONE_RUBY = 1249013553, } /** * Options for ruby spacing relative to the parent text. */ declare enum RubyParentSpacing { /** * Ruby parent 121 aki. */ RUBY_PARENT_121_AKI = 1248997682, /** * Ruby parent both sides. */ RUBY_PARENT_BOTH_SIDES = 1249010291, /** * Applies the parent text aki to the ruby characters. */ RUBY_PARENT_EQUAL_AKI = 1249014113, /** * Justifies ruby characters to both edges of the parent text. */ RUBY_PARENT_FULL_JUSTIFY = 1249014634, /** * Does not base ruby spacing on parent text. */ RUBY_PARENT_NO_ADJUSTMENT = 1249013345, } /** * Ruby type options. */ declare enum RubyTypes { /** * Provides ruby for a group of characters. */ GROUP_RUBY = 1249011570, /** * Provides ruby for each individual character in the group. */ PER_CHARACTER_RUBY = 1249013859, } /** * A preflight rule data object. */ declare class RuleDataObject { /** * The type of data. */ readonly dataType: RuleDataType; /** * The value for this data object. Can return: String, Real, Long Integer, * Short Integer, Boolean, Object or Array of Strings, Reals, Long Integers, * Short Integers, Booleans, Objects or Arrays of Array of Arrays of Array of * Strings, Reals, Long Integers, Short Integers, Booleans or Objects. */ dataValue: (boolean | boolean[] | number | number[] | Object | any[] | string | string[] | string[][][])[]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The ID for this rule data object. */ readonly id: string; /** * The index of the RuleDataObject within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the RuleDataObject. */ readonly name: string; /** * The parent of the RuleDataObject (a PreflightProfileRule or * PreflightRuleInstance). */ readonly parent: PreflightProfileRule | PreflightRuleInstance; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): RuleDataObject[]; /** * Deletes the RuleDataObject. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the RuleDataObject. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of prefight rule data objects. */ declare class RuleDataObjects { /** Returns the RuleDataObject with the specified index or name. */ [index: number]: RuleDataObject; /** * The number of objects in the collection. */ readonly length: number; /** * Add a new preflight rule data to a preflight profile rule. * @param name The name of the rule data to add * @param dataType The type of data * @param dataValue The value of data. Can accept: String, Real, Long Integer, Short Integer, Boolean, Object or Array of Strings, Reals, Long Integers, Short Integers, Booleans, Objects or Arrays of Array of Arrays of Array of Strings, Reals, Long Integers, Short Integers, Booleans or Objects. * @param withProperties Initial values for properties of the new RuleDataObject (Optional) */ add(name: string, dataType: RuleDataType, dataValue: (boolean | boolean[] | number | number[] | Object | any[] | string | string[] | string[][][])[], withProperties?: Object): RuleDataObject; /** * Returns any RuleDataObject in the collection. */ anyItem(): RuleDataObject; /** * Displays the number of elements in the RuleDataObject. */ count(): number; /** * Returns every RuleDataObject in the collection. */ everyItem(): RuleDataObject; /** * Returns the first RuleDataObject in the collection. */ firstItem(): RuleDataObject; /** * Returns the RuleDataObject with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): RuleDataObject; /** * Returns the RuleDataObject with the specified ID. * @param id The ID. */ itemByID(id: number): RuleDataObject; /** * Returns the RuleDataObject with the specified name. * @param name The name. */ itemByName(name: string): RuleDataObject; /** * Returns the RuleDataObjects within the specified range. * @param from The RuleDataObject, index, or name at the beginning of the range. Can accept: RuleDataObject, Long Integer or String. * @param to The RuleDataObject, index, or name at the end of the range. Can accept: RuleDataObject, Long Integer or String. */ itemByRange(from: number | RuleDataObject | string, to: number | RuleDataObject | string): RuleDataObject[]; /** * Returns the last RuleDataObject in the collection. */ lastItem(): RuleDataObject; /** * Returns the middle RuleDataObject in the collection. */ middleItem(): RuleDataObject; /** * Returns the RuleDataObject whose index follows the specified RuleDataObject * in the collection. * @param obj The RuleDataObject whose index comes before the desired RuleDataObject. */ nextItem(obj: RuleDataObject): RuleDataObject; /** * Returns the RuleDataObject with the index previous to the specified index. * @param obj The index of the RuleDataObject that follows the desired RuleDataObject. */ previousItem(obj: RuleDataObject): RuleDataObject; /** * Generates a string which, if executed, will return the RuleDataObject. */ toSource(): string; } /** * The type of data for this data object. */ declare enum RuleDataType { /** * The data type is a boolean. */ BOOLEAN_DATA_TYPE = 1920221804, /** * The data type is an int32. */ INTEGER_DATA_TYPE = 1920223598, /** * The data type is a list. */ LIST_DATA_TYPE = 1920224372, /** * The data type is an object. */ OBJECT_DATA_TYPE = 1920225122, /** * The data type is a real. */ REAL_DATA_TYPE = 1920225900, /** * The data type is an int16. */ SHORT_INTEGER_DATA_TYPE = 1920226153, /** * The data type is a string. */ STRING_DATA_TYPE = 1920226162, } /** * Options for specifying an object on which to base the width of the paragraph * rule above. */ declare enum RuleWidth { /** * Makes the rule the width of the column. */ COLUMN_WIDTH = 1265399652, /** * Makes the paragraph rule above the width of the first line of text in the * paragraph. */ TEXT_WIDTH = 1886681207, } /** * Zero point placement options. */ declare enum RulerOrigin { /** * The top-left corner of each page is a new zero point on the horizontal * ruler. */ PAGE_ORIGIN = 1380143215, /** * The zero point is at the top-left corner of the left-most page and at the * top of the binding spine. The horizontal ruler measures from the leftmost * page to the binding edge, and from the binding spine through the right edge * of the right-most page. Also locks the zero point and prevents manual * overrides. */ SPINE_ORIGIN = 1380143984, /** * The zero point is at the top-left corner of the spread and the ruler * increments continuously across all pages of the spread. */ SPREAD_ORIGIN = 1380143983, } /** * An placed SVG file */ declare class SVG extends Graphic { /** * Indicates whether the SVG has been flipped independently of its parent * object and, if yes, the direction in which the SVG was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the SVG relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the SVG relative to its containing object. (Range: * -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the SVG relative to its containing object. (Range: -360 * to 360) */ absoluteShearAngle: number; /** * The vertical scale of the SVG relative to its containing object. */ absoluteVerticalScale: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the SVG. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the SVG. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the SVG. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the SVG. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the SVG. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * Transparency settings for the content of the SVG. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the SVG. */ endJoin: EndJoin; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * SVG. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the SVG's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the SVG. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the SVG excluding the stroke width, in the format [y1, x1, y2, * x2], which give the coordinates of the top-left and bottom-right corners of * the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the SVG. (Range: -180 * to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the SVG. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the SVG, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the SVG. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the SVG. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the SVG, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the SVG. */ horizontalScale: number; /** * The unique ID of the SVG. */ readonly id: number; /** * The type of the image. */ readonly imageTypeName: string; /** * The index of the SVG within its containing object. */ readonly index: number; /** * Is the SVG Object a MathML object. */ readonly isMathMLObject: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the SVG is on. */ itemLayer: Layer; /** * The source file of the link. */ readonly itemLink: Link; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the SVG. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the SVG is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * The name of the SVG. */ name: string; /** * If true, the SVG does not print. */ nonprinting: boolean; /** * If true, the SVG's fill color overprints any underlying objects. If false, * the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the SVG's stroke color overprints any underlying objects. If false, * the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the SVG (a TextBox, SignatureField, ComboBox, ListBox, * PageItem, HtmlItem, FlexObject, FormField, RadioButton, CheckBox, * MultiStateObject, Button, MediaItem, Sound, Movie, EPSText, SplineItem, * Polygon, GraphicLine, Rectangle, Oval, Graphic, SVG, ImportedPage, PICT, * WMF, PDF, EPS, Image, Group, TextFrame, EndnoteTextFrame, State, PlaceGun, * XMLElement, Snippet or Spread). */ readonly parent: Button | CheckBox | ComboBox | EPS | EPSText | EndnoteTextFrame | FlexObject | FormField | Graphic | GraphicLine | Group | HtmlItem | Image | ImportedPage | ListBox | MediaItem | Movie | MultiStateObject | Oval | PDF | PICT | PageItem | PlaceGun | Polygon | RadioButton | Rectangle | SVG | SignatureField | Snippet | Sound | SplineItem | State | TextFrame | WMF | XMLElement | Spread | TextBox; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the SVG. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the SVG. (Range: -360 to 360) */ shearAngle: number; /** * The stroke alignment applied to the SVG. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the SVG. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the SVG. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the SVG's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * Use SVG As */ useSVGAs: UseSVGAsEnum; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the SVG. */ verticalScale: number; /** * If true, the SVG is visible. */ visible: boolean; /** * The bounds of the SVG including the stroke width, in the format [y1, x1, y2, * x2], which give the coordinates of the top-left and bottom-right corners of * the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * Dispatched after a SVG is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a SVG is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the SVG's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the SVG that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the SVG. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the SVG to a different shape. * @param given The SVG's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new SVG. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new SVG. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new SVG. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new SVG. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new SVG. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the SVG at the specified location or offset. * @param to The location of the new SVG, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new SVG from the original SVG's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Exports the SVG for the web. * @param to The full path name of the exported file. */ exportForWeb(to: File): string[]; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the SVG. * @param given The axis around which to flip the SVG. * @param around The point around which to flip the SVG. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): SVG[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the SVG to a new location. Note: Either the 'to' or 'by' parameter is * required; if both parameters are defined, only the to value is used. * @param to The new location of the SVG,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the SVG relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the SVG. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Internal Use Only. * @param resyncData Internal Use Only */ resync(resyncData: string): void; /** * Selects the object. * @param existingSelection The selection status of the SVG in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new SVG (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the SVG. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the SVG using the last transformation performed on any object. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformAgain(): string[]; /** * Transforms the SVG using the last transformation performed on any SVG. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformAgainIndividually(): string[]; /** * Transforms the SVG using the last sequence of transform operations performed * on any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgain(): string[]; /** * Transforms the SVG using the last sequence of transformations performed on * any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * A collection of SVG files. */ declare class SVGs { /** Returns the SVG with the specified index or name. */ [index: number]: SVG; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new SVG. * @param withProperties Initial values for properties of the new SVG (Optional) */ add(withProperties?: Object): SVG; /** * Returns any SVG in the collection. */ anyItem(): SVG; /** * Displays the number of elements in the SVG. */ count(): number; /** * Returns every SVG in the collection. */ everyItem(): SVG; /** * Returns the first SVG in the collection. */ firstItem(): SVG; /** * Returns the SVG with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): SVG; /** * Returns the SVG with the specified ID. * @param id The ID. */ itemByID(id: number): SVG; /** * Returns the SVG with the specified name. * @param name The name. */ itemByName(name: string): SVG; /** * Returns the SVGs within the specified range. * @param from The SVG, index, or name at the beginning of the range. Can accept: SVG, Long Integer or String. * @param to The SVG, index, or name at the end of the range. Can accept: SVG, Long Integer or String. */ itemByRange(from: number | SVG | string, to: number | SVG | string): SVG[]; /** * Returns the last SVG in the collection. */ lastItem(): SVG; /** * Returns the middle SVG in the collection. */ middleItem(): SVG; /** * Returns the SVG whose index follows the specified SVG in the collection. * @param obj The SVG whose index comes before the desired SVG. */ nextItem(obj: SVG): SVG; /** * Returns the SVG with the index previous to the specified index. * @param obj The index of the SVG that follows the desired SVG. */ previousItem(obj: SVG): SVG; /** * Generates a string which, if executed, will return the SVG. */ toSource(): string; } /** * The resampling method. */ declare enum Sampling { /** * Uses a weighted average to determine pixel color. */ BICUBIC_DOWNSAMPLE = 1650742125, /** * Averages the pixels in a sample area and replaces the entire area with the * average pixel color. */ DOWNSAMPLE = 1684951917, /** * Uses no resampling. */ NONE = 1852796517, /** * Chooses a pixel in the center of the sample area and replaces the entire * area with that pixel color. */ SUBSAMPLE = 1935823725, } /** * Satin effect settings. */ declare class SatinSetting extends Preference { /** * The light angle of the satin effect. (Range: -360 to 360) * @remarks Range: -180 to 180 */ angle: number; /** * If true, applies the satin effect. */ applied: boolean; /** * The blending mode for the satin effect. */ blendMode: BlendMode; /** * The distance (in pixels) from the SatinSetting to the satin effect. * @remarks Measurement unit — also accepts a string such as "12mm". */ distance: number | string; /** * The color applied to the satin effect, specified as a swatch (color, * gradient, tint, or mixed ink), a color library color, a hex value, or as an * array of color values. The color mode dictates the array values: for RGB, * specify three values, each in the range 0 to 255, in the format [R,G,B]; for * CMYK, specify four values, each as a percentage and each in the range 0 to * 100, in the format [C,M,Y,K]; for LAB, specify three values in the format * [L,A,B], with L in the range 0 to 100 and A and B in the range -128 to 127; * for HSB, specify three colors in the format [H,S,B], with H in the range 0 * to 360 and S and B as percentages in the range 0 to 100. */ effectColor: Swatch; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, inverts the satin effect. */ invertEffect: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The opacity of the satin effect (as a percentage). (Range: 0 to 100) * @remarks Range: 0 to 100 */ opacity: number; /** * The parent of the SatinSetting (a TransparencySetting, * StrokeTransparencySetting, FillTransparencySetting or * ContentTransparencySetting). */ readonly parent: FillTransparencySetting | StrokeTransparencySetting | ContentTransparencySetting | TransparencySetting; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The width (in pixels) of the satin effect. * @remarks Measurement unit — also accepts a string such as "12mm". */ size: number | string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): SatinSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the SatinSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for saving a document before closing or quitting. */ declare enum SaveOptions { /** * Displays a prompts asking whether to save changes. */ ASK = 1634954016, /** * Does not save changes. */ NO = 1852776480, /** * Saves changes. */ YES = 2036691744, } /** * Page scaling options. */ declare enum ScaleModes { /** * Scales the page to fit the paper. Note: Valid only when tile is false. */ SCALE_TO_FIT = 1935897702, /** * Scales the page width and height. */ SCALE_WIDTH_HEIGHT = 1935898745, } /** * Options for ink screening for composite gray output in PostScript or PDF * format. */ declare enum Screeening { /** * Uses custom screening settings for ink angle and frequency. For information, * see composite angle and composite frequency. */ CUSTOM = 1131639917, /** * Uses the default screening settings. */ DEFAULT_VALUE = 1147563124, } /** * Screen mode options. */ declare enum ScreenModeOptions { /** * Preview mode with editing turned off. Mouse clicks and arrow keys will move * to previous or next spread. */ PRESENTATION_PREVIEW = 1936552046, /** * Normal view; displays guides and frame edges. */ PREVIEW_OFF = 1936552047, /** * Preview mode including the bleed area. */ PREVIEW_TO_BLEED = 1936552034, /** * Preview mode; displays the document as it will be printed (hides guides and * frame edges). */ PREVIEW_TO_PAGE = 1936552048, /** * Preview mode including the slug area. */ PREVIEW_TO_SLUG = 1936552051, } /** * Arguments to pass to a script. */ declare class ScriptArg extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the ScriptArg (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Clears all script arguments. */ clear(): void; /** * Gets the value of a script argument. * @param name The name of the script argument. */ get(name: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ScriptArg[]; /** * Gets the value of a script argument. * @param name The name of the script argument. */ getValue(name: string): string; /** * Verifies whether the script argument is defined. * @param name The name of the script argument. */ isDefined(name: string): boolean; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Restores all script arguments. */ restore(): void; /** * Saves the script arguments. */ save(): void; /** * Sets the value of a script argument. * @param name The name of the script argument. * @param value The value. */ set(name: string, value: string): void; /** * Sets the value of a script argument. * @param name The name of the script argument. * @param value The value. */ setValue(name: string, value: string): void; /** * Generates a string which, if executed, will return the ScriptArg. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * The language of the script to execute. */ declare enum ScriptLanguage { /** * The AppleScript language. */ APPLESCRIPT_LANGUAGE = 1095978087, /** * The JavaScript language. */ JAVASCRIPT = 1246973031, /** * Language not specified. */ UNKNOWN = 1433299822, /** * The UxpScript language. */ UXPSCRIPT = 1431522407, /** * The VBScript language. */ VISUAL_BASIC = 1447185511, } /** * A script menu action. */ declare class ScriptMenuAction extends MenuAction { /** * The menu action area. */ area: string; /** * If true, the menu item associated with the menu action is checked. */ checked: boolean; /** * If true, the ScriptMenuAction is enabled. */ enabled: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the ScriptMenuAction. */ readonly id: number; /** * The index of the ScriptMenuAction within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the ScriptMenuAction. */ name: string; /** * The parent of the ScriptMenuAction (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The name of the ScriptMenuAction for display in the user interface. The * title includes any ampersand characters (&), which are used to tell the * Windows OS to underline the following character in the name for use with the * Alt key to navigate to a menu item. Double ampersands are used to display an * actual ampersand character in the name. The Mac OS ignores and removes the * extra ampersand characters. */ title: string; /** * Dispatched after the ScriptMenuAction is invoked. This event does not * bubble. This event is not cancelable. */ static readonly AFTER_INVOKE: string; /** * Dispatched before the ScriptMenuAction is displayed. This event does not * bubble. This event is not cancelable. */ static readonly BEFORE_DISPLAY: string; /** * Dispatched before the ScriptMenuAction is invoked. This event does not * bubble. This event is cancelable. */ static readonly BEFORE_INVOKE: string; /** * Dispatched when the ScriptMenuAction is invoked. This event does not bubble. * This event is not cancelable. */ static readonly ON_INVOKE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ScriptMenuAction[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Invoke the action. */ invoke(): void; /** * Deletes the ScriptMenuAction. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ScriptMenuAction. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of script menu actions. */ declare class ScriptMenuActions { /** Returns the ScriptMenuAction with the specified index or name. */ [index: number]: ScriptMenuAction; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new action. * @param title The name of the ScriptMenuAction for display in the user interface. The title includes any ampersand characters (&), which are used to tell the Windows OS to underline the following character in the name for use with the Alt key to navigate to a menu item. Double ampersands are used to display an actual ampersand character in the name. The Mac OS ignores and removes the extra ampersand characters. (Optional) * @param withProperties Initial values for properties of the new ScriptMenuAction (Optional) */ add(title?: string, withProperties?: Object): ScriptMenuAction; /** * Returns any ScriptMenuAction in the collection. */ anyItem(): ScriptMenuAction; /** * Displays the number of elements in the ScriptMenuAction. */ count(): number; /** * Returns every ScriptMenuAction in the collection. */ everyItem(): ScriptMenuAction; /** * Returns the first ScriptMenuAction in the collection. */ firstItem(): ScriptMenuAction; /** * Returns the ScriptMenuAction with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): ScriptMenuAction; /** * Returns the ScriptMenuAction with the specified ID. * @param id The ID. */ itemByID(id: number): ScriptMenuAction; /** * Returns the ScriptMenuAction with the specified name. * @param name The name. */ itemByName(name: string): ScriptMenuAction; /** * Returns the ScriptMenuActions within the specified range. * @param from The ScriptMenuAction, index, or name at the beginning of the range. Can accept: ScriptMenuAction, Long Integer or String. * @param to The ScriptMenuAction, index, or name at the end of the range. Can accept: ScriptMenuAction, Long Integer or String. */ itemByRange(from: number | ScriptMenuAction | string, to: number | ScriptMenuAction | string): ScriptMenuAction[]; /** * Returns the last ScriptMenuAction in the collection. */ lastItem(): ScriptMenuAction; /** * Returns the middle ScriptMenuAction in the collection. */ middleItem(): ScriptMenuAction; /** * Returns the ScriptMenuAction whose index follows the specified * ScriptMenuAction in the collection. * @param obj The ScriptMenuAction whose index comes before the desired ScriptMenuAction. */ nextItem(obj: ScriptMenuAction): ScriptMenuAction; /** * Returns the ScriptMenuAction with the index previous to the specified index. * @param obj The index of the ScriptMenuAction that follows the desired ScriptMenuAction. */ previousItem(obj: ScriptMenuAction): ScriptMenuAction; /** * Generates a string which, if executed, will return the ScriptMenuAction. */ toSource(): string; } /** * Scripting environment preferences. */ declare class ScriptPreference extends Preference { /** * If true, enables redraw during script execution. */ enableRedraw: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The measurement unit used during script processing. Can return: AutoEnum * enumerator or MeasurementUnits enumerator. */ measurementUnit: AutoEnum | MeasurementUnits; /** * The parent of the ScriptPreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The path to the Scripts folder for the application. */ readonly scriptsFolder: Folder; /** * A list of the scripts in the Scripts folder. Can return: Array of Array of 2 * Strings or Files. */ readonly scriptsList: (string[][] | File[])[]; /** * Controls the display of dialogs and alerts during script processing. */ userInteractionLevel: UserInteractionLevels; /** * The version of the scripting environment. Can also accept: Real. */ version: string | number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ScriptPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ScriptPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Search mode options. */ declare enum SearchModes { /** * Color search. */ COLOR_SEARCH = 1180921708, /** * Glyph search. */ GLYPH_SEARCH = 1181183091, /** * Grep search. */ GREP_SEARCH = 1181184627, /** * Object search. */ OBJECT_SEARCH = 1181704819, /** * Text search. */ TEXT_SEARCH = 1182038131, } /** * Search strategy options. */ declare enum SearchStrategies { /** * Searches forward from the start of the current page. */ FIRST_ON_PAGE = 1396794992, /** * Search backward from the end of the current page. */ LAST_ON_PAGE = 1396796528, } /** * A section. */ declare class Section { /** * The alternate layout name for a set of pages. */ alternateLayout: string; /** * The number of pages in the alternate layout section. */ readonly alternateLayoutLength: number; /** * If true, continues page numbers sequentially from the previous section. */ continueNumbering: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the Section. */ readonly id: number; /** * If true, places the specified prefix before page numbers on all pages in the * section. */ includeSectionPrefix: boolean; /** * The index of the Section within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The number of pages in the section. */ readonly length: number; /** * The section marker. */ marker: string; /** * The name of the Section. */ name: string; /** * The page number assigned to the first page in the section. Note: Valid only * when continue numbering is false. * @remarks Range: 1 to 999999 */ pageNumberStart: number; /** * The page number style. Can return: PageNumberStyle enumerator or String. */ pageNumberStyle: PageNumberStyle | string; /** * The start page for the section. */ pageStart: Page; /** * The parent of the Section (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The prefix to place before page numbers on pages in the section. May include * up to 8 characters. Note: Valid only when include section prefix is true. */ sectionPrefix: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Section[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the Section. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Section. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of sections. */ declare class Sections { /** Returns the Section with the specified index or name. */ [index: number]: Section; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new section. * @param reference The page on which the section begins. (Optional) * @param withProperties Initial values for properties of the new Section (Optional) */ add(reference?: Page, withProperties?: Object): Section; /** * Returns any Section in the collection. */ anyItem(): Section; /** * Displays the number of elements in the Section. */ count(): number; /** * Returns every Section in the collection. */ everyItem(): Section; /** * Returns the first Section in the collection. */ firstItem(): Section; /** * Returns the Section with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Section; /** * Returns the Section with the specified ID. * @param id The ID. */ itemByID(id: number): Section; /** * Returns the Section with the specified name. * @param name The name. */ itemByName(name: string): Section; /** * Returns the Sections within the specified range. * @param from The Section, index, or name at the beginning of the range. Can accept: Section, Long Integer or String. * @param to The Section, index, or name at the end of the range. Can accept: Section, Long Integer or String. */ itemByRange(from: number | Section | string, to: number | Section | string): Section[]; /** * Returns the last Section in the collection. */ lastItem(): Section; /** * Returns the middle Section in the collection. */ middleItem(): Section; /** * Returns the Section whose index follows the specified Section in the * collection. * @param obj The Section whose index comes before the desired Section. */ nextItem(obj: Section): Section; /** * Returns the Section with the index previous to the specified index. * @param obj The index of the Section that follows the desired Section. */ previousItem(obj: Section): Section; /** * Generates a string which, if executed, will return the Section. */ toSource(): string; } /** * Selection options. */ declare enum SelectAll { /** * Selects all. */ ALL = 1634495520, } /** * Options for selection status in relation to previously selected objects. */ declare enum SelectionOptions { /** * Adds the object to the existing selection; if no object was previously * selected, makes the object the only selected object. */ ADD_TO = 1633969202, /** * Deselects the object. */ REMOVE_FROM = 1919249734, /** * Selects the object and deselects any previously selected objects. */ REPLACE_WITH = 1919250519, /** * Sets the key object. At least 2 objects must be selected, and the key object * specified must be one of them. */ SET_KEY = 1936028779, } /** * Options for printing page sequences. */ declare enum Sequences { /** * Prints all pages. */ ALL = 1634495520, /** * Prints only even-numbered pages. */ EVEN = 1702258030, /** * Prints only odd-numbered pages. */ ODD = 1868850208, } /** * Shadow mode options. */ declare enum ShadowMode { /** * Uses a standard blurred drop shadow. */ DROP = 2020623440, /** * Does not use a shadow. */ NONE = 1852796517, } /** * A show/hide fields behavior object. */ declare class ShowHideFieldsBehavior extends Behavior { /** * The event which triggers the behavior. */ behaviorEvent: BehaviorEvents; /** * If true, the behavior is enabled. */ enableBehavior: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The hidden interactive objects. Can return: Array of Buttons, CheckBoxes, * ComboBoxes, ListBoxes, RadioButtons, TextBoxes or SignatureFields. */ fieldsToHide: (Buttons | CheckBoxes | ComboBoxes | ListBoxes | RadioButtons | TextBoxes | SignatureFields)[]; /** * The visible interactive objects. Can return: Array of Buttons, CheckBoxes, * ComboBoxes, ListBoxes, RadioButtons, TextBoxes or SignatureFields. */ fieldsToShow: (Buttons | CheckBoxes | ComboBoxes | ListBoxes | RadioButtons | TextBoxes | SignatureFields)[]; /** * The unique ID of the ShowHideFieldsBehavior. */ readonly id: number; /** * The index of the ShowHideFieldsBehavior within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the ShowHideFieldsBehavior. */ readonly name: string; /** * The parent of the ShowHideFieldsBehavior (a Button, CheckBox, ComboBox, * ListBox, RadioButton, TextBox or SignatureField). */ readonly parent: CheckBox | ComboBox | ListBox | RadioButton | TextBox | Button | SignatureField; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ShowHideFieldsBehavior[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the ShowHideFieldsBehavior. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * ShowHideFieldsBehavior. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of show/hide fields behavior objects. */ declare class ShowHideFieldsBehaviors { /** Returns the ShowHideFieldsBehavior with the specified index or name. */ [index: number]: ShowHideFieldsBehavior; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new ShowHideFieldsBehavior. * @param withProperties Initial values for properties of the new ShowHideFieldsBehavior (Optional) */ add(withProperties?: Object): ShowHideFieldsBehavior; /** * Returns any ShowHideFieldsBehavior in the collection. */ anyItem(): ShowHideFieldsBehavior; /** * Displays the number of elements in the ShowHideFieldsBehavior. */ count(): number; /** * Returns every ShowHideFieldsBehavior in the collection. */ everyItem(): ShowHideFieldsBehavior; /** * Returns the first ShowHideFieldsBehavior in the collection. */ firstItem(): ShowHideFieldsBehavior; /** * Returns the ShowHideFieldsBehavior with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): ShowHideFieldsBehavior; /** * Returns the ShowHideFieldsBehavior with the specified ID. * @param id The ID. */ itemByID(id: number): ShowHideFieldsBehavior; /** * Returns the ShowHideFieldsBehavior with the specified name. * @param name The name. */ itemByName(name: string): ShowHideFieldsBehavior; /** * Returns the ShowHideFieldsBehaviors within the specified range. * @param from The ShowHideFieldsBehavior, index, or name at the beginning of the range. Can accept: ShowHideFieldsBehavior, Long Integer or String. * @param to The ShowHideFieldsBehavior, index, or name at the end of the range. Can accept: ShowHideFieldsBehavior, Long Integer or String. */ itemByRange(from: number | ShowHideFieldsBehavior | string, to: number | ShowHideFieldsBehavior | string): ShowHideFieldsBehavior[]; /** * Returns the last ShowHideFieldsBehavior in the collection. */ lastItem(): ShowHideFieldsBehavior; /** * Returns the middle ShowHideFieldsBehavior in the collection. */ middleItem(): ShowHideFieldsBehavior; /** * Returns the ShowHideFieldsBehavior whose index follows the specified * ShowHideFieldsBehavior in the collection. * @param obj The ShowHideFieldsBehavior whose index comes before the desired ShowHideFieldsBehavior. */ nextItem(obj: ShowHideFieldsBehavior): ShowHideFieldsBehavior; /** * Returns the ShowHideFieldsBehavior with the index previous to the specified * index. * @param obj The index of the ShowHideFieldsBehavior that follows the desired ShowHideFieldsBehavior. */ previousItem(obj: ShowHideFieldsBehavior): ShowHideFieldsBehavior; /** * Generates a string which, if executed, will return the * ShowHideFieldsBehavior. */ toSource(): string; } /** * A signature field. */ declare class SignatureField extends FormField { /** * Indicates whether the SignatureField has been flipped independently of its * parent object and, if yes, the direction in which the SignatureField was * flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the SignatureField relative to its containing * object. */ absoluteHorizontalScale: number; /** * The rotation angle of the SignatureField relative to its containing object. * (Range: -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the SignatureField relative to its containing object. * (Range: -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the SignatureField relative to its containing object. */ absoluteVerticalScale: number; /** * The index of the active state in the object's states collection. */ activeStateIndex: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the SignatureField. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the SignatureField. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * Anchored object settings. */ readonly anchoredObjectSettings: AnchoredObjectSetting; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the SignatureField. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the SignatureField. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the SignatureField. */ readonly associatedXMLElement: XMLItem; /** * A collection of behavior objects. */ readonly behaviors: Behaviors; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * A collection of clear form behavior objects. */ readonly clearFormBehaviors: ClearFormBehaviors; /** * Transparency settings for the content of the SignatureField. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The description of the SignatureField. */ description: string; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the SignatureField. */ endJoin: EndJoin; /** * A collection of EPS files. */ readonly epss: EPSs; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * SignatureField. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the SignatureField's fill color. (To specify a * tint percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the SignatureField. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the SignatureField excluding the stroke width, in the format * [y1, x1, y2, x2], which give the coordinates of the top-left and * bottom-right corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * A collection of goto anchor behavior objects. */ readonly gotoAnchorBehaviors: GotoAnchorBehaviors; /** * A collection of goto first page behavior objects. */ readonly gotoFirstPageBehaviors: GotoFirstPageBehaviors; /** * A collection of goto last page behavior objects. */ readonly gotoLastPageBehaviors: GotoLastPageBehaviors; /** * A collection of goto next page behavior objects. */ readonly gotoNextPageBehaviors: GotoNextPageBehaviors; /** * A collection of goto next view behavior objects. */ readonly gotoNextViewBehaviors: GotoNextViewBehaviors; /** * A collection of goto previous page behavior objects. */ readonly gotoPreviousPageBehaviors: GotoPreviousPageBehaviors; /** * A collection of goto previous view behavior objects. */ readonly gotoPreviousViewBehaviors: GotoPreviousViewBehaviors; /** * A collection of goto URL behavior objects. */ readonly gotoURLBehaviors: GotoURLBehaviors; /** * The angle of a linear gradient applied to the fill of the SignatureField. * (Range: -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the SignatureField. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the SignatureField, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the SignatureField. * (Range: -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the SignatureField. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the SignatureField, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * A collection of groups. */ readonly groups: Groups; /** * If true, the form field/push button is hidden until triggered in the * exported PDF. */ hiddenUntilTriggered: boolean; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the SignatureField. */ horizontalScale: number; /** * The unique ID of the SignatureField. */ readonly id: number; /** * A collection of bitmap images in any bitmap file format (including TIFF, * JPEG, or GIF). */ readonly images: Images; /** * The index of the SignatureField within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the SignatureField is on. */ itemLayer: Layer; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the SignatureField. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the SignatureField is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * A collection of movie behavior objects. */ readonly movieBehaviors: MovieBehaviors; /** * The name of the SignatureField. */ name: string; /** * If true, the SignatureField does not print. */ nonprinting: boolean; /** * A collection of open file behavior objects. */ readonly openFileBehaviors: OpenFileBehaviors; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the SignatureField's fill color overprints any underlying objects. * If false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the SignatureField's stroke color overprints any underlying * objects. If false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the SignatureField (a Snippet, PlaceGun, FlexObject, * Character, Spread, MasterSpread, SplineItem, Polygon, GraphicLine, * Rectangle, Oval or Group). */ readonly parent: Character | FlexObject | GraphicLine | MasterSpread | Oval | PlaceGun | Polygon | Rectangle | SplineItem | Spread | Group | Snippet; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of PDF files. */ readonly pdfs: PDFs; /** * A collection of PICT graphics. */ readonly picts: PICTs; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A collection of print form behavior objects. */ readonly printFormBehaviors: PrintFormBehaviors; /** * If true, the form field/push button is printable in the exported PDF. */ printableInPdf: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, the form field is read only in the exported PDF. */ readOnly: boolean; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * If true, the form field is required in the exported PDF. */ required: boolean; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the SignatureField. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the SignatureField. (Range: -360 to 360) */ shearAngle: number; /** * A collection of show/hide fields behavior objects. */ readonly showHideFieldsBehaviors: ShowHideFieldsBehaviors; /** * A collection of sound behavior objects. */ readonly soundBehaviors: SoundBehaviors; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The stroke alignment applied to the SignatureField. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the SignatureField. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the SignatureField. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the SignatureField's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of submit form behavior objects. */ readonly submitFormBehaviors: SubmitFormBehaviors; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the SignatureField. */ verticalScale: number; /** * A collection of view zoom behavior objects. */ readonly viewZoomBehaviors: ViewZoomBehaviors; /** * If true, the SignatureField is visible. */ visible: boolean; /** * The bounds of the SignatureField including the stroke width, in the format * [y1, x1, y2, x2], which give the coordinates of the top-left and * bottom-right corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * A collection of WMF graphics. */ readonly wmfs: WMFs; /** * Dispatched after a SignatureField is placed. This event bubbles. This event * is not cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a SignatureField is placed. This event bubbles. This event * is cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the SignatureField's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the SignatureField that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Brings the SignatureField forward one level in its layer. */ bringForward(): void; /** * Brings the SignatureField to the front of its layer or in front of a * particular item. * @param reference The reference object to bring the object in front of (must have same parent) (Optional) */ bringToFront(reference?: PageItem): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the SignatureField. Transformations include * rotation, scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the SignatureField to a different shape. * @param given The SignatureField's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Converts the button object to the page item currently in the active state. * Page items from other states will be lost. */ convertToObject(): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new SignatureField. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new SignatureField. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new SignatureField. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new SignatureField. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new SignatureField. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the SignatureField at the specified location or offset. * @param to The location of the new SignatureField, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new SignatureField from the original SignatureField's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the SignatureField. * @param given The axis around which to flip the SignatureField. * @param around The point around which to flip the SignatureField. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): SignatureField[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the SignatureField to a new location. Note: Either the 'to' or 'by' * parameter is required; if both parameters are defined, only the to value is * used. * @param to The new location of the SignatureField,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the SignatureField relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the SignatureField. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the SignatureField in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Sends the SignatureField back one level in its layer. */ sendBackward(): void; /** * Sends the SignatureField to the back of its layer or behind a particular * item (must have same parent). * @param reference The reference object to send the object behind (Optional) */ sendToBack(reference?: PageItem): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new SignatureField (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the SignatureField. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the SignatureField using the last transformation performed on any * object. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgain(): string[]; /** * Transforms the SignatureField using the last transformation performed on any * SignatureField. Transformations include moving, rotating, shearing, scaling, * and flipping. */ transformAgainIndividually(): string[]; /** * Transforms the SignatureField using the last sequence of transform * operations performed on any single object or performed at the same time on * any group of objects. Transformations include moving, rotating, shearing, * scaling, and flipping. */ transformSequenceAgain(): string[]; /** * Transforms the SignatureField using the last sequence of transformations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * A collection of signature fields. */ declare class SignatureFields { /** Returns the SignatureField with the specified index or name. */ [index: number]: SignatureField; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new SignatureField * @param layer The layer on which to create the SignatureField. (Optional) * @param at The location at which to insert the SignatureField relative to the reference object or within the container object. (Optional) * @param reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) * @param withProperties Initial values for properties of the new SignatureField (Optional) */ add(layer?: Layer, at?: LocationOptions, reference?: Document | Layer | MasterSpread | Page | Spread | PageItem, withProperties?: Object): SignatureField; /** * Returns any SignatureField in the collection. */ anyItem(): SignatureField; /** * Displays the number of elements in the SignatureField. */ count(): number; /** * Returns every SignatureField in the collection. */ everyItem(): SignatureField; /** * Returns the first SignatureField in the collection. */ firstItem(): SignatureField; /** * Returns the SignatureField with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): SignatureField; /** * Returns the SignatureField with the specified ID. * @param id The ID. */ itemByID(id: number): SignatureField; /** * Returns the SignatureField with the specified name. * @param name The name. */ itemByName(name: string): SignatureField; /** * Returns the SignatureFields within the specified range. * @param from The SignatureField, index, or name at the beginning of the range. Can accept: SignatureField, Long Integer or String. * @param to The SignatureField, index, or name at the end of the range. Can accept: SignatureField, Long Integer or String. */ itemByRange(from: number | SignatureField | string, to: number | SignatureField | string): SignatureField[]; /** * Returns the last SignatureField in the collection. */ lastItem(): SignatureField; /** * Returns the middle SignatureField in the collection. */ middleItem(): SignatureField; /** * Returns the SignatureField whose index follows the specified SignatureField * in the collection. * @param obj The SignatureField whose index comes before the desired SignatureField. */ nextItem(obj: SignatureField): SignatureField; /** * Returns the SignatureField with the index previous to the specified index. * @param obj The index of the SignatureField that follows the desired SignatureField. */ previousItem(obj: SignatureField): SignatureField; /** * Generates a string which, if executed, will return the SignatureField. */ toSource(): string; } /** * Signature size options. */ declare enum SignatureSizeOptions { /** * Signature size 12. */ SIGNATURE_SIZE_12 = 1112748338, /** * Signature size 16. */ SIGNATURE_SIZE_16 = 1112748342, /** * Signature size 32. */ SIGNATURE_SIZE_32 = 1112748850, /** * Signature size 4. */ SIGNATURE_SIZE_4 = 1112748084, /** * Signature size 8. */ SIGNATURE_SIZE_8 = 1112748088, } /** * Alignment options for lines that contain a single word. */ declare enum SingleWordJustification { /** * Center aligns the word. */ CENTER_ALIGN = 1667591796, /** * Fully justifies the word. */ FULLY_JUSTIFIED = 1718971500, /** * Left aligns the word. */ LEFT_ALIGN = 1818584692, /** * Right aligns the word. */ RIGHT_ALIGN = 1919379572, } /** * size type options. */ declare enum SizeTypeEnum { /** * Default size. */ DEFAULT_SIZE = 1147491177, /** * Fixed size. */ FIXED_SIZE = 1181317203, /** * None size. */ NONE_SIZE = 1315925587, /** * Relative to text flow. */ RELATIVE_TO_TEXT_FLOW = 1383289940, /** * Relative to text size. */ RELATIVE_TO_TEXT_SIZE = 1383486579, /** * Use custom height. */ USE_CUSTOM_HEIGHT = 1430472805, /** * Use custom width. */ USE_CUSTOM_WIDTH = 1430476649, } /** * Smart Guide preferences. */ declare class SmartGuidePreference extends Preference { /** * If true, smart alignment to object centers is enabled. */ alignToObjectCenter: boolean; /** * If true, smart alignment to object edges is enabled. */ alignToObjectEdges: boolean; /** * If true, smart guides are enabled. */ enabled: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The color of the guide, specified either as an array of three doubles, each * in the range 0 to 255 and representing R, G, and B values, or as a UI color. * Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. */ guideColor: (number[][] | UIColors)[]; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the SmartGuidePreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, smart dimensions guides are enabled. */ smartDimensions: boolean; /** * If true, smart spacing guides are enabled. */ smartSpacing: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): SmartGuidePreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the SmartGuidePreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for matching names when synchronizing styles in a book. */ declare enum SmartMatchOptions { /** * Match only the style name while finding styles in target. */ MATCH_STYLE_NAME = 1936552814, /** * Match the full path of style while finding styles in target. */ MATCH_STYLE_PATH = 1936549488, } /** * The smooth scrolling option. */ declare enum SmoothScrollingOptions { /** * horizontal smooth scrolling. */ HORIZONTAL = 1752134266, /** * no smooth scrolling. */ NO_SMOOTH_SCROLL = 1699959662, /** * vertical smooth scrolling. */ VERTICAL = 1986359924, /** * vertical and horizontal smooth scrolling. */ VERTICAL_AND_HORIZONTAL = 1699959650, } /** * Modes that control which nearby snapshots, by size and shape, are blended * into the new layout. */ declare enum SnapshotBlendingModes { /** * Use up to three nearest snapshots even if a snapshot is in a different class * that the new layout. */ FULL_SNAPSHOT_BLENDING = 1399735925, /** * Turns off the influence of layout snapshots completely. */ IGNORE_LAYOUT_SNAPSHOTS = 1399736679, /** * Use only layout snapshots within the same class as the new layout. */ LIMITED_SNAPSHOT_BLENDING = 1399737449, /** * Use the layout snapshot nearest in size and shape to the new layout. */ USE_NEAREST_SNAPSHOT = 1399737957, } /** * An IDML snippet. */ declare class Snippet { /** * A collection of buttons. */ readonly buttons: Buttons; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * A collection of EPS files. */ readonly epss: EPSs; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * A collection of form fields. */ readonly formFields: FormFields; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * A collection of groups. */ readonly groups: Groups; /** * The unique ID of the Snippet. */ readonly id: number; /** * A collection of bitmap images in any bitmap file format (including TIFF, * JPEG, or GIF). */ readonly images: Images; /** * The index of the Snippet within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * The name of the Snippet; this is an alias to the Snippet's label property. */ name: string; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the Snippet (a PlaceGun). */ readonly parent: PlaceGun; /** * A collection of PDF files. */ readonly pdfs: PDFs; /** * A collection of PICT graphics. */ readonly picts: PICTs; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * A collection of WMF graphics. */ readonly wmfs: WMFs; /** * Dispatched before a Snippet is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Snippet[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the Snippet. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Snippet. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of IDML snippets. */ declare class Snippets { /** Returns the Snippet with the specified index or name. */ [index: number]: Snippet; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Snippet in the collection. */ anyItem(): Snippet; /** * Displays the number of elements in the Snippet. */ count(): number; /** * Returns every Snippet in the collection. */ everyItem(): Snippet; /** * Returns the first Snippet in the collection. */ firstItem(): Snippet; /** * Returns the Snippet with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Snippet; /** * Returns the Snippet with the specified ID. * @param id The ID. */ itemByID(id: number): Snippet; /** * Returns the Snippet with the specified name. * @param name The name. */ itemByName(name: string): Snippet; /** * Returns the Snippets within the specified range. * @param from The Snippet, index, or name at the beginning of the range. Can accept: Snippet, Long Integer or String. * @param to The Snippet, index, or name at the end of the range. Can accept: Snippet, Long Integer or String. */ itemByRange(from: number | Snippet | string, to: number | Snippet | string): Snippet[]; /** * Returns the last Snippet in the collection. */ lastItem(): Snippet; /** * Returns the middle Snippet in the collection. */ middleItem(): Snippet; /** * Returns the Snippet whose index follows the specified Snippet in the * collection. * @param obj The Snippet whose index comes before the desired Snippet. */ nextItem(obj: Snippet): Snippet; /** * Returns the Snippet with the index previous to the specified index. * @param obj The index of the Snippet that follows the desired Snippet. */ previousItem(obj: Snippet): Snippet; /** * Generates a string which, if executed, will return the Snippet. */ toSource(): string; } /** * Creates a TCP/IP connection, or establishes a TCP/IP server. */ declare class Socket { /** * When true, the connection is active. */ readonly connected: boolean; /** * Sets or retrieves the name of the encoding used to transmit data. */ encoding: string; /** * When true, the receive buffer is empty. */ readonly eof: boolean; /** * A message describing the most recent error. Setting this value clears any * error message. */ error: string; /** * The name of the remote computer when a connection is established. */ readonly host: string; /** * The timeout in seconds to be applied to read or write operations. */ timeout: number; /** * Creates a new Socket object. */ constructor(); /** * Terminates the open connection. */ close(): boolean; /** * Instructs the object to start listening for an incoming connection. * @param port The TCP/IP port number to listen on. * @param encoding The encoding to be used for the connection */ listen(port: number, encoding?: string): boolean; /** * Opens the connection for subsequent read/write operations. * @param host The server to connect to. * @param encoding The encoding to be used for the connection */ open(host: string, encoding?: string): boolean; /** * Checks a listening object for a new incoming connection. */ poll(): Socket; /** * Reads up to the specified number of characters from the connection. CR * characters are ignored unless the encoding is set to "BINARY". * @param count The number of characters to read. */ read(count?: number): string; /** * Reads one line of text up to the next line feed. */ readln(): string; /** * Concatenates all arguments into a single string and writes that string to * the connection. * @param text Any number of string values. All arguments are concatenated to form the string to be written. CRLF sequences are converted to LFs unless the encoding is set to "BINARY". */ write(text: string): boolean; /** * Concatenates all arguments into a single string, appends a LF character, and * writes that string to the connection. * @param text Any number of string values. All arguments are concatenated to form the string to be written. CRLF sequences are converted to LFs unless the encoding is set to "BINARY". */ writeln(text: string): boolean; } /** * Sort order options */ declare enum SortAssets { /** * Sort by name */ BY_NAME = 1699955278, /** * Sort newest first */ BY_NEWEST = 1699955310, /** * Sort oldest first */ BY_OLDEST = 1699955279, /** * Sort by type */ BY_TYPE = 1699955284, } /** * A sound clip. */ declare class Sound extends MediaItem { /** * Indicates whether the Sound has been flipped independently of its parent * object and, if yes, the direction in which the Sound was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the Sound relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the Sound relative to its containing object. (Range: * -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the Sound relative to its containing object. (Range: * -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the Sound relative to its containing object. */ absoluteVerticalScale: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the Sound. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the Sound. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the Sound. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the Sound. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the Sound. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * Transparency settings for the content of the Sound. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The description of the Sound. */ description: string; /** * If true, the sound poster does not print with the document. */ doNotPrintPoster: boolean; /** * If true, the file is embedded in the PDF. If false, the file is linked to * the PDF. Note: To embed movie files, acrobat compatibility must be acrobat 6 * or higher. */ embedInPDF: boolean; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the Sound. */ endJoin: EndJoin; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The file path (colon delimited on the Mac OS). Can also accept: File. */ filePath: string | File; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * Sound. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the Sound's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the Sound. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the Sound excluding the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the Sound. (Range: * -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the Sound. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the Sound, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the Sound. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the Sound. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the Sound, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the Sound. */ horizontalScale: number; /** * The unique ID of the Sound. */ readonly id: number; /** * A collection of bitmap images in any bitmap file format (including TIFF, * JPEG, or GIF). */ readonly images: Images; /** * The index of the Sound within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the Sound is on. */ itemLayer: Layer; /** * The source file of the link. */ readonly itemLink: Link; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the Sound. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the Sound is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * The name of the Sound. */ name: string; /** * If true, the Sound does not print. */ nonprinting: boolean; /** * If true, the Sound's fill color overprints any underlying objects. If false, * the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the Sound's stroke color overprints any underlying objects. If * false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the Sound (a SplineItem, Polygon, GraphicLine, Rectangle or * Oval). */ readonly parent: GraphicLine | Polygon | Rectangle | Oval | SplineItem; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of paths. */ readonly paths: Paths; /** * If true, the movie plays automatically when a user views the page that * contains the movie poster in the PDF document. */ playOnPageTurn: boolean; /** * The poster file. */ posterFile: string; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the Sound. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the Sound. (Range: -360 to 360) */ shearAngle: number; /** * If true, sound loops forever. */ soundLoop: boolean; /** * The type of sound poster. */ soundPosterType: SoundPosterTypes; /** * If true, sounds stops playing when its page turns. */ stopOnPageTurn: boolean; /** * The stroke alignment applied to the Sound. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the Sound. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the Sound. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the Sound's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the Sound. */ verticalScale: number; /** * If true, the Sound is visible. */ visible: boolean; /** * The bounds of the Sound including the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * Dispatched when the value of a property changes on this Sound. This event * bubbles. This event is not cancelable. */ static readonly AFTER_ATTRIBUTE_CHANGED: string; /** * Dispatched after a Sound is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a Sound is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the Sound's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the Sound that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Brings the Sound forward one level in its layer. */ bringForward(): void; /** * Brings the Sound to the front of its layer or in front of a particular item. * @param reference The reference object to bring the object in front of (must have same parent) (Optional) */ bringToFront(reference?: PageItem): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the Sound. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the Sound to a different shape. * @param given The Sound's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Sound. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Sound. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Sound. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Sound. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Sound. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the Sound. */ duplicate(): Sound; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the Sound. * @param given The axis around which to flip the Sound. * @param around The point around which to flip the Sound. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Sound[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the Sound to a new location. Note: Either the 'to' or 'by' parameter * is required; if both parameters are defined, only the to value is used. * @param to The new location of the Sound,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the Sound relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the Sound. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the Sound in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Sends the Sound back one level in its layer. */ sendBackward(): void; /** * Sends the Sound to the back of its layer or behind a particular item (must * have same parent). * @param reference The reference object to send the object behind (Optional) */ sendToBack(reference?: PageItem): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new Sound (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the Sound. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the Sound using the last transformation performed on any object. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformAgain(): string[]; /** * Transforms the Sound using the last transformation performed on any Sound. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformAgainIndividually(): string[]; /** * Transforms the Sound using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the Sound using the last sequence of transformations performed on * any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * A sound behavior object. */ declare class SoundBehavior extends Behavior { /** * The event which triggers the behavior. */ behaviorEvent: BehaviorEvents; /** * If true, the behavior is enabled. */ enableBehavior: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the SoundBehavior. */ readonly id: number; /** * The index of the SoundBehavior within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the SoundBehavior. */ readonly name: string; /** * The playback mode. */ operation: PlayOperations; /** * The parent of the SoundBehavior (a Button, CheckBox, ComboBox, ListBox, * RadioButton, TextBox or SignatureField). */ readonly parent: CheckBox | ComboBox | ListBox | RadioButton | TextBox | Button | SignatureField; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The sound page item. */ soundItem: Sound; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): SoundBehavior[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the SoundBehavior. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the SoundBehavior. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of sound behavior objects. */ declare class SoundBehaviors { /** Returns the SoundBehavior with the specified index or name. */ [index: number]: SoundBehavior; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new SoundBehavior. * @param withProperties Initial values for properties of the new SoundBehavior (Optional) */ add(withProperties?: Object): SoundBehavior; /** * Returns any SoundBehavior in the collection. */ anyItem(): SoundBehavior; /** * Displays the number of elements in the SoundBehavior. */ count(): number; /** * Returns every SoundBehavior in the collection. */ everyItem(): SoundBehavior; /** * Returns the first SoundBehavior in the collection. */ firstItem(): SoundBehavior; /** * Returns the SoundBehavior with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): SoundBehavior; /** * Returns the SoundBehavior with the specified ID. * @param id The ID. */ itemByID(id: number): SoundBehavior; /** * Returns the SoundBehavior with the specified name. * @param name The name. */ itemByName(name: string): SoundBehavior; /** * Returns the SoundBehaviors within the specified range. * @param from The SoundBehavior, index, or name at the beginning of the range. Can accept: SoundBehavior, Long Integer or String. * @param to The SoundBehavior, index, or name at the end of the range. Can accept: SoundBehavior, Long Integer or String. */ itemByRange(from: number | SoundBehavior | string, to: number | SoundBehavior | string): SoundBehavior[]; /** * Returns the last SoundBehavior in the collection. */ lastItem(): SoundBehavior; /** * Returns the middle SoundBehavior in the collection. */ middleItem(): SoundBehavior; /** * Returns the SoundBehavior whose index follows the specified SoundBehavior in * the collection. * @param obj The SoundBehavior whose index comes before the desired SoundBehavior. */ nextItem(obj: SoundBehavior): SoundBehavior; /** * Returns the SoundBehavior with the index previous to the specified index. * @param obj The index of the SoundBehavior that follows the desired SoundBehavior. */ previousItem(obj: SoundBehavior): SoundBehavior; /** * Generates a string which, if executed, will return the SoundBehavior. */ toSource(): string; } /** * Sound poster graphics options. */ declare enum SoundPosterTypes { /** * No sound poster. */ NONE = 1852796517, /** * Proxy image sound poster. */ PROXY_IMAGE = 1299216505, /** * Generic sound poster. */ STANDARD = 2020623970, } /** * A collection of sound clips. */ declare class Sounds { /** Returns the Sound with the specified index or name. */ [index: number]: Sound; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new Sound * @param layer The layer on which to create the Sound. (Optional) * @param at The location at which to insert the Sound relative to the reference object or within the container object. (Optional) * @param reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) * @param withProperties Initial values for properties of the new Sound (Optional) */ add(layer?: Layer, at?: LocationOptions, reference?: Document | Layer | MasterSpread | Page | Spread | PageItem, withProperties?: Object): Sound; /** * Returns any Sound in the collection. */ anyItem(): Sound; /** * Displays the number of elements in the Sound. */ count(): number; /** * Returns every Sound in the collection. */ everyItem(): Sound; /** * Returns the first Sound in the collection. */ firstItem(): Sound; /** * Returns the Sound with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Sound; /** * Returns the Sound with the specified ID. * @param id The ID. */ itemByID(id: number): Sound; /** * Returns the Sound with the specified name. * @param name The name. */ itemByName(name: string): Sound; /** * Returns the Sounds within the specified range. * @param from The Sound, index, or name at the beginning of the range. Can accept: Sound, Long Integer or String. * @param to The Sound, index, or name at the end of the range. Can accept: Sound, Long Integer or String. */ itemByRange(from: number | Sound | string, to: number | Sound | string): Sound[]; /** * Returns the last Sound in the collection. */ lastItem(): Sound; /** * Returns the middle Sound in the collection. */ middleItem(): Sound; /** * Returns the Sound whose index follows the specified Sound in the collection. * @param obj The Sound whose index comes before the desired Sound. */ nextItem(obj: Sound): Sound; /** * Returns the Sound with the index previous to the specified index. * @param obj The index of the Sound that follows the desired Sound. */ previousItem(obj: Sound): Sound; /** * Generates a string which, if executed, will return the Sound. */ toSource(): string; } /** * Data type options for data merge fields. */ declare enum SourceFieldType { /** * The field can fill a data merge image placeholder. */ IMAGE_FIELD = 1684883814, /** * The field can fill a data merge QR code placeholder. */ QRCODE_FIELD = 1684885862, /** * The field can fill a data merge text placeholder. */ TEXT_FIELD = 1684886630, } /** * Color-management system source options. */ declare enum SourceSpaces { /** * Uses the color space of the proof. */ PROOF_SPACE = 1886548848, /** * Uses the color space of the document. */ USE_DOCUMENT = 1967419235, } /** * The source type of alternate or actual text */ declare enum SourceType { /** * Custom Text */ SOURCE_CUSTOM = 1934902125, /** * Decorative image */ SOURCE_DECORATIVE_IMAGE = 1648649065, /** * XML Structure */ SOURCE_XML_STRUCTURE = 1934907507, /** * XMP Alt Text */ SOURCE_XMP_ALT_TEXT = 1934907489, /** * XMP Description */ SOURCE_XMP_DESCRIPTION = 1934907492, /** * XMP Extended Description */ SOURCE_XMP_EXTENDED_DESCRIPTION = 1934907493, /** * XMP Headline */ SOURCE_XMP_HEADLINE = 1934907496, /** * User specified XMP metadata property */ SOURCE_XMP_OTHER = 1934907503, /** * XMP Title */ SOURCE_XMP_TITLE = 1934907508, } /** * The space between paragraphs using same style. */ declare enum Spacing { /** * Ignore space between paragraphs using same style. */ SETIGNORE = 1768386162, } /** * Span Column Count Options. */ declare enum SpanColumnCountOptions { /** * Paragraph spans all columns */ ALL = 1634495520, } /** * Type of Paragraph span. */ declare enum SpanColumnTypeOptions { /** * Paragraph is a single column */ SINGLE_COLUMN = 1163092844, /** * Paragraph spans the columns */ SPAN_COLUMNS = 1936745326, /** * Paragraph splits the columns */ SPLIT_COLUMNS = 1937007470, } /** * Special character options. */ declare enum SpecialCharacters { /** * Inserts an arabic comma. */ ARABIC_COMMA = 1396798051, /** * Inserts an arabic kashida. */ ARABIC_KASHIDA = 1396798059, /** * Inserts an arabic question mark. */ ARABIC_QUESTION_MARK = 1396797805, /** * Inserts an arabic semicolon. */ ARABIC_SEMICOLON = 1396798307, /** * Inserts an automatic page number. */ AUTO_PAGE_NUMBER = 1396797550, /** * Inserts a bullet character. */ BULLET_CHARACTER = 1396862068, /** * Inserts a column break. */ COLUMN_BREAK = 1396927554, /** * Inserts a copyright symbol. */ COPYRIGHT_SYMBOL = 1396929140, /** * Inserts a degree symbol. */ DEGREE_SYMBOL = 1396991858, /** * Inserts a discretionary hyphen. */ DISCRETIONARY_HYPHEN = 1396983920, /** * Inserts a discretionary line break. */ DISCRETIONARY_LINE_BREAK = 1397777484, /** * Inserts a dotted circle. */ DOTTED_CIRCLE = 1399092323, /** * Inserts a double left quote. */ DOUBLE_LEFT_QUOTE = 1396984945, /** * Inserts a double right quote. */ DOUBLE_RIGHT_QUOTE = 1396986481, /** * Inserts a double straight quote. */ DOUBLE_STRAIGHT_QUOTE = 1396986737, /** * Inserts an ellipsis character. */ ELLIPSIS_CHARACTER = 1397518451, /** * Inserts an em dash. */ EM_DASH = 1397058884, /** * Inserts an em space. */ EM_SPACE = 1397058899, /** * Inserts an end nested style here character. */ END_NESTED_STYLE = 1396855379, /** * Inserts an en dash. */ EN_DASH = 1397059140, /** * Inserts an en space. */ EN_SPACE = 1397059155, /** * Inserts a break to the next even page. */ EVEN_PAGE_BREAK = 1397059650, /** * Inserts a figure space. */ FIGURE_SPACE = 1397122899, /** * Inserts a fixed-width nonbreaking space. */ FIXED_WIDTH_NONBREAKING_SPACE = 1399746146, /** * Inserts a flush space. */ FLUSH_SPACE = 1397124179, /** * Inserts a footnote symbol. */ FOOTNOTE_SYMBOL = 1399221837, /** * Inserts a forced line break. */ FORCED_LINE_BREAK = 1397124194, /** * Inserts a frame break. */ FRAME_BREAK = 1397125698, /** * Inserts a hair space. */ HAIR_SPACE = 1397256787, /** * Inserts a hebrew geresh. */ HEBREW_GERESH = 1397253989, /** * Inserts a hebrew gershayim. */ HEBREW_GERSHAYIM = 1397254003, /** * Inserts a hebrew maqaf. */ HEBREW_MAQAF = 1397252717, /** * Inserts a hebrew sof pasuk. */ HEBREW_SOF_PASUK = 1397252723, /** * Inserts an indent to here character. */ INDENT_HERE_TAB = 1397319796, /** * Inserts a left to right embedding mark. */ LEFT_TO_RIGHT_EMBEDDING = 1399616101, /** * Inserts a left to right mark. */ LEFT_TO_RIGHT_MARK = 1399616109, /** * Inserts a left to right override mark. */ LEFT_TO_RIGHT_OVERRIDE = 1399616111, /** * Inserts the next page number. */ NEXT_PAGE_NUMBER = 1397649518, /** * Inserts a nonbreaking hyphen. */ NONBREAKING_HYPHEN = 1397645928, /** * Inserts a nonbreaking space. */ NONBREAKING_SPACE = 1397645907, /** * Inserts a break to the next odd page. */ ODD_PAGE_BREAK = 1397715010, /** * Inserts a page break. */ PAGE_BREAK = 1397778242, /** * Inserts a paragraph symbol. */ PARAGRAPH_SYMBOL = 1397776754, /** * Inserts a pop directional formatting mark. */ POP_DIRECTIONAL_FORMATTING = 1399874662, /** * Inserts the previous page number. */ PREVIOUS_PAGE_NUMBER = 1397780590, /** * Inserts a punctuation space. */ PUNCTUATION_SPACE = 1397780051, /** * Inserts a quarter-width space. */ QUARTER_SPACE = 1397847379, /** * Inserts a registered trademark. */ REGISTERED_TRADEMARK = 1397904493, /** * Inserts a right indent tab. */ RIGHT_INDENT_TAB = 1397909876, /** * Inserts a right to left embedding mark. */ RIGHT_TO_LEFT_EMBEDDING = 1400007781, /** * Inserts a right to left mark. */ RIGHT_TO_LEFT_MARK = 1400007789, /** * Inserts a right to left override mark. */ RIGHT_TO_LEFT_OVERRIDE = 1400007791, /** * Inserts a section marker. */ SECTION_MARKER = 1400073805, /** * Inserts a section symbol. */ SECTION_SYMBOL = 1400073811, /** * Inserts a single left quote. */ SINGLE_LEFT_QUOTE = 1397967985, /** * Inserts a single right quote. */ SINGLE_RIGHT_QUOTE = 1397969521, /** * Inserts a single straight quote. */ SINGLE_STRAIGHT_QUOTE = 1397969777, /** * Inserts a sixth-width space. */ SIXTH_SPACE = 1397975379, /** * Inserts the specified text variable. */ TEXT_VARIABLE = 1397781622, /** * Inserts a thin space. */ THIN_SPACE = 1398042195, /** * Inserts a third-width space. */ THIRD_SPACE = 1398040659, /** * Inserts a trademark symbol. */ TRADEMARK_SYMBOL = 1398041963, /** * Inserts a zero width joiner. */ ZERO_WIDTH_JOINER = 1400534890, /** * Inserts a zero-width non-joiner. */ ZERO_WIDTH_NONJOINER = 1397780074, } /** * Spell-check preferences. */ declare class SpellPreference extends Preference { /** * If true, checks for uncapitalized first words in sentences. */ checkCapitalizedSentences: boolean; /** * If true, checks for uncapitalized proper nouns. */ checkCapitalizedWords: boolean; /** * If true, checks for misspelled words. */ checkMisspelledWords: boolean; /** * If true, checks for repeated words. */ checkRepeatedWords: boolean; /** * If true, underlines misspelled and repeated words, uncapitalized proper * nouns, and uncapitalized first words in sentences. Note: Valid only when the * corresponding properties are true. For information, see check misspelled * words, check repeated words, check capitalized words, and check capitalized * sentences. */ dynamicSpellCheck: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The underline color for misspelled words, specified either as an array of * three doubles, each in the range 0 to 255 and representing R, G, and B * values, or as a UI color. Note: Valid only when both dynamic spell check and * check misspelled words are true. Can return: Array of 3 Reals (0 - 255) or * UIColors enumerator. */ misspelledWordColor: (number[][] | UIColors)[]; /** * The parent of the SpellPreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The underline color for repeated words, specified either as an array of * three doubles, each in the range 0 to 255 and representing R, G, and B * values, or as a UI color. Note: Valid only when both dynamic spell check and * check repeated words are true. . Can return: Array of 3 Reals (0 - 255) or * UIColors enumerator. */ repeatedWordColor: (number[][] | UIColors)[]; /** * The underline color for the first word in sentences that do not begin with a * capital letter, specified either as an array of three doubles, each in the * range 0 to 255 and representing R, G, and B values, or as a UI color. Note: * Valid when both dynamic spell check and check capitalized sentences are * true. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. */ uncapitalizedSentenceColor: (number[][] | UIColors)[]; /** * The underline color for uncapitalized proper nouns, specified either as an * array of three doubles, each in the range 0 to 255 and representing R, G, * and B values, or as a UI color. Note: Valid only when both dynamic spell * check and check capitalized words are true. . Can return: Array of 3 Reals * (0 - 255) or UIColors enumerator. */ uncapitalizedWordColor: (number[][] | UIColors)[]; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): SpellPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the SpellPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A path-based page item, such as a rectangle, oval, polygon, or graphic line. */ declare class SplineItem extends PageItem { /** * Indicates whether the SplineItem has been flipped independently of its * parent object and, if yes, the direction in which the SplineItem was * flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the SplineItem relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the SplineItem relative to its containing object. * (Range: -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the SplineItem relative to its containing object. * (Range: -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the SplineItem relative to its containing object. */ absoluteVerticalScale: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the SplineItem. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the SplineItem. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * Anchored object settings. */ readonly anchoredObjectSettings: AnchoredObjectSetting; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the SplineItem. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the SplineItem. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the SplineItem. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * A collection of buttons. */ readonly buttons: Buttons; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * Transparency settings for the content of the SplineItem. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The type of content that a frame can contain. */ contentType: ContentType; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the SplineItem. */ endJoin: EndJoin; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * A collection of EPS files. */ readonly epss: EPSs; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * SplineItem. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the SplineItem's fill color. (To specify a * tint percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the SplineItem. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * A collection of form fields. */ readonly formFields: FormFields; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the SplineItem excluding the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the SplineItem. * (Range: -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the SplineItem. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the SplineItem, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the SplineItem. * (Range: -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the SplineItem. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the SplineItem, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * A collection of groups. */ readonly groups: Groups; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the SplineItem. */ horizontalScale: number; /** * A collection of embedded HTML page items. */ readonly htmlItems: HtmlItems; /** * The unique ID of the SplineItem. */ readonly id: number; /** * A collection of bitmap images in any bitmap file format (including TIFF, * JPEG, or GIF). */ readonly images: Images; /** * Imported InDesign pages. */ readonly importedPages: ImportedPages; /** * The index of the SplineItem within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the SplineItem is on. */ itemLayer: Layer; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * Display performance options for the SplineItem. */ localDisplaySetting: DisplaySettingOptions; /** * The lock state. */ readonly lockState: LockStateValues; /** * If true, the SplineItem is locked. */ locked: boolean; /** * The media items collection. */ readonly mediaItems: MediaItems; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * A collection of movies. */ readonly movies: Movies; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * The name of the SplineItem. */ name: string; /** * If true, the SplineItem does not print. */ nonprinting: boolean; /** * Export options for the object */ readonly objectExportOptions: ObjectExportOption; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the SplineItem's fill color overprints any underlying objects. If * false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the SplineItem's stroke color overprints any underlying objects. If * false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the SplineItem (a Snippet, ComboBox, ListBox, TextBox, * SignatureField, Spread, MasterSpread, Polygon, GraphicLine, Rectangle, Oval, * SplineItem, Group, State, Cell, Character, PlaceGun or FlexObject). */ readonly parent: Cell | Character | ComboBox | GraphicLine | Group | ListBox | MasterSpread | Oval | PlaceGun | Polygon | Rectangle | SignatureField | SplineItem | Spread | State | TextBox | FlexObject | Snippet; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of paths. */ readonly paths: Paths; /** * A collection of PDF files. */ readonly pdfs: PDFs; /** * A collection of PICT graphics. */ readonly picts: PICTs; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the SplineItem. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the SplineItem. (Range: -360 to 360) */ shearAngle: number; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * A collection of sound clips. */ readonly sounds: Sounds; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The stroke alignment applied to the SplineItem. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the SplineItem. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the SplineItem. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the SplineItem's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * A collection of text paths. */ readonly textPaths: TextPaths; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the SplineItem. */ verticalScale: number; /** * If true, the SplineItem is visible. */ visible: boolean; /** * The bounds of the SplineItem including the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * A collection of WMF graphics. */ readonly wmfs: WMFs; /** * Dispatched after a SplineItem is placed. This event bubbles. This event is * not cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a SplineItem is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Creates a new page item by combining the SplineItem with other objects. * Deletes the objects if they do not intersect. * @param with_ The object(s) to add. */ addPath(with_: PageItem[]): PageItem; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the SplineItem's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the SplineItem that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Brings the SplineItem forward one level in its layer. */ bringForward(): void; /** * Brings the SplineItem to the front of its layer or in front of a particular * item. * @param reference The reference object to bring the object in front of (must have same parent) (Optional) */ bringToFront(reference?: PageItem): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Checks in the story or stories. * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ checkIn(versionComments?: string, forceSave?: boolean): boolean; /** * Checks out the story. */ checkOut(): boolean; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the SplineItem. Transformations include * rotation, scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the SplineItem to a different shape. * @param given The SplineItem's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new SplineItem. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new SplineItem. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new SplineItem. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new SplineItem. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new SplineItem. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the SplineItem at the specified location or offset. * @param to The location of the new SplineItem, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new SplineItem from the original SplineItem's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Creates a new page item by excluding the overlapping areas of the SplineItem * and other objects. * @param with_ The object(s) to exclude. */ excludeOverlapPath(with_: PageItem[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the SplineItem. * @param given The axis around which to flip the SplineItem. * @param around The point around which to flip the SplineItem. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): SplineItem[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Creates a new page item by intersecting the SplineItem with other objects. * Returns an error if the objects do not intersect. * @param with_ The object(s) with which to intersect. */ intersectPath(with_: PageItem[]): PageItem; /** * Creates a compound path by combining the path(s) of the SplineItem with the * paths of other objects. * @param with_ The other objects whose paths to include in the new compound path. */ makeCompoundPath(with_: PageItem[]): PageItem; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Creates a new page item by reverse subtracting the overlapping areas of the * SplineItem and other objects. * @param with_ The object(s) to reverse subtract. */ minusBack(with_: PageItem[]): PageItem; /** * Moves the SplineItem to a new location. Note: Either the 'to' or 'by' * parameter is required; if both parameters are defined, only the to value is * used. * @param to The new location of the SplineItem,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the SplineItem relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Releases a compound path. */ releaseCompoundPath(): PageItem[]; /** * Deletes the SplineItem. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Reverts the document to its state at the last save operation. */ revert(): boolean; /** * Selects the object. * @param existingSelection The selection status of the SplineItem in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Sends the SplineItem back one level in its layer. */ sendBackward(): void; /** * Sends the SplineItem to the back of its layer or behind a particular item * (must have same parent). * @param reference The reference object to send the object behind (Optional) */ sendToBack(reference?: PageItem): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new SplineItem (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Creates a new page item by subtracting the overlapping areas of the * SplineItem and other objects. * @param with_ The object(s) to subtract. */ subtractPath(with_: PageItem[]): PageItem; /** * Generates a string which, if executed, will return the SplineItem. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the SplineItem using the last transformation performed on any * object. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgain(): string[]; /** * Transforms the SplineItem using the last transformation performed on any * SplineItem. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgainIndividually(): string[]; /** * Transforms the SplineItem using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the SplineItem using the last sequence of transformations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * The spline items collection. */ declare class SplineItems { /** Returns the SplineItem with the specified index or name. */ [index: number]: SplineItem; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any SplineItem in the collection. */ anyItem(): SplineItem; /** * Displays the number of elements in the SplineItem. */ count(): number; /** * Returns every SplineItem in the collection. */ everyItem(): SplineItem; /** * Returns the first SplineItem in the collection. */ firstItem(): SplineItem; /** * Returns the SplineItem with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): SplineItem; /** * Returns the SplineItem with the specified ID. * @param id The ID. */ itemByID(id: number): SplineItem; /** * Returns the SplineItem with the specified name. * @param name The name. */ itemByName(name: string): SplineItem; /** * Returns the SplineItems within the specified range. * @param from The SplineItem, index, or name at the beginning of the range. Can accept: SplineItem, Long Integer or String. * @param to The SplineItem, index, or name at the end of the range. Can accept: SplineItem, Long Integer or String. */ itemByRange(from: number | SplineItem | string, to: number | SplineItem | string): SplineItem[]; /** * Returns the last SplineItem in the collection. */ lastItem(): SplineItem; /** * Returns the middle SplineItem in the collection. */ middleItem(): SplineItem; /** * Returns the SplineItem whose index follows the specified SplineItem in the * collection. * @param obj The SplineItem whose index comes before the desired SplineItem. */ nextItem(obj: SplineItem): SplineItem; /** * Returns the SplineItem with the index previous to the specified index. * @param obj The index of the SplineItem that follows the desired SplineItem. */ previousItem(obj: SplineItem): SplineItem; /** * Generates a string which, if executed, will return the SplineItem. */ toSource(): string; } /** * A spread. */ declare class Spread { /** * Lists all graphics contained by the Spread. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the Spread. */ readonly allPageItems: PageItem[]; /** * If true, guarantees that when pages are added to a spread it will contain a * maximum of two pages. If false, allows pages to be added or moved into * existing spreads. For override information, see preserve layout when * shuffling. */ allowPageShuffle: boolean; /** * The master spread applied to the Spread. Can also accept: NothingEnum * enumerator. */ appliedMaster: MasterSpread | NothingEnum; /** * A collection of buttons. */ readonly buttons: Buttons; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The transparency flattener preferences override for the spread. */ flattenerOverride: SpreadFlattenerLevel; /** * Flattener preference settings. */ readonly flattenerPreferences: FlattenerPreference; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * A collection of form fields. */ readonly formFields: FormFields; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * A collection of groups. */ readonly groups: Groups; /** * A collection of guides. */ readonly guides: Guides; /** * The unique ID of the Spread. */ readonly id: number; /** * The IDML component name of the Spread. */ idmlComponentName: string; /** * The index of the Spread within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * The name of the Spread; this is an alias to the Spread's label property. */ name: string; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The direction of the page transition. */ pageTransitionDirection: PageTransitionDirectionOptions; /** * The duration of the page transition. */ pageTransitionDuration: PageTransitionDurationOptions; /** * The type of page transition. */ pageTransitionType: PageTransitionTypeOptions; /** * A collection of pages. */ readonly pages: Pages; /** * The parent of the Spread (a Document). */ readonly parent: Document; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * If true, displays master page items on document pages in the spread. */ showMasterItems: boolean; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * If true, denotes that the spread is hidden. If false, denotes that the * spread is not hidden. For override, pass true to hide and false to unhide */ spreadHidden: boolean; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicate an object and place it into the target. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param placePoint The point at which to place (Optional) * @param destinationLayer The layer on which to place (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, placePoint?: (number | string)[], destinationLayer?: Layer, showingOptions?: boolean): any[]; /** * Creates multiple guides on all pages of the spread. * @param numberOfRows The number of rows to create on each page. (Optional) * @param numberOfColumns The number of columns to create on each page. (Optional) * @param rowGutter The height of the gutter between rows. (Optional) * @param columnGutter The width of the gutter between columns. (Optional) * @param guideColor The color to make the guides, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Can accept: Array of 3 Reals (0 - 255) or UIColors enumerator. (Optional) * @param fitMargins If true, the row height and column width are calculated based on the space within the page margins. If false, row height and column width are calculated based on the full page. (Optional) * @param removeExisting If true, removes existing guides when creating new ones. (Optional) * @param layer The layer on which to create the guides. (Optional) */ createGuides(numberOfRows?: number, numberOfColumns?: number, rowGutter?: number | string, columnGutter?: number | string, guideColor?: (number[][] | UIColors)[], fitMargins?: boolean, removeExisting?: boolean, layer?: Layer): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the spread. * @param to The location of the spread relative to the reference object or within the document. (Optional) * @param reference The reference object. Note: Required only when the to parameter specifies before or after. Can accept: Spread, Document or MasterSpread. (Optional) */ duplicate(to?: LocationOptions, reference?: Document | Spread | MasterSpread): any; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Spread[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Moves the spread. * @param to The location of the spread relative to the reference object or within the document. (Optional) * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Spread, Page or Document. (Optional) */ move(to?: LocationOptions, reference?: Page | Spread | Document): Spread; /** * Places the file. * @param fileName The file to place * @param placePoint The point at which to place (Optional) * @param destinationLayer The layer on which to place (Optional) * @param showingOptions Whether to display the import options dialog (Optional) * @param autoflowing Whether to autoflow placed text (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, placePoint?: (number | string)[], destinationLayer?: Layer, showingOptions?: boolean, autoflowing?: boolean, withProperties?: Object): any[]; /** * Deprecated: Use contentPlace method. Original Description: Create a linked * story and place it into the target. * @param parentStory The story to place and link from. * @param placePoint The point at which to place (Optional) * @param destinationLayer The layer on which to place (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ placeAndLink(parentStory: Story, placePoint?: (number | string)[], destinationLayer?: Layer, showingOptions?: boolean): Story; /** * Places the XML element onto a page. If the place point is above an existing * page item, place the XML element into the page item. * @param using The XML element to place. * @param placePoint The point at which to place the object, specified in the format [x, y]. * @param autoflowing If true, autoflows placed text. (Optional) */ placeXML(using: XMLElement, placePoint: (number | string)[], autoflowing?: boolean): PageItem; /** * Deletes the Spread. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the Spread in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Replaces the content of XML element with content imported from a file. * @param using The file path to the import file. * @param relativeBasePath Base path used to resolve relative paths. (Optional) */ setContent(using: string, relativeBasePath?: string): PageItem; /** * Generates a string which, if executed, will return the Spread. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * Flattener level override options. */ declare enum SpreadFlattenerLevel { /** * Uses the specified custom flattening level. */ CUSTOM = 1131639917, /** * Uses the default level. */ DEFAULT_VALUE = 1147563124, /** * Turns off flattening. */ NONE = 1852796517, } /** * A collection of spreads. */ declare class Spreads { /** Returns the Spread with the specified index or name. */ [index: number]: Spread; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new spread. * @param at The location of the spread relative to the reference object or within the document. (Optional) * @param reference The reference object. Note: Required when the at parameter specifies before or after. Can accept: Spread or Document. (Optional) * @param withProperties Initial values for properties of the new Spread (Optional) */ add(at?: LocationOptions, reference?: Spread | Document, withProperties?: Object): Spread; /** * Returns any Spread in the collection. */ anyItem(): Spread; /** * Displays the number of elements in the Spread. */ count(): number; /** * Returns every Spread in the collection. */ everyItem(): Spread; /** * Returns the first Spread in the collection. */ firstItem(): Spread; /** * Returns the Spread with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Spread; /** * Returns the Spread with the specified ID. * @param id The ID. */ itemByID(id: number): Spread; /** * Returns the Spread with the specified name. * @param name The name. */ itemByName(name: string): Spread; /** * Returns the Spreads within the specified range. * @param from The Spread, index, or name at the beginning of the range. Can accept: Spread, Long Integer or String. * @param to The Spread, index, or name at the end of the range. Can accept: Spread, Long Integer or String. */ itemByRange(from: number | Spread | string, to: number | Spread | string): Spread[]; /** * Returns the last Spread in the collection. */ lastItem(): Spread; /** * Returns the middle Spread in the collection. */ middleItem(): Spread; /** * Returns the Spread whose index follows the specified Spread in the * collection. * @param obj The Spread whose index comes before the desired Spread. */ nextItem(obj: Spread): Spread; /** * Returns the Spread with the index previous to the specified index. * @param obj The index of the Spread that follows the desired Spread. */ previousItem(obj: Spread): Spread; /** * Generates a string which, if executed, will return the Spread. */ toSource(): string; } /** * Column and page break options. */ declare enum StartParagraph { /** * Starts in the next available space. */ ANYWHERE = 1851945579, /** * Starts at the top of the next column. */ NEXT_COLUMN = 1667396203, /** * Starts at the top of the next even-numbered page. */ NEXT_EVEN_PAGE = 1164993131, /** * Starts at the top of the next text frame in the thread. */ NEXT_FRAME = 1313235563, /** * Starts at the top of the next odd-numbered page. */ NEXT_ODD_PAGE = 1332765291, /** * Starts at the top of the next page. */ NEXT_PAGE = 1885500011, } /** * A state (states define the display of the field in an exported PDF). */ declare class State { /** * If true, the state is active in the exported PDF. */ active: boolean; /** * If true, the state is enabled in PDF documents. */ enabled: boolean; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * A collection of EPS files. */ readonly epss: EPSs; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * A collection of groups. */ readonly groups: Groups; /** * The unique ID of the State. */ readonly id: number; /** * A collection of bitmap images in any bitmap file format (including TIFF, * JPEG, or GIF). */ readonly images: Images; /** * The index of the State within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the State. */ name: string; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the State (a Button, MultiStateObject, CheckBox or * RadioButton). */ readonly parent: CheckBox | MultiStateObject | Button | RadioButton; /** * A collection of PDF files. */ readonly pdfs: PDFs; /** * A collection of PICT graphics. */ readonly picts: PICTs; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * For a button, the type of user action that dictates the object's appearance. * For a MultiStateObject, which has no user actions associated with states, * this property is a numeric value uniquely identifying the state. Can return: * StateTypes enumerator or Long Integer. */ statetype: StateTypes | number; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * A collection of WMF graphics. */ readonly wmfs: WMFs; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Adds page items to this state. * @param pageitems One or more page items to add to this state. */ addItemsToState(pageitems: PageItem[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): State[]; /** * Moves the state to a new position in its parent collection. * @param newPosition the index to move the state to in its parent collection */ move(newPosition: number): void; /** * Releases this state's appearance as a page item, removing the state from its * parent object. */ releaseAsObject(): void; /** * Deletes the State. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the State. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for specifying the events (user actions) that change a button's * state. */ declare enum StateTypes { /** * The mouse pointer is clicked on the button's area. */ DOWN = 1181971556, /** * Down off state. */ DOWN_OFF = 1181967462, /** * Down on state. */ DOWN_ON = 1181967471, /** * The mouse pointer moves into the button's area. */ ROLLOVER = 1181971574, /** * Rollover off state. */ ROLLOVER_OFF = 1181972070, /** * Rollover on state. */ ROLLOVER_ON = 1181972079, /** * The default appearance, used when there is no user activity on the button's * area. */ UP = 1181971566, /** * Up off state. */ UP_OFF = 1181970022, /** * Up on state. */ UP_ON = 1181970031, } /** * A collection of states. */ declare class States { /** Returns the State with the specified index or name. */ [index: number]: State; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new State. * @param withProperties Initial values for properties of the new State (Optional) */ add(withProperties?: Object): State; /** * Returns any State in the collection. */ anyItem(): State; /** * Displays the number of elements in the State. */ count(): number; /** * Returns every State in the collection. */ everyItem(): State; /** * Returns the first State in the collection. */ firstItem(): State; /** * Returns the State with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): State; /** * Returns the State with the specified ID. * @param id The ID. */ itemByID(id: number): State; /** * Returns the State with the specified name. * @param name The name. */ itemByName(name: string): State; /** * Returns the States within the specified range. * @param from The State, index, or name at the beginning of the range. Can accept: State, Long Integer or String. * @param to The State, index, or name at the end of the range. Can accept: State, Long Integer or String. */ itemByRange(from: number | State | string, to: number | State | string): State[]; /** * Returns the last State in the collection. */ lastItem(): State; /** * Returns the middle State in the collection. */ middleItem(): State; /** * Returns the State whose index follows the specified State in the collection. * @param obj The State whose index comes before the desired State. */ nextItem(obj: State): State; /** * Returns the State with the index previous to the specified index. * @param obj The index of the State that follows the desired State. */ previousItem(obj: State): State; /** * Generates a string which, if executed, will return the State. */ toSource(): string; } /** * The alignment for static text. */ declare enum StaticAlignmentOptions { /** * Center align the text. */ CENTER_ALIGN = 1667591796, /** * Left align the text. */ LEFT_ALIGN = 1818584692, /** * Right align the text. */ RIGHT_ALIGN = 1919379572, } /** * A static text control (typically a label for another control or a set of * controls). */ declare class StaticText extends Widget { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the StaticText. */ readonly id: number; /** * The index of the StaticText within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The width of the control. For an editbox or combobox, specifies the minimum * width of the box. */ minWidth: number; /** * The parent of the StaticText (a DialogColumn, DialogRow, EnablingGroup or * BorderPanel). */ readonly parent: DialogRow | EnablingGroup | BorderPanel | DialogColumn; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Text alignment for the StaticText. */ staticAlignment: StaticAlignmentOptions; /** * Text that appears in the StaticText. */ staticLabel: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): StaticText[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the StaticText. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of static text objects. */ declare class StaticTexts { /** Returns the StaticText with the specified index or name. */ [index: number]: StaticText; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new StaticText. * @param withProperties Initial values for properties of the new StaticText (Optional) */ add(withProperties?: Object): StaticText; /** * Returns any StaticText in the collection. */ anyItem(): StaticText; /** * Displays the number of elements in the StaticText. */ count(): number; /** * Returns every StaticText in the collection. */ everyItem(): StaticText; /** * Returns the first StaticText in the collection. */ firstItem(): StaticText; /** * Returns the StaticText with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): StaticText; /** * Returns the StaticText with the specified ID. * @param id The ID. */ itemByID(id: number): StaticText; /** * Returns the StaticTexts within the specified range. * @param from The StaticText, index, or name at the beginning of the range. Can accept: StaticText, Long Integer or String. * @param to The StaticText, index, or name at the end of the range. Can accept: StaticText, Long Integer or String. */ itemByRange(from: number | StaticText | string, to: number | StaticText | string): StaticText[]; /** * Returns the last StaticText in the collection. */ lastItem(): StaticText; /** * Returns the middle StaticText in the collection. */ middleItem(): StaticText; /** * Returns the StaticText whose index follows the specified StaticText in the * collection. * @param obj The StaticText whose index comes before the desired StaticText. */ nextItem(obj: StaticText): StaticText; /** * Returns the StaticText with the index previous to the specified index. * @param obj The index of the StaticText that follows the desired StaticText. */ previousItem(obj: StaticText): StaticText; /** * Generates a string which, if executed, will return the StaticText. */ toSource(): string; } /** * A collection of stories. */ declare class Stories { /** Returns the Story with the specified index or name. */ [index: number]: Story; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Story in the collection. */ anyItem(): Story; /** * Displays the number of elements in the Story. */ count(): number; /** * Returns every Story in the collection. */ everyItem(): Story; /** * Returns the first Story in the collection. */ firstItem(): Story; /** * Returns the Story with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Story; /** * Returns the Story with the specified ID. * @param id The ID. */ itemByID(id: number): Story; /** * Returns the Story with the specified name. * @param name The name. */ itemByName(name: string): Story; /** * Returns the Stories within the specified range. * @param from The Story, index, or name at the beginning of the range. Can accept: Story, Long Integer or String. * @param to The Story, index, or name at the end of the range. Can accept: Story, Long Integer or String. */ itemByRange(from: number | Story | string, to: number | Story | string): Story[]; /** * Returns the last Story in the collection. */ lastItem(): Story; /** * Returns the middle Story in the collection. */ middleItem(): Story; /** * Returns the Story whose index follows the specified Story in the collection. * @param obj The Story whose index comes before the desired Story. */ nextItem(obj: Story): Story; /** * Returns the Story with the index previous to the specified index. * @param obj The index of the Story that follows the desired Story. */ previousItem(obj: Story): Story; /** * Generates a string which, if executed, will return the Story. */ toSource(): string; } /** * A story. */ declare class Story { /** * If true, aligns the baseline of the text to the baseline grid. */ alignToBaseline: boolean; /** * Lists all graphics contained by the Story. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the Story. */ readonly allPageItems: PageItem[]; /** * If true, words unassociated with a hyphenation dictionary can break to the * next line on any character. */ allowArbitraryHyphenation: boolean; /** * The character style applied to the text. Can also accept: String. */ appliedCharacterStyle: CharacterStyle | string; /** * The font applied to the Story, specified as either a font object or the name * of font family. Can return: Font or String. */ appliedFont: Font | string; /** * The language of the text. Can return: LanguageWithVendors or Language. Can * also accept: String. */ appliedLanguage: LanguageWithVendors | string | Language; /** * The named grid in use. */ appliedNamedGrid: NamedGrid; /** * The applied character styles dictated by nested styles. */ readonly appliedNestedStyles: CharacterStyle[]; /** * The list to be part of. Can return: NumberingList or String. */ appliedNumberingList: NumberingList | string; /** * The paragraph style applied to the text. Can also accept: String. */ appliedParagraphStyle: ParagraphStyle | string; /** * The XML element associated with the Story. */ readonly associatedXMLElement: XMLItem; /** * The percent of the type size to use for auto leading. (Range: 0 to 500). * @remarks Range: 0 to 500 */ autoLeading: number; /** * The number of half-width characters at or below which the characters * automatically run horizontally in vertical text. */ autoTcy: number; /** * If true, auto tcy includes Roman characters. */ autoTcyIncludeRoman: boolean; /** * If true or set to an enumeration value, balances ragged lines. Note: Not * valid with a single-line text composer. Can return: Boolean or * BalanceLinesStyle enumerator. */ balanceRaggedLines: boolean | BalanceLinesStyle; /** * The baseline shift applied to the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ baselineShift: number | string; /** * Bullet character. */ readonly bulletChar: Bullet; /** * The alignment of the bullet character. */ bulletsAlignment: ListAlignment; /** * List type for bullets and numbering. */ bulletsAndNumberingListType: ListType; /** * The character style to be used for the text after string. Can return: * CharacterStyle or String. */ bulletsCharacterStyle: CharacterStyle | string; /** * The text after string expression for bullets. */ bulletsTextAfter: string; /** * If true, adds the double period (..), ellipse (...), and double hyphen (--) * to the selected kinsoku set. Note: Valid only when a kinsoku set is in * effect. */ bunriKinshi: boolean; /** * A collection of buttons. */ readonly buttons: Buttons; /** * The capitalization scheme. */ capitalization: Capitalization; /** * A collection of cell style mappings. */ readonly cellStyleMappings: CellStyleMappings; /** * A collection of changes. */ readonly changes: Changes; /** * A collection of char style mappings. */ readonly charStyleMappings: CharStyleMappings; /** * The alignment of small characters to the largest character in the line. */ characterAlignment: CharacterAlignment; /** * The direction of the character. */ characterDirection: CharacterDirectionOptions; /** * The rotation angle (in degrees) of individual characters. Note: The rotation * is counterclockwise. */ characterRotation: number; /** * A collection of characters. */ readonly characters: Characters; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * If true, uses grid tracking to track non-Roman characters in CJK grids. */ cjkGridTracking: boolean; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * The text composer to use to compose the text. */ composer: string; /** * The contents of the text. Can return: String or SpecialCharacters * enumerator. */ contents: string | SpecialCharacters; /** * Value of Design Axes */ designAxes: number[]; /** * The desired width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ desiredGlyphScaling: number; /** * The desired letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) */ desiredLetterSpacing: number; /** * The desired word spacing, specified as a percentage of the font word space * value. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ desiredWordSpacing: number; /** * Position of diacriticical characters. */ diacriticPosition: DiacriticPositionOptions; /** * The digits type. */ digitsType: DigitsTypeOptions; /** * The number of characters to drop cap. * @remarks Range: 0 to 150 */ dropCapCharacters: number; /** * The number of lines to drop cap. * @remarks Range: 0 to 25 */ dropCapLines: number; /** * The character style to apply to the drop cap. Can also accept: String. */ dropCapStyle: CharacterStyle | string; /** * Details about the drop cap based on the glyph outlines. 1 = left side * bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid. */ dropcapDetail: number; /** * The stroke join type applied to the characters of the text. */ endJoin: OutlineJoin; /** * A collection of endnote text ranges. */ readonly endnoteRanges: EndnoteRanges; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * A collection of endnotes. */ readonly endnotes: Endnotes; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * Story. . Can also accept: String. */ fillColor: Swatch | string; /** * The tint (as a percentage) of the fill color of the Story. (To specify a * tint percentage, use a number in the range of 0 to 100; to use the inherited * or overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * The amount to indent the first line. * @remarks Measurement unit — also accepts a string such as "12mm". */ firstLineIndent: number | string; /** * The name of the font style. */ fontStyle: string; /** * A collection of footnotes. */ readonly footnotes: Footnotes; /** * A collection of form fields. */ readonly formFields: FormFields; /** * The glyph variant to substitute for standard glyphs. */ glyphForm: AlternateGlyphForms; /** * The angle of a linear gradient applied to the fill of the text. (Range: -180 * to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the text. */ gradientFillLength: number; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the text. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the text. */ gradientStrokeLength: number; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * If true, aligns only the first line to the frame grid or baseline grid. If * false, aligns all lines to the grid. */ gridAlignFirstLineOnly: boolean; /** * The alignment to the frame grid or baseline grid. */ gridAlignment: GridAlignment; /** * Default grid properties. Note: Applies to named, layout, and frame (story) * grids. */ readonly gridData: GridDataInformation; /** * The manual gyoudori setting. */ gridGyoudori: number; /** * A collection of groups. */ readonly groups: Groups; /** * A collection of hidden text objects. */ readonly hiddenTexts: HiddenTexts; /** * The horizontal scaling applied to the Story. */ horizontalScale: number; /** * The relative desirability of better spacing vs. fewer hyphens. A lower value * results in greater use of hyphens. (Range: 0 to 100) * @remarks Range: 0 to 10 */ hyphenWeight: number; /** * If true, allows the last word in a text column to be hyphenated. */ hyphenateAcrossColumns: boolean; /** * The mininum number of letters at the beginning of a word that can be broken * by a hyphen. * @remarks Range: 1 to 15 */ hyphenateAfterFirst: number; /** * The minimum number of letters at the end of a word that can be broken by a * hyphen. * @remarks Range: 1 to 15 */ hyphenateBeforeLast: number; /** * If true, allows hyphenation of capitalized words. */ hyphenateCapitalizedWords: boolean; /** * The maximum number of hyphens that can appear on consecutive lines. To * specify unlimited consecutive lines, use zero. * @remarks Range: 0 to 25 */ hyphenateLadderLimit: number; /** * If true, allows hyphenation in the last word in a paragraph. Note: Valid * only when hyphenation is true. */ hyphenateLastWord: boolean; /** * The minimum number of letters a word must have in order to qualify for * hyphenation. * @remarks Range: 3 to 25 */ hyphenateWordsLongerThan: number; /** * If true, allows hyphenation. */ hyphenation: boolean; /** * The amount of white space allowed at the end of a line of non-justified text * before hypenation begins. Note: Valid when composer is single-line composer. * @remarks Measurement unit — also accepts a string such as "12mm". */ hyphenationZone: number | string; /** * The unique ID of the Story. */ readonly id: number; /** * The IDML component name of the Story. */ idmlComponentName: string; /** * If true, ignores optical edge alignment for the paragraph. */ ignoreEdgeAlignment: boolean; /** * Export options for InCopy INCX document format. */ readonly incopyExportOptions: InCopyExportOption; /** * The index of the Story within its containing object. */ readonly index: number; /** * A collection of insertion points. */ readonly insertionPoints: InsertionPoints; /** * returns true if it's an endnote story otherwise returns false. */ readonly isEndnoteStory: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The source file of the link. */ readonly itemLink: Link; /** * The number of grid squares in which to arrange the text. */ jidori: number; /** * The paragraph alignment. */ justification: Justification; /** * Use of Kashidas for justification */ kashidas: KashidasOptions; /** * If true, keeps all lines of the paragraph together. If false, allows * paragraphs to break across pages or columns. */ keepAllLinesTogether: boolean; /** * The minimum number of lines to keep together in a paragraph before allowing * a page break. * @remarks Range: 1 to 50 */ keepFirstLines: number; /** * The minimum number of lines to keep together in a paragraph after a page * break. * @remarks Range: 1 to 50 */ keepLastLines: number; /** * If true, keeps a specified number of lines together when the paragraph * breaks across columns or text frames. */ keepLinesTogether: boolean; /** * If true, forces the rule above the paragraph to remain in the frame bounds. * Note: Valid only when rule above is true. */ keepRuleAboveInFrame: boolean; /** * The minimum number of lines to keep with the next paragraph. * @remarks Range: 0 to 5 */ keepWithNext: number; /** * If the first line in the paragraph should be kept with the last line of * previous paragraph. */ keepWithPrevious: boolean; /** * The alignment of kenten characters relative to the parent characters. */ kentenAlignment: KentenAlignment; /** * The character set used for the custom kenten character. Note: Valid only * when kenten kind is custom. */ kentenCharacterSet: KentenCharacterSet; /** * The character used for kenten. Note: Valid only when kenten kind is custom. */ kentenCustomCharacter: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of * kenten characters. Can return: Swatch or String. */ kentenFillColor: Swatch | string; /** * The font to use for kenten characters. Can return: Font or String. */ kentenFont: Font | string; /** * The size (in points) of kenten characters. */ kentenFontSize: number; /** * The font style of kenten characters. Can return: String or NothingEnum * enumerator. */ kentenFontStyle: string | NothingEnum; /** * The style of kenten characters. */ kentenKind: KentenCharacter; /** * The method of overprinting the kenten fill. */ kentenOverprintFill: AdornmentOverprint; /** * The method of overprinting the kenten stroke. */ kentenOverprintStroke: AdornmentOverprint; /** * The distance between kenten characters and their parent characters. */ kentenPlacement: number; /** * The kenten position relative to the parent character. */ kentenPosition: RubyKentenPosition; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * kenten characters. Can return: Swatch or String. */ kentenStrokeColor: Swatch | string; /** * The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenStrokeTint: number; /** * The fill tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenTint: number; /** * The stroke weight (in points) of kenten characters. */ kentenWeight: number; /** * The horizontal size of kenten characters as a percent of the original size. */ kentenXScale: number; /** * The vertical size of kenten charachers as a percent of the original size. */ kentenYScale: number; /** * The type of pair kerning. */ kerningMethod: string; /** * The keyboard direction of the character. */ keyboardDirection: CharacterDirectionOptions; /** * The type of hanging punctuation to allow. Note: Valid only when a kinsoku * set is in effect. */ kinsokuHangType: KinsokuHangTypes; /** * The kinsoku set that determines legitimate line breaks. Can return: * KinsokuTable, KinsokuSet enumerator or String. */ kinsokuSet: KinsokuSet | KinsokuTable | string; /** * The type of kinsoku processing for preventing kinsoku characters from * beginning or ending a line. Note: Valid only when a kinsoku set is defined. */ kinsokuType: KinsokuType; /** * A property that can be set to any string. */ label: string; /** * The amount to indent the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ lastLineIndent: number | string; /** * The leading applied to the text. Can return: Unit or Leading enumerator. */ leading: number | Leading; /** * The amount of space before each character. */ leadingAki: number; /** * The point from which leading is measured from line to line. */ leadingModel: LeadingModel; /** * The width of the left indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ leftIndent: number | string; /** * The number of objects in the collection. */ readonly length: number; /** * If true, replaces specific character combinations (e.g., fl, fi) with * ligature characters. */ ligatures: boolean; /** * A collection of lines. */ readonly lines: Lines; /** * Linked story options */ readonly linkedStoryOptions: LinkedStoryOption; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * The lock state. */ readonly lockState: LockStateValues; /** * The maximum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ maximumGlyphScaling: number; /** * The maximum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ maximumLetterSpacing: number; /** * The maximum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ maximumWordSpacing: number; /** * If true, consecutive para borders with completely similar properties are * merged. */ mergeConsecutiveParaBorders: boolean; /** * The minimum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ minimumGlyphScaling: number; /** * The minimum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ minimumLetterSpacing: number; /** * The minimum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ minimumWordSpacing: number; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 0 to 1000 */ miterLimit: number; /** * The mojikumi table. For information, see mojikumi table defaults. Can * return: MojikumiTable, String or MojikumiTableDefaults enumerator. */ mojikumi: MojikumiTable | string | MojikumiTableDefaults; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * The name of the Story; this is an alias to the Story's label property. */ name: string; /** * A collection of nested GREP styles. */ readonly nestedGrepStyles: NestedGrepStyles; /** * A collection of nested line styles. */ readonly nestedLineStyles: NestedLineStyles; /** * A collection of nested styles. */ readonly nestedStyles: NestedStyles; /** * If true, keeps the text on the same line. */ noBreak: boolean; /** * A collection of notes. */ readonly notes: Notes; /** * The alignment of the number. */ numberingAlignment: ListAlignment; /** * If true, apply the numbering restart policy. */ numberingApplyRestartPolicy: boolean; /** * The character style to be used for the number string. Can return: * CharacterStyle or String. */ numberingCharacterStyle: CharacterStyle | string; /** * Continue the numbering at this level. */ numberingContinue: boolean; /** * The number string expression for numbering. */ numberingExpression: string; /** * Numbering format options. Can return: NumberingStyle enumerator or String. */ numberingFormat: NumberingStyle | string; /** * The level of the paragraph. */ numberingLevel: number; /** * Numbering restart policies. */ readonly numberingRestartPolicies: NumberingRestartPolicy; /** * Determines starting number in a numbered list. */ numberingStartAt: number; /** * OpenType features. Can return: Array of Array of 2 Strings or Long Integers. */ opentypeFeatures: (string[][] | number[])[]; /** * If true, uses contextual alternate forms in OpenType fonts. */ otfContextualAlternate: boolean; /** * If true, uses discretionary ligatures in OpenType fonts. */ otfDiscretionaryLigature: boolean; /** * The figure style in OpenType fonts. */ otfFigureStyle: OTFFigureStyle; /** * If true, uses fractions in OpenType fonts. */ otfFraction: boolean; /** * If true, switches hiragana fonts, which have different glyphs for horizontal * and vertical. */ otfHVKana: boolean; /** * If true, use historical forms in OpenType fonts. */ otfHistorical: boolean; /** * If true, use alternate justification forms in OpenType fonts */ otfJustificationAlternate: boolean; /** * If true, uses localized forms in OpenType fonts. */ otfLocale: boolean; /** * If true, uses mark positioning in OpenType fonts. */ otfMark: boolean; /** * If true, uses ordinals in OpenType fonts. */ otfOrdinal: boolean; /** * If true, use overlapping swash forms in OpenType fonts */ otfOverlapSwash: boolean; /** * If true, kerns according to proportional CJK metrics in OpenType fonts. */ otfProportionalMetrics: boolean; /** * If true, applies italics to half-width alphanumerics. */ otfRomanItalics: boolean; /** * If true, use a slashed zeroes in OpenType fonts. */ otfSlashedZero: boolean; /** * If true, use stretched alternate forms in OpenType fonts */ otfStretchedAlternate: boolean; /** * If true, use stylistic alternate forms in OpenType fonts */ otfStylisticAlternate: boolean; /** * The stylistic sets to use in OpenType fonts. */ otfStylisticSets: number; /** * If true, uses swash forms in OpenType fonts. */ otfSwash: boolean; /** * If true, uses titling forms in OpenType fonts. */ otfTitling: boolean; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the story has overset text. */ readonly overflows: boolean; /** * If true, the fill color of the characters will overprint. */ overprintFill: boolean; /** * If true, the stroke of the characters will overprint. */ overprintStroke: boolean; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * A collection of para style mappings. */ readonly paraStyleMappings: ParaStyleMappings; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphBorderBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLeftCornerRadius: number | string; /** * The bottom line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLineWeight: number | string; /** * The distance to offset the bottom edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph border. */ paragraphBorderBottomOrigin: ParagraphBorderBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphBorderBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomRightCornerRadius: number | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * stroke. Can return: Swatch or String. */ paragraphBorderColor: Swatch | string; /** * If true, then paragraph border is also displayed at the points where the * paragraph splits across frames or columns. */ paragraphBorderDisplayIfSplits: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * border gap. Note: Valid only when the border type is not solid. Can return: * Swatch or String. */ paragraphBorderGapColor: Swatch | string; /** * If true, the paragraph border gap will overprint. Note: Valid only when * border type is not solid. */ paragraphBorderGapOverprint: boolean; /** * The tint (as a percentage) of the paragraph border gap. Note: Valid only * when the border type is not solid. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderGapTint: number; /** * The left line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftLineWeight: number | string; /** * The distance to offset the left edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftOffset: number | string; /** * If true, the paragraph border is on. */ paragraphBorderOn: boolean; /** * If true, the paragraph border will overprint. */ paragraphBorderOverprint: boolean; /** * The right line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightLineWeight: number | string; /** * The distance to offset the right edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightOffset: number | string; /** * The end shape of an open path. */ paragraphBorderStrokeEndCap: EndCap; /** * The corner join applied to the Story. */ paragraphBorderStrokeEndJoin: EndJoin; /** * The tint (as a percentage) of the paragraph stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphBorderTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLeftCornerRadius: number | string; /** * The top line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLineWeight: number | string; /** * The distance to offset the top edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph border. */ paragraphBorderTopOrigin: ParagraphBorderTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphBorderTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopRightCornerRadius: number | string; /** * The type of the border for the paragraph. Can return: StrokeStyle or String. */ paragraphBorderType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph border. */ paragraphBorderWidth: ParagraphBorderEnum; /** * Paragraph direction. */ paragraphDirection: ParagraphDirectionOptions; /** * If true, the gyoudori mode applies to the entire paragraph. If false, the * gyoudori mode applies to each line in the paragraph. */ paragraphGyoudori: boolean; /** * Paragraph justification. */ paragraphJustification: ParagraphJustificationOptions; /** * Paragraph kashida width. 0 is none, 1 is short, 2 is medium, 3 is long */ paragraphKashidaWidth: number; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphShadingBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomLeftCornerRadius: number | string; /** * The distance to offset the bottom edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph shading. */ paragraphShadingBottomOrigin: ParagraphShadingBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphShadingBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomRightCornerRadius: number | string; /** * If true, forces the shading of the paragraph to be clipped with respect to * frame shape. */ paragraphShadingClipToFrame: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * shading. Can return: Swatch or String. */ paragraphShadingColor: Swatch | string; /** * The distance to offset the left edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingLeftOffset: number | string; /** * If true, the paragraph shading is On. */ paragraphShadingOn: boolean; /** * If true, the paragraph shading will overprint. */ paragraphShadingOverprint: boolean; /** * The distance to offset the right edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingRightOffset: number | string; /** * If true, suppress printing of the shading of the paragraph. */ paragraphShadingSuppressPrinting: boolean; /** * The tint (as a percentage) of the paragraph shading. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphShadingTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphShadingTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopLeftCornerRadius: number | string; /** * The distance to offset the top edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph shading. */ paragraphShadingTopOrigin: ParagraphShadingTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphShadingTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopRightCornerRadius: number | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph shading. */ paragraphShadingWidth: ParagraphShadingWidthEnum; /** * A collection of paragraphs. */ readonly paragraphs: Paragraphs; /** * The parent of the Story (a XMLElement or Document). */ readonly parent: Document | XMLElement; /** * The text size. * @remarks Measurement unit — also accepts a string such as "12mm". */ pointSize: number | string; /** * A collection of polygons. */ readonly polygons: Polygons; /** * The text position relative to the baseline. */ position: Position; /** * The OpenType positional form. */ positionalForm: PositionalForms; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The hyphenation style chosen for the provider. */ providerHyphenationStyle: HyphenationStyleEnum; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * If true, disallows line breaks in numbers. If false, lines can break between * digits in multi-digit numbers. */ rensuuji: boolean; /** * The width of the right indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ rightIndent: number | string; /** * If true, rotates Roman characters in vertical text. */ rotateSingleByteCharacters: boolean; /** * The ruby alignment. */ rubyAlignment: RubyAlignments; /** * If true, auto aligns ruby. */ rubyAutoAlign: boolean; /** * If true, automatically scales ruby to the specified percent of parent text * size. For information on specifying a percent, see ruby parent scaling * percent. */ rubyAutoScaling: boolean; /** * If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to * fit one em. */ rubyAutoTcyAutoScale: boolean; /** * The number of digits included in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyDigits: number; /** * If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyIncludeRoman: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby * characters. Can return: Swatch or String. */ rubyFill: Swatch | string; /** * If true, ruby is on. */ rubyFlag: boolean; /** * The font applied to ruby characters. Can return: Font or String. */ rubyFont: Font | string; /** * The size (in points) of ruby characters. */ rubyFontSize: number; /** * The font style of ruby characters. Can return: String or NothingEnum * enumerator. */ rubyFontStyle: string | NothingEnum; /** * If true, uses OpenType Pro fonts for ruby. */ rubyOpenTypePro: boolean; /** * If true, constrains ruby overhang to the specified amount. For information * on specifying an amount, see ruby parent overhang amount. */ rubyOverhang: boolean; /** * The method of overprinting the ruby fill. */ rubyOverprintFill: AdornmentOverprint; /** * The method of overprinting the ruby stroke. */ rubyOverprintStroke: AdornmentOverprint; /** * The amount by which ruby characters can overhang the parent text. */ rubyParentOverhangAmount: RubyOverhang; /** * The amount (as a percentage) to scale the parent text size to determine the * ruby text size. */ rubyParentScalingPercent: number; /** * The ruby spacing relative to the parent text. */ rubyParentSpacing: RubyParentSpacing; /** * The position of ruby characters relative to the parent text. */ rubyPosition: RubyKentenPosition; /** * The ruby string contents. */ rubyString: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * ruby characters. Can return: Swatch or String. */ rubyStroke: Swatch | string; /** * The stroke tint (as a percentage) of ruby characters. */ rubyStrokeTint: number; /** * The tint (as a percentage) of the ruby fill color. (Range: 0 to 100) * @remarks Range: 0 to 100 */ rubyTint: number; /** * The ruby type. */ rubyType: RubyTypes; /** * The stroke weight (in points) of ruby characters. */ rubyWeight: number; /** * The amount of horizontal space between ruby and parent characters. */ rubyXOffset: number; /** * The horizontal size of ruby characters, specified as a percent of the * original size. */ rubyXScale: number; /** * The amount of vertical space between ruby and parent characters. */ rubyYOffset: number; /** * The vertical size of ruby characters, specified as a percent of the original * size. */ rubyYScale: number; /** * If true, places a rule above the paragraph. */ ruleAbove: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule above. Can return: Swatch or String. */ ruleAboveColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule above. Note: Valid only when the paragraph rule above * type is not solid. Can return: Swatch or String. */ ruleAboveGapColor: Swatch | string; /** * If true, the stroke gap of the paragraph rule above will overprint. Note: * Valid only the rule above type is not solid. */ ruleAboveGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule. * (Range: 0 to 100) Note: Valid only when the rule above type is not solid. * @remarks Range: 0 to 100 */ ruleAboveGapTint: number; /** * The distance to indent the left edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLeftIndent: number | string; /** * The line weight of the rule above. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLineWeight: number | string; /** * The amount to offset the paragraph rule above from the baseline of the first * line the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveOffset: number | string; /** * If true, the paragraph rule above will overprint. */ ruleAboveOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleAboveTint: number; /** * The stroke type of the rule above the paragraph. Can return: StrokeStyle or * String. */ ruleAboveType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule above. */ ruleAboveWidth: RuleWidth; /** * If true, applies a paragraph rule below. */ ruleBelow: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule below. Can return: Swatch or String. */ ruleBelowColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule below. Note: Valid only when the paragraph rule below * type is not solid. Can return: Swatch or String. */ ruleBelowGapColor: Swatch | string; /** * If true, the gap color of the rule below will overprint. */ ruleBelowGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule * below. (Range: 0 to 100) Note: Valid only when the paragraph rule below type * is not solid. * @remarks Range: 0 to 100 */ ruleBelowGapTint: number; /** * The distance to indent the left edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLeftIndent: number | string; /** * The line weight of the rule below. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLineWeight: number | string; /** * The amount to offset the the paragraph rule below from the baseline of the * last line of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowOffset: number | string; /** * If true, the rule below will overprint. */ ruleBelowOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleBelowTint: number; /** * The stroke type of the rule below the paragraph. Can return: StrokeStyle or * String. */ ruleBelowType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule below. */ ruleBelowWidth: RuleWidth; /** * The space between paragraphs using same style. Can return: Unit or Spacing * enumerator. */ sameParaStyleSpacing: number | Spacing; /** * If true, the line changes size when characters are scaled. */ scaleAffectsLineHeight: boolean; /** * If true, applies shatai rotation. */ shataiAdjustRotation: boolean; /** * If true, adjusts shatai tsume. */ shataiAdjustTsume: boolean; /** * The shatai lens angle (in degrees). */ shataiDegreeAngle: number; /** * The amount (as a percentage) of shatai obliquing to apply. */ shataiMagnification: number; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * The alignment to use for lines that contain a single word. */ singleWordJustification: SingleWordJustification; /** * The skew angle of the Story. */ skew: number; /** * The height of the paragraph space below. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceAfter: number | string; /** * The height of the paragraph space above. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceBefore: number | string; /** * The minimum space after a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceAfter: number | string; /** * The minimum space before a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceBefore: number | string; /** * Whether a paragraph should be a single column, span columns or split columns */ spanColumnType: SpanColumnTypeOptions; /** * The number of columns a paragraph spans or the number of split columns. Can * return: Short Integer (1 - 40) or SpanColumnCountOptions enumerator. */ spanSplitColumnCount: number | SpanColumnCountOptions; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The inside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnInsideGutter: number | string; /** * The outside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnOutsideGutter: number | string; /** * The location at which to start the paragraph. */ startParagraph: StartParagraph; /** * Story preference settings. */ readonly storyPreferences: StoryPreference; /** * Title for this InCopy story. */ storyTitle: string; /** * The type of story. */ readonly storyType: StoryTypes; /** * The swatch (color, gradient, tint, or mixed ink) applied to the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughGapColor: Swatch | string; /** * If true, the gap color of the strikethrough stroke will overprint. Note: * Valid when strike through type is not solid. */ strikeThroughGapOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 * to 100) Note: Valid when strike through type is not solid. * @remarks Range: 0 to 100 */ strikeThroughGapTint: number; /** * The amount by which to offset the strikethrough stroke from the text * baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughOffset: number | string; /** * If true, the strikethrough stroke will overprint. */ strikeThroughOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ strikeThroughTint: number; /** * The stroke type of the strikethrough stroke. Can return: StrokeStyle or * String. */ strikeThroughType: StrokeStyle | string; /** * The stroke weight of the strikethrough stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughWeight: number | string; /** * If true, draws a strikethrough line through the text. */ strikeThru: boolean; /** * The stroke alignment applied to the text. */ strokeAlignment: TextStrokeAlign; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the Story. Can also accept: String. */ strokeColor: Swatch | string; /** * The tint (as a percentage) of the stroke color of the Story. (To specify a * tint percentage, use a number in the range of 0 to 100; to use the inherited * or overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * The stroke weight applied to the characters of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * If true, the applied style has been overridden with additional attributes. */ readonly styleOverridden: boolean; /** * A list of the tab stops in the paragraph. Can return: Array of Arrays of * Property Name/Value Pairs. */ tabList: any[][][]; /** * A collection of tab stops. */ readonly tabStops: TabStops; /** * A collection of table style mappings. */ readonly tableStyleMappings: TableStyleMappings; /** * A collection of tables. */ readonly tables: Tables; /** * If true, makes the character horizontal in vertical text. */ tatechuyoko: boolean; /** * The horizontal offset for horizontal characters in vertical text. */ tatechuyokoXOffset: number; /** * The vertical offset for horizontal characters in vertical text. */ tatechuyokoYOffset: number; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text columns. */ readonly textColumns: TextColumns; /** * Array of text frames or text paths. Can return: Array of TextFrames or * TextPaths. */ readonly textContainers: (TextFrames | TextPaths)[]; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * A collection of text style ranges. */ readonly textStyleRanges: TextStyleRanges; /** * A collection of text variable instances. */ readonly textVariableInstances: TextVariableInstances; /** * A collection of text objects. */ readonly texts: Texts; /** * If true, track changes is turned on. */ trackChanges: boolean; /** * The amount by which to loosen or tighten a block of text, specified in * thousands of an em. */ tracking: number; /** * The amount of space after each character. */ trailingAki: number; /** * If true, ideographic spaces will not wrap to the next line like text * characters. */ treatIdeographicSpaceAsSpace: boolean; /** * The amount of horizontal character compression. */ tsume: number; /** * If true, underlines the text. */ underline: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the underline * stroke. . Can return: Swatch or String. */ underlineColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * underline stroke. Note: Valid when underline type is not solid. Can return: * Swatch or String. */ underlineGapColor: Swatch | string; /** * If true, the gap color of the underline stroke will overprint. */ underlineGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of the underline stroke. (Range: * 0 to 100) Note: Valid when underline type is not solid. * @remarks Range: 0 to 100 */ underlineGapTint: number; /** * The amount by which to offset the underline from the text baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineOffset: number | string; /** * If true, the underline stroke color will overprint. */ underlineOverprint: boolean; /** * The underline stroke tint (as a percentage). (Range: 0 to 100) * @remarks Range: 0 to 100 */ underlineTint: number; /** * The stroke type of the underline stroke. Can return: StrokeStyle or String. */ underlineType: StrokeStyle | string; /** * The stroke weight of the underline stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineWeight: number | string; /** * Indicates whether the text is user or placeholder text. */ userText: boolean; /** * The vertical scaling applied to the Story. */ verticalScale: number; /** * If true, turns on warichu. */ warichu: boolean; /** * The warichu alignment. */ warichuAlignment: WarichuAlignment; /** * The minimum number of characters allowed after a line break. */ warichuCharsAfterBreak: number; /** * The minimum number of characters allowed before a line break. */ warichuCharsBeforeBreak: number; /** * The gap between lines of warichu characters. */ warichuLineSpacing: number; /** * The number of lines of warichu within a single normal line. */ warichuLines: number; /** * The amount (as a percentage) to scale parent text size to determine warichu * size. */ warichuSize: number; /** * A collection of words. */ readonly words: Words; /** * The x (horizontal) offset for diacritic adjustment. */ xOffsetDiacritic: number; /** * The y (vertical) offset for diacritic adjustment. */ yOffsetDiacritic: number; /** * Dispatched after a Story is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a Story is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds glyphs that match the find what value and replaces the glyphs with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value and replaces the text * with the change character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeTransliterate(reverseOrder?: boolean): Text[]; /** * Sets the case of the text. * @param using The text case option. */ changecase(using: ChangecaseMode): void; /** * Checks in the story or stories. * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ checkIn(versionComments?: string, forceSave?: boolean): boolean; /** * Checks out the story. */ checkOut(): boolean; /** * Clears the specified types of override. * @param overridesToClear The types of override to clear. (Optional) */ clearOverrides(overridesToClear?: OverrideType): void; /** * Convert bullets and numbering to text. */ convertBulletsAndNumberingToText(): void; /** * Converts text to outlines. Each line of text becomes a polygon object. When * the converted text is a single letter that has no internal spaces or * detached parts, the polygon contains only a single path. Note: To determine * whether a font allows the creation of outlines, see allow outlines. * @param deleteOriginal If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) */ createOutlines(deleteOriginal?: boolean): PageItem[]; /** * Duplicates the text in the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional) */ duplicate(to: LocationOptions, reference?: Cell | Column | Row | Story | Table | Text | PageItem): Text; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds glyphs that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findTransliterate(reverseOrder?: boolean): Text[]; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Story[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * If true, Nth design axis of variable font is hidden. * @param nthAxisIndex Index of design axis. */ isNthDesignAxisHidden(nthAxisIndex: number): boolean; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the text to the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional) */ move(to: LocationOptions, reference?: Cell | Column | Row | Story | Table | Text | PageItem): Text; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Recomposes the text in the Story. */ recompose(): void; /** * Deletes the Story. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Reverts the document to its state at the last save operation. */ revert(): boolean; /** * Set Nth design axis of a variable font. * @param nthAxisIndex Index of design axis. * @param nthAxisValue Value of nth design axis. */ setNthDesignAxis(nthAxisIndex: number, nthAxisValue: number): void; /** * Opens the story in a story editor window. */ storyEdit(): StoryWindow; /** * Generates a string which, if executed, will return the Story. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Story direction options. */ declare enum StoryDirectionOptions { /** * Left to right direction. */ LEFT_TO_RIGHT_DIRECTION = 1278366308, /** * Right to left direction. */ RIGHT_TO_LEFT_DIRECTION = 1379028068, /** * Unknown direction. */ UNKNOWN_DIRECTION = 1433299812, } /** * Default properties specific to frame grids. */ declare class StoryGridDataInformation extends Preference { /** * The font applied to the StoryGridDataInformation, specified as either a font * object or the name of font family. Can return: Font or String. */ appliedFont: Font | string; /** * The amount of white space between characters. */ characterAki: number; /** * The alignment of small characters to the largest character in the line. */ characterAlignment: CharacterAlignment; /** * The character count location. Note: Valid when show character count is true. */ characterCountLocation: CharacterCountLocation; /** * The character size for the character count display. */ characterCountSize: number; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The name of the font style. */ fontStyle: string; /** * The alignment to the frame grid or baseline grid. */ gridAlignment: GridAlignment; /** * The grid view setting. */ gridView: GridViewSettings; /** * The horizontal scaling applied to the StoryGridDataInformation. */ horizontalScale: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The amount of white space between lines. */ lineAki: number; /** * The line justification. */ lineAlignment: LineAlignment; /** * The parent of the StoryGridDataInformation (a Application or Document). */ readonly parent: Application | Document; /** * The text size. * @remarks Measurement unit — also accepts a string such as "12mm". */ pointSize: number | string; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The vertical scaling applied to the StoryGridDataInformation. */ verticalScale: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): StoryGridDataInformation[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * StoryGridDataInformation. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Text orientation options. */ declare enum StoryHorizontalOrVertical { /** * Orients the text horizontally. */ HORIZONTAL = 1752134266, /** * The text direction is unknown. */ UNKNOWN = 1433299822, /** * Orients the text vertically. */ VERTICAL = 1986359924, } /** * Story preferences. */ declare class StoryPreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * If true, adjust the position of characters at the edges of the frame to * provide a better appearance. */ opticalMarginAlignment: boolean; /** * The point size used as the basis for calculating optical margin alignment. * (Range: 0.1 to 1296) * @remarks Measurement unit — also accepts a string such as "12mm". */ opticalMarginSize: number | string; /** * The parent of the StoryPreference (a XmlStory, Application, Document, Story * or ObjectStyle). */ readonly parent: Application | Document | Story | ObjectStyle | XmlStory; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The direction of the story. */ storyDirection: StoryDirectionOptions; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): StoryPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the StoryPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Story type options. */ declare enum StoryTypes { /** * The story is an endnote story */ ENDNOTE_STORY = 1701737332, /** * The story is an index. */ INDEXING_STORY = 1768190836, /** * The story is a regular text story. */ REGULAR_STORY = 1919382388, /** * The story is a table of contents. */ TOC_STORY = 1953461108, } /** * A story window. */ declare class StoryWindow extends Window { /** * The bounds of the window (specified in pixels) in the form [top, left, * bottom, right]. */ bounds: number[]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the StoryWindow within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the StoryWindow. */ readonly name: string; /** * The parent of the StoryWindow (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The selected object(s). Can also accept: Object or NothingEnum enumerator. */ selection: (Object | NothingEnum)[]; /** * The key object of the selection. Can also accept: NothingEnum enumerator. */ selectionKeyObject: PageItem | NothingEnum; /** * Dispatched after the StoryWindow becomes active. This event bubbles. This * event is not cancelable. */ static readonly AFTER_ACTIVATE: string; /** * Dispatched when the value of a property changes on this StoryWindow. This * event bubbles. This event is not cancelable. */ static readonly AFTER_ATTRIBUTE_CHANGED: string; /** * Dispatched when a StoryWindow is closing. Since the close has been * committed, it can no longer be canceled. This event bubbles. This event is * not cancelable. */ static readonly AFTER_CLOSE: string; /** * Dispatched after a StoryWindow is opened. This event bubbles. This event is * not cancelable. */ static readonly AFTER_OPEN: string; /** * Dispatched after an attribute on the active selection changes. This event * bubbles. This event is not cancelable. */ static readonly AFTER_SELECTION_ATTRIBUTE_CHANGED: string; /** * Dispatched after the active selection changes. This event bubbles. This * event is not cancelable. */ static readonly AFTER_SELECTION_CHANGED: string; /** * Dispatched before a StoryWindow is closed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_CLOSE: string; /** * Dispatched before the StoryWindow becomes inactive. This event bubbles. This * event is not cancelable. */ static readonly BEFORE_DEACTIVATE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Brings the object to the front. */ bringToFront(): void; /** * Closes the StoryWindow. */ close(): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): StoryWindow[]; /** * Maximizes the window. */ maximize(): void; /** * Minimizes the window. */ minimize(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Restores the window. */ restore(): void; /** * Selects the specified object(s). * @param selectableItems The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator. * @param existingSelection The selection status of the StoryWindow in relation to previously selected objects. (Optional) */ select(selectableItems: (any[] | NothingEnum | Object | SelectAll)[], existingSelection?: SelectionOptions): void; /** * Generates a string which, if executed, will return the StoryWindow. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of story windows. */ declare class StoryWindows { /** Returns the StoryWindow with the specified index or name. */ [index: number]: StoryWindow; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any StoryWindow in the collection. */ anyItem(): StoryWindow; /** * Displays the number of elements in the StoryWindow. */ count(): number; /** * Returns every StoryWindow in the collection. */ everyItem(): StoryWindow; /** * Returns the first StoryWindow in the collection. */ firstItem(): StoryWindow; /** * Returns the StoryWindow with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): StoryWindow; /** * Returns the StoryWindow with the specified name. * @param name The name. */ itemByName(name: string): StoryWindow; /** * Returns the StoryWindows within the specified range. * @param from The StoryWindow, index, or name at the beginning of the range. Can accept: StoryWindow, Long Integer or String. * @param to The StoryWindow, index, or name at the end of the range. Can accept: StoryWindow, Long Integer or String. */ itemByRange(from: number | StoryWindow | string, to: number | StoryWindow | string): StoryWindow[]; /** * Returns the last StoryWindow in the collection. */ lastItem(): StoryWindow; /** * Returns the middle StoryWindow in the collection. */ middleItem(): StoryWindow; /** * Returns the StoryWindow whose index follows the specified StoryWindow in the * collection. * @param obj The StoryWindow whose index comes before the desired StoryWindow. */ nextItem(obj: StoryWindow): StoryWindow; /** * Returns the StoryWindow with the index previous to the specified index. * @param obj The index of the StoryWindow that follows the desired StoryWindow. */ previousItem(obj: StoryWindow): StoryWindow; /** * Generates a string which, if executed, will return the StoryWindow. */ toSource(): string; } /** * A striped stroke style. */ declare class StripedStrokeStyle extends StrokeStyle { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the StripedStrokeStyle. */ readonly id: number; /** * The index of the StripedStrokeStyle within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the StripedStrokeStyle. */ name: string; /** * The parent of the StripedStrokeStyle (a Document or Application). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The width and position of stripes in a striped stroke pattern. Each stripe * is specified by a start-end pair in the format [start1, end1, start2, end2]; * each value indicates a percentage of the stroke weight. Each value must be * greater than the previous value. (Range: 0 to 100). * @remarks Range: 0 to 100 */ stripeArray: number[]; /** * The stroke style type. */ readonly strokeStyleType: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the StripedStrokeStyle. */ duplicate(): StripedStrokeStyle; /** * Resolves the object specifier, creating an array of object references. */ getElements(): StripedStrokeStyle[]; /** * Deletes the stroke style. * @param replacingWith The stroke style to apply in place of the deleted style. . Can accept: StrokeStyle or String. (Optional) */ remove(replacingWith?: StrokeStyle | string): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the StripedStrokeStyle. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of striped stroke styles. */ declare class StripedStrokeStyles { /** Returns the StripedStrokeStyle with the specified index or name. */ [index: number]: StripedStrokeStyle; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new StripedStrokeStyle. * @param withProperties Initial values for properties of the new StripedStrokeStyle (Optional) */ add(withProperties?: Object): StripedStrokeStyle; /** * Returns any StripedStrokeStyle in the collection. */ anyItem(): StripedStrokeStyle; /** * Displays the number of elements in the StripedStrokeStyle. */ count(): number; /** * Returns every StripedStrokeStyle in the collection. */ everyItem(): StripedStrokeStyle; /** * Returns the first StripedStrokeStyle in the collection. */ firstItem(): StripedStrokeStyle; /** * Returns the StripedStrokeStyle with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): StripedStrokeStyle; /** * Returns the StripedStrokeStyle with the specified ID. * @param id The ID. */ itemByID(id: number): StripedStrokeStyle; /** * Returns the StripedStrokeStyle with the specified name. * @param name The name. */ itemByName(name: string): StripedStrokeStyle; /** * Returns the StripedStrokeStyles within the specified range. * @param from The StripedStrokeStyle, index, or name at the beginning of the range. Can accept: StripedStrokeStyle, Long Integer or String. * @param to The StripedStrokeStyle, index, or name at the end of the range. Can accept: StripedStrokeStyle, Long Integer or String. */ itemByRange(from: number | StripedStrokeStyle | string, to: number | StripedStrokeStyle | string): StripedStrokeStyle[]; /** * Returns the last StripedStrokeStyle in the collection. */ lastItem(): StripedStrokeStyle; /** * Returns the middle StripedStrokeStyle in the collection. */ middleItem(): StripedStrokeStyle; /** * Returns the StripedStrokeStyle whose index follows the specified * StripedStrokeStyle in the collection. * @param obj The StripedStrokeStyle whose index comes before the desired StripedStrokeStyle. */ nextItem(obj: StripedStrokeStyle): StripedStrokeStyle; /** * Returns the StripedStrokeStyle with the index previous to the specified * index. * @param obj The index of the StripedStrokeStyle that follows the desired StripedStrokeStyle. */ previousItem(obj: StripedStrokeStyle): StripedStrokeStyle; /** * Generates a string which, if executed, will return the StripedStrokeStyle. */ toSource(): string; } /** * Options for positioning the stroke relative to its path. */ declare enum StrokeAlignment { /** * The stroke straddles the path. */ CENTER_ALIGNMENT = 1936998723, /** * The stroke is inside the path. */ INSIDE_ALIGNMENT = 1936998729, /** * The stroke is outside the path, like a picture frame. */ OUTSIDE_ALIGNMENT = 1936998735, } /** * The automatic adjustment to make to the pattern of a dashed or dotted stroke * to cover corner points in a path. */ declare enum StrokeCornerAdjustment { /** * Changes the length of dashes so that dashes always occur at path ends and * corners; maintains set gap length. Note: Can cause dashes to be different * lengths on shapes whose sides are of different lengths, such as rectangles. */ DASHES = 1162113896, /** * Adjusts both dashes and gaps to cover corners and end points. Note: Causes * dash and gap sizes to be consistent on all sides of the shape. */ DASHES_AND_GAPS = 1148405616, /** * Changes the length of gaps so that dashes or dots always occur at ends and * corners; maintains dash length or dot diameter. Note: Can cause gaps to be * different lengths on shapes whose sides are of different lengths, such as * rectangles. */ GAPS = 1164406899, /** * No adjustment. */ NONE = 1852796517, } /** * Options for the active stroke/fill proxy. */ declare enum StrokeFillProxyOptions { /** * Fill proxy is active. */ FILL = 1181314156, /** * Stroke proxy is active. */ STROKE = 1400140395, } /** * Stroke/fill proxy settings. */ declare class StrokeFillProxySetting extends Preference { /** * Which part of the stroke/fill proxy is currently active. */ active: StrokeFillProxyOptions; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * StrokeFillProxySetting. . Can also accept: String. */ fillColor: Swatch | string; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the StrokeFillProxySetting (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the StrokeFillProxySetting. Can also accept: String. */ strokeColor: Swatch | string; /** * Which target is affected by changes to the stroke/fill proxy. */ target: StrokeFillTargetOptions; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): StrokeFillProxySetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * StrokeFillProxySetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for the target of the active stroke/fill proxy. */ declare enum StrokeFillTargetOptions { /** * Formatting affects the container. */ FORMATTING_AFFECTS_CONTAINER = 1181696323, /** * Formatting affects the text. */ FORMATTING_AFFECTS_TEXT = 1181696340, } /** * Options for displaying row and column strokes at corners. */ declare enum StrokeOrderTypes { /** * Places row strokes in front of column strokes when row and column strokes * are different colors; joins striped strokes and connects crossing points. */ BEST_JOINS = 1935828330, /** * Places column strokes in front of row strokes. */ COLUMN_ON_TOP = 1935896436, /** * Places row strokes in front when row and column strokes are different * colors; joins striped strokes only at points where strokes cross in a * T-shape. */ INDESIGN_2_COMPATIBILITY = 1936286819, /** * Places row strokes in front of column strokes. */ ROW_ON_TOP = 1936879476, } /** * A stroke style. */ declare class StrokeStyle { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the StrokeStyle. */ readonly id: number; /** * The index of the StrokeStyle within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the StrokeStyle. */ name: string; /** * The parent of the StrokeStyle (a Document or Application). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The stroke style type. */ readonly strokeStyleType: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the StrokeStyle. */ duplicate(): StrokeStyle; /** * Resolves the object specifier, creating an array of object references. */ getElements(): StrokeStyle[]; /** * Deletes the stroke style. * @param replacingWith The stroke style to apply in place of the deleted style. . Can accept: StrokeStyle or String. (Optional) */ remove(replacingWith?: StrokeStyle | string): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the StrokeStyle. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of stroke styles. */ declare class StrokeStyles { /** Returns the StrokeStyle with the specified index or name. */ [index: number]: StrokeStyle; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any StrokeStyle in the collection. */ anyItem(): StrokeStyle; /** * Displays the number of elements in the StrokeStyle. */ count(): number; /** * Returns every StrokeStyle in the collection. */ everyItem(): StrokeStyle; /** * Returns the first StrokeStyle in the collection. */ firstItem(): StrokeStyle; /** * Returns the StrokeStyle with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): StrokeStyle; /** * Returns the StrokeStyle with the specified ID. * @param id The ID. */ itemByID(id: number): StrokeStyle; /** * Returns the StrokeStyle with the specified name. * @param name The name. */ itemByName(name: string): StrokeStyle; /** * Returns the StrokeStyles within the specified range. * @param from The StrokeStyle, index, or name at the beginning of the range. Can accept: StrokeStyle, Long Integer or String. * @param to The StrokeStyle, index, or name at the end of the range. Can accept: StrokeStyle, Long Integer or String. */ itemByRange(from: number | StrokeStyle | string, to: number | StrokeStyle | string): StrokeStyle[]; /** * Returns the last StrokeStyle in the collection. */ lastItem(): StrokeStyle; /** * Returns the middle StrokeStyle in the collection. */ middleItem(): StrokeStyle; /** * Returns the StrokeStyle whose index follows the specified StrokeStyle in the * collection. * @param obj The StrokeStyle whose index comes before the desired StrokeStyle. */ nextItem(obj: StrokeStyle): StrokeStyle; /** * Returns the StrokeStyle with the index previous to the specified index. * @param obj The index of the StrokeStyle that follows the desired StrokeStyle. */ previousItem(obj: StrokeStyle): StrokeStyle; /** * Generates a string which, if executed, will return the StrokeStyle. */ toSource(): string; } /** * Transparency settings for the stroke of the parent object. */ declare class StrokeTransparencySetting extends Preference { /** * Settings related to the bevel and emboss effect. */ readonly bevelAndEmbossSettings: BevelAndEmbossSetting; /** * Blending mode settings. */ readonly blendingSettings: BlendingSetting; /** * Settings related to the directional feather effect. */ readonly directionalFeatherSettings: DirectionalFeatherSetting; /** * Settings related to the drop shadow effect. */ readonly dropShadowSettings: DropShadowSetting; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Settings related to the feather effect. */ readonly featherSettings: FeatherSetting; /** * Settings related to the gradient feather effect. */ readonly gradientFeatherSettings: GradientFeatherSetting; /** * Settings related to the inner glow effect. */ readonly innerGlowSettings: InnerGlowSetting; /** * Settings related to the inner shadow effect. */ readonly innerShadowSettings: InnerShadowSetting; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * Settings related to the outer glow effect. */ readonly outerGlowSettings: OuterGlowSetting; /** * The parent of the StrokeTransparencySetting (a PageItem, HtmlItem, * FlexObject, FormField, SignatureField, TextBox, RadioButton, ListBox, * ComboBox, CheckBox, MultiStateObject, Button, MediaItem, Sound, Movie, * EPSText, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Graphic, SVG, * ImportedPage, PICT, WMF, PDF, EPS, Image, Group, TextFrame, * EndnoteTextFrame, PageItemDefault or ObjectStyle). */ readonly parent: Button | CheckBox | ComboBox | EPS | EPSText | EndnoteTextFrame | FlexObject | FormField | Graphic | GraphicLine | Group | HtmlItem | Image | ImportedPage | ListBox | MediaItem | Movie | MultiStateObject | Oval | PDF | PICT | PageItemDefault | Polygon | RadioButton | Rectangle | SVG | SignatureField | Sound | SplineItem | TextBox | TextFrame | WMF | ObjectStyle | PageItem; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Settings related to the satin effect */ readonly satinSettings: SatinSetting; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): StrokeTransparencySetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * StrokeTransparencySetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for resolving style conflicts when importing tagged text. */ declare enum StyleConflict { /** * Uses the publication style. */ PUBLICATION_DEFINITION = 1414819940, /** * Uses the tag file style. */ TAG_FILE_DEFINITION = 1413903460, } /** * A mapping object that maps an export type to an export tag. */ declare class StyleExportTagMap { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The attributes to map. */ exportAttributes: string; /** * The class to map. */ exportClass: string; /** * The tag to map. */ exportTag: string; /** * The type of export. */ readonly exportType: string; /** * The index of the StyleExportTagMap within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the StyleExportTagMap (a CharacterStyle or ParagraphStyle). */ readonly parent: CharacterStyle | ParagraphStyle; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): StyleExportTagMap[]; /** * Deletes the StyleExportTagMap. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the StyleExportTagMap. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of style export tag maps. */ declare class StyleExportTagMaps { /** Returns the StyleExportTagMap with the specified index or name. */ [index: number]: StyleExportTagMap; /** * The number of objects in the collection. */ readonly length: number; /** * Create a new mapping * @param exportType The type of export. * @param exportTag The tag to map. * @param exportClass The class to map. * @param exportAttributes The attributes to map. * @param withProperties Initial values for properties of the new StyleExportTagMap (Optional) */ add(exportType: string, exportTag: string, exportClass: string, exportAttributes: string, withProperties?: Object): StyleExportTagMap; /** * Returns any StyleExportTagMap in the collection. */ anyItem(): StyleExportTagMap; /** * Displays the number of elements in the StyleExportTagMap. */ count(): number; /** * Returns every StyleExportTagMap in the collection. */ everyItem(): StyleExportTagMap; /** * Returns the first StyleExportTagMap in the collection. */ firstItem(): StyleExportTagMap; /** * Returns the StyleExportTagMap with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): StyleExportTagMap; /** * Returns the StyleExportTagMaps within the specified range. * @param from The StyleExportTagMap, index, or name at the beginning of the range. Can accept: StyleExportTagMap, Long Integer or String. * @param to The StyleExportTagMap, index, or name at the end of the range. Can accept: StyleExportTagMap, Long Integer or String. */ itemByRange(from: number | StyleExportTagMap | string, to: number | StyleExportTagMap | string): StyleExportTagMap[]; /** * Returns the last StyleExportTagMap in the collection. */ lastItem(): StyleExportTagMap; /** * Returns the middle StyleExportTagMap in the collection. */ middleItem(): StyleExportTagMap; /** * Returns the StyleExportTagMap whose index follows the specified * StyleExportTagMap in the collection. * @param obj The StyleExportTagMap whose index comes before the desired StyleExportTagMap. */ nextItem(obj: StyleExportTagMap): StyleExportTagMap; /** * Returns the StyleExportTagMap with the index previous to the specified * index. * @param obj The index of the StyleExportTagMap that follows the desired StyleExportTagMap. */ previousItem(obj: StyleExportTagMap): StyleExportTagMap; /** * Generates a string which, if executed, will return the StyleExportTagMap. */ toSource(): string; } /** * Style Type */ declare enum StyleType { /** * Character Style */ CHARACTER_STYLE_TYPE = 1665684340, /** * Paragraph Style */ PARAGRAPH_STYLE_TYPE = 1883730548, } /** * A submenu. */ declare class Submenu extends MenuElement { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the Submenu within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A collection of menu elements. */ readonly menuElements: MenuElements; /** * A collection of menu items. */ readonly menuItems: MenuItems; /** * A collection of menu separators. */ readonly menuSeparators: MenuSeparators; /** * The name of the Submenu. */ readonly name: string; /** * The parent of the Submenu (a Menu or Submenu). */ readonly parent: Menu | Submenu; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of submenus. */ readonly submenus: Submenus; /** * The name of the Submenu for display in the user interface. The title * includes any ampersand characters (&), which are used to tell the Windows OS * to underline the following character in the name for use with the Alt key to * navigate to a menu item. Double ampersands are used to display an actual * ampersand character in the name. The Mac OS ignores and removes the extra * ampersand characters. */ readonly title: string; /** * Dispatched before the Submenu is displayed. This event does not bubble. This * event is not cancelable. */ static readonly BEFORE_DISPLAY: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Submenu[]; /** * Deletes the Submenu. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Submenu. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of submenus. */ declare class Submenus { /** Returns the Submenu with the specified index or name. */ [index: number]: Submenu; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new submenu. * @param title The name of the Submenu for display in the user interface. The title includes any ampersand characters (&), which are used to tell the Windows OS to underline the following character in the name for use with the Alt key to navigate to a menu item. Double ampersands are used to display an actual ampersand character in the name. The Mac OS ignores and removes the extra ampersand characters. * @param at The location of the submenu relative to the reference object or within the containing object. (Optional) * @param reference The reference object. Note: Required when the at parameter specifies before or after. (Optional) * @param withProperties Initial values for properties of the new Submenu (Optional) */ add(title: string, at?: LocationOptions, reference?: MenuElement, withProperties?: Object): Submenu; /** * Returns any Submenu in the collection. */ anyItem(): Submenu; /** * Displays the number of elements in the Submenu. */ count(): number; /** * Returns every Submenu in the collection. */ everyItem(): Submenu; /** * Returns the first Submenu in the collection. */ firstItem(): Submenu; /** * Returns the Submenu with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Submenu; /** * Returns the Submenu with the specified name. * @param name The name. */ itemByName(name: string): Submenu; /** * Returns the Submenus within the specified range. * @param from The Submenu, index, or name at the beginning of the range. Can accept: Submenu, Long Integer or String. * @param to The Submenu, index, or name at the end of the range. Can accept: Submenu, Long Integer or String. */ itemByRange(from: number | Submenu | string, to: number | Submenu | string): Submenu[]; /** * Returns the last Submenu in the collection. */ lastItem(): Submenu; /** * Returns the middle Submenu in the collection. */ middleItem(): Submenu; /** * Returns the Submenu whose index follows the specified Submenu in the * collection. * @param obj The Submenu whose index comes before the desired Submenu. */ nextItem(obj: Submenu): Submenu; /** * Returns the Submenu with the index previous to the specified index. * @param obj The index of the Submenu that follows the desired Submenu. */ previousItem(obj: Submenu): Submenu; /** * Generates a string which, if executed, will return the Submenu. */ toSource(): string; } /** * A behavior object that submits the document. */ declare class SubmitFormBehavior extends Behavior { /** * The event which triggers the behavior. */ behaviorEvent: BehaviorEvents; /** * If true, the behavior is enabled. */ enableBehavior: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the SubmitFormBehavior. */ readonly id: number; /** * The index of the SubmitFormBehavior within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the SubmitFormBehavior. */ readonly name: string; /** * The parent of the SubmitFormBehavior (a Button, CheckBox, ComboBox, ListBox, * RadioButton, TextBox or SignatureField). */ readonly parent: CheckBox | ComboBox | ListBox | RadioButton | TextBox | Button | SignatureField; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The URL. */ url: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): SubmitFormBehavior[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the SubmitFormBehavior. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the SubmitFormBehavior. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of submit form behavior objects. */ declare class SubmitFormBehaviors { /** Returns the SubmitFormBehavior with the specified index or name. */ [index: number]: SubmitFormBehavior; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new SubmitFormBehavior. * @param withProperties Initial values for properties of the new SubmitFormBehavior (Optional) */ add(withProperties?: Object): SubmitFormBehavior; /** * Returns any SubmitFormBehavior in the collection. */ anyItem(): SubmitFormBehavior; /** * Displays the number of elements in the SubmitFormBehavior. */ count(): number; /** * Returns every SubmitFormBehavior in the collection. */ everyItem(): SubmitFormBehavior; /** * Returns the first SubmitFormBehavior in the collection. */ firstItem(): SubmitFormBehavior; /** * Returns the SubmitFormBehavior with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): SubmitFormBehavior; /** * Returns the SubmitFormBehavior with the specified ID. * @param id The ID. */ itemByID(id: number): SubmitFormBehavior; /** * Returns the SubmitFormBehavior with the specified name. * @param name The name. */ itemByName(name: string): SubmitFormBehavior; /** * Returns the SubmitFormBehaviors within the specified range. * @param from The SubmitFormBehavior, index, or name at the beginning of the range. Can accept: SubmitFormBehavior, Long Integer or String. * @param to The SubmitFormBehavior, index, or name at the end of the range. Can accept: SubmitFormBehavior, Long Integer or String. */ itemByRange(from: number | SubmitFormBehavior | string, to: number | SubmitFormBehavior | string): SubmitFormBehavior[]; /** * Returns the last SubmitFormBehavior in the collection. */ lastItem(): SubmitFormBehavior; /** * Returns the middle SubmitFormBehavior in the collection. */ middleItem(): SubmitFormBehavior; /** * Returns the SubmitFormBehavior whose index follows the specified * SubmitFormBehavior in the collection. * @param obj The SubmitFormBehavior whose index comes before the desired SubmitFormBehavior. */ nextItem(obj: SubmitFormBehavior): SubmitFormBehavior; /** * Returns the SubmitFormBehavior with the index previous to the specified * index. * @param obj The index of the SubmitFormBehavior that follows the desired SubmitFormBehavior. */ previousItem(obj: SubmitFormBehavior): SubmitFormBehavior; /** * Generates a string which, if executed, will return the SubmitFormBehavior. */ toSource(): string; } /** * A swatch (color, gradient, tint, or mixed ink). */ declare class Swatch { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the Swatch. */ readonly id: number; /** * The index of the Swatch within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the Swatch. */ name: string; /** * The parent of the Swatch (a Application or Document). */ readonly parent: Application | Document; /** * The color group that a swatch belongs to */ readonly parentColorGroup: ColorGroup; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the Swatch. */ duplicate(): Swatch; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Swatch[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Merges the specified swatches with the swatch. * @param with_ The swatches to merge. Can accept: Array of Swatches, Swatch or String. */ merge(with_: (Swatches | Swatch | string)[]): Swatch; /** * Deletes the swatch. * @param replacingWith The swatch to apply in place of the deleted swatch. (Optional) */ remove(replacingWith?: Swatch): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Swatch. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of swatches. */ declare class Swatches { /** Returns the Swatch with the specified index or name. */ [index: number]: Swatch; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Swatch in the collection. */ anyItem(): Swatch; /** * Displays the number of elements in the Swatch. */ count(): number; /** * Returns every Swatch in the collection. */ everyItem(): Swatch; /** * Returns the first Swatch in the collection. */ firstItem(): Swatch; /** * Returns the Swatch with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Swatch; /** * Returns the Swatch with the specified ID. * @param id The ID. */ itemByID(id: number): Swatch; /** * Returns the Swatch with the specified name. * @param name The name. */ itemByName(name: string): Swatch; /** * Returns the Swatches within the specified range. * @param from The Swatch, index, or name at the beginning of the range. Can accept: Swatch, Long Integer or String. * @param to The Swatch, index, or name at the end of the range. Can accept: Swatch, Long Integer or String. */ itemByRange(from: number | Swatch | string, to: number | Swatch | string): Swatch[]; /** * Returns the last Swatch in the collection. */ lastItem(): Swatch; /** * Returns the middle Swatch in the collection. */ middleItem(): Swatch; /** * Returns the Swatch whose index follows the specified Swatch in the * collection. * @param obj The Swatch whose index comes before the desired Swatch. */ nextItem(obj: Swatch): Swatch; /** * Returns the Swatch with the index previous to the specified index. * @param obj The index of the Swatch that follows the desired Swatch. */ previousItem(obj: Swatch): Swatch; /** * Generates a string which, if executed, will return the Swatch. */ toSource(): string; } /** * The type of conflict resolution to employ during Version Cue * synchronization. */ declare enum SyncConflictResolution { /** * Asks the user how to resolve conflicts. */ ASK_ABOUT_CONFLICTS = 1986216769, /** * Uses the local version. */ PREFER_LOCAL = 1986216780, /** * Uses the project version. */ PREFER_PROJECT = 1986216784, /** * Skips conflicting files. */ SKIP_CONFLICTS = 1986216787, } /** * A TOC style definition. */ declare class TOCStyle { /** * If true, creates bookmarks for TOC entries. */ createBookmarks: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the TOCStyle. */ readonly id: number; /** * If true, includes the entire book in the TOC. If false, includes only the * TOC entries in the current document. Note: Valid when the current document * is part of a book. */ includeBookDocuments: boolean; /** * If true, the TOC includes entries from text on hidden layers. */ includeHidden: boolean; /** * The index of the TOCStyle within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * If true, make text anchor in source paragraph. */ makeAnchor: boolean; /** * The name of the TOCStyle. */ name: string; /** * The format for importing numbered paragraphs into the TOC. */ numberedParagraphs: NumberedParagraphsOptions; /** * The parent of the TOCStyle (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, remove forced line breaks. */ removeForcedLineBreak: boolean; /** * If true, the lowest-level TOC entries are placed on the same line as the * previous entry. */ runIn: boolean; /** * The table of contents story direction. */ setStoryDirection: HorizontalOrVertical; /** * The TOC title. */ title: string; /** * The paragraph style applied to the TOC title. */ titleStyle: ParagraphStyle; /** * A collection TOC style entries. */ readonly tocStyleEntries: TOCStyleEntries; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the TOCStyle. */ duplicate(): TOCStyle; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TOCStyle[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the TOCStyle. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TOCStyle. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection TOC style entries. */ declare class TOCStyleEntries { /** Returns the TOCStyleEntry with the specified index or name. */ [index: number]: TOCStyleEntry; /** * The number of objects in the collection. */ readonly length: number; /** * Adds a TOC style entry. * @param styleName The paragraph style to include as TOC entries in the TOC. (Optional) * @param withProperties Initial values for properties of the new TOCStyleEntry (Optional) */ add(styleName?: string, withProperties?: Object): TOCStyleEntry; /** * Returns any TOCStyleEntry in the collection. */ anyItem(): TOCStyleEntry; /** * Displays the number of elements in the TOCStyleEntry. */ count(): number; /** * Returns every TOCStyleEntry in the collection. */ everyItem(): TOCStyleEntry; /** * Returns the first TOCStyleEntry in the collection. */ firstItem(): TOCStyleEntry; /** * Returns the TOCStyleEntry with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): TOCStyleEntry; /** * Returns the TOCStyleEntry with the specified name. * @param name The name. */ itemByName(name: string): TOCStyleEntry; /** * Returns the TOCStyleEntries within the specified range. * @param from The TOCStyleEntry, index, or name at the beginning of the range. Can accept: TOCStyleEntry, Long Integer or String. * @param to The TOCStyleEntry, index, or name at the end of the range. Can accept: TOCStyleEntry, Long Integer or String. */ itemByRange(from: number | TOCStyleEntry | string, to: number | TOCStyleEntry | string): TOCStyleEntry[]; /** * Returns the last TOCStyleEntry in the collection. */ lastItem(): TOCStyleEntry; /** * Returns the middle TOCStyleEntry in the collection. */ middleItem(): TOCStyleEntry; /** * Returns the TOCStyleEntry whose index follows the specified TOCStyleEntry in * the collection. * @param obj The TOCStyleEntry whose index comes before the desired TOCStyleEntry. */ nextItem(obj: TOCStyleEntry): TOCStyleEntry; /** * Returns the TOCStyleEntry with the index previous to the specified index. * @param obj The index of the TOCStyleEntry that follows the desired TOCStyleEntry. */ previousItem(obj: TOCStyleEntry): TOCStyleEntry; /** * Generates a string which, if executed, will return the TOCStyleEntry. */ toSource(): string; } /** * A TOC entry definition. */ declare class TOCStyleEntry { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The paragraph style applied to the TOC entry. Can return: ParagraphStyle or * String. */ formatStyle: ParagraphStyle | string; /** * The index of the TOCStyleEntry within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The indent level of the entry in the TOC. */ level: number; /** * The name of the TOCStyleEntry. */ name: string; /** * The page number placement for the TOC entry style. */ pageNumberPosition: PageNumberPosition; /** * The character style applied to the page number of the entry. Can return: * CharacterStyle or String. */ pageNumberStyle: CharacterStyle | string; /** * The parent of the TOCStyleEntry (a TOCStyle). */ readonly parent: TOCStyle; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The string to insert between the entry text and the page numbers. */ separator: string; /** * The character style applied to the string separating the TOC entry text and * the page numbers. Can return: CharacterStyle or String. */ separatorStyle: CharacterStyle | string; /** * If true, sorts the entries alphabetically. */ sortAlphabet: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TOCStyleEntry[]; /** * Deletes the TOCStyleEntry. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TOCStyleEntry. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of TOC styles. */ declare class TOCStyles { /** Returns the TOCStyle with the specified index or name. */ [index: number]: TOCStyle; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new TOCStyle. * @param withProperties Initial values for properties of the new TOCStyle (Optional) */ add(withProperties?: Object): TOCStyle; /** * Returns any TOCStyle in the collection. */ anyItem(): TOCStyle; /** * Displays the number of elements in the TOCStyle. */ count(): number; /** * Returns every TOCStyle in the collection. */ everyItem(): TOCStyle; /** * Returns the first TOCStyle in the collection. */ firstItem(): TOCStyle; /** * Returns the TOCStyle with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): TOCStyle; /** * Returns the TOCStyle with the specified ID. * @param id The ID. */ itemByID(id: number): TOCStyle; /** * Returns the TOCStyle with the specified name. * @param name The name. */ itemByName(name: string): TOCStyle; /** * Returns the TOCStyles within the specified range. * @param from The TOCStyle, index, or name at the beginning of the range. Can accept: TOCStyle, Long Integer or String. * @param to The TOCStyle, index, or name at the end of the range. Can accept: TOCStyle, Long Integer or String. */ itemByRange(from: number | TOCStyle | string, to: number | TOCStyle | string): TOCStyle[]; /** * Returns the last TOCStyle in the collection. */ lastItem(): TOCStyle; /** * Returns the middle TOCStyle in the collection. */ middleItem(): TOCStyle; /** * Returns the TOCStyle whose index follows the specified TOCStyle in the * collection. * @param obj The TOCStyle whose index comes before the desired TOCStyle. */ nextItem(obj: TOCStyle): TOCStyle; /** * Returns the TOCStyle with the index previous to the specified index. * @param obj The index of the TOCStyle that follows the desired TOCStyle. */ previousItem(obj: TOCStyle): TOCStyle; /** * Generates a string which, if executed, will return the TOCStyle. */ toSource(): string; } /** * A tab stop. */ declare class TabStop { /** * The tab stop alignment. */ alignment: TabStopAlignment; /** * The tab stop alignment character. Note: Valid when alignment is character * align. */ alignmentCharacter: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the TabStop within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The tab stop leader. */ leader: string; /** * The parent of the TabStop (a TextDefault, Paragraph, ParagraphStyle, Text, * InsertionPoint, TextStyleRange, TextColumn, Line, Word, Character, Story or * XmlStory). */ readonly parent: Character | InsertionPoint | Line | Paragraph | ParagraphStyle | Story | Text | TextColumn | TextStyleRange | Word | TextDefault | XmlStory; /** * The position of the tab stop. * @remarks Measurement unit — also accepts a string such as "12mm". */ position: number | string; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TabStop[]; /** * Deletes the TabStop. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TabStop. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Tab stop alignment options. */ declare enum TabStopAlignment { /** * Center. */ CENTER_ALIGN = 1667591796, /** * Aligns the specified character with the tab stop. */ CHARACTER_ALIGN = 1952604515, /** * Left. */ LEFT_ALIGN = 1818584692, /** * Right. */ RIGHT_ALIGN = 1919379572, } /** * A collection of tab stops. */ declare class TabStops { /** Returns the TabStop with the specified index or name. */ [index: number]: TabStop; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new TabStop. * @param withProperties Initial values for properties of the new TabStop (Optional) */ add(withProperties?: Object): TabStop; /** * Returns any TabStop in the collection. */ anyItem(): TabStop; /** * Displays the number of elements in the TabStop. */ count(): number; /** * Returns every TabStop in the collection. */ everyItem(): TabStop; /** * Returns the first TabStop in the collection. */ firstItem(): TabStop; /** * Returns the TabStop with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): TabStop; /** * Returns the TabStops within the specified range. * @param from The TabStop, index, or name at the beginning of the range. Can accept: TabStop, Long Integer or String. * @param to The TabStop, index, or name at the end of the range. Can accept: TabStop, Long Integer or String. */ itemByRange(from: number | TabStop | string, to: number | TabStop | string): TabStop[]; /** * Returns the last TabStop in the collection. */ lastItem(): TabStop; /** * Returns the middle TabStop in the collection. */ middleItem(): TabStop; /** * Returns the TabStop whose index follows the specified TabStop in the * collection. * @param obj The TabStop whose index comes before the desired TabStop. */ nextItem(obj: TabStop): TabStop; /** * Returns the TabStop with the index previous to the specified index. * @param obj The index of the TabStop that follows the desired TabStop. */ previousItem(obj: TabStop): TabStop; /** * Generates a string which, if executed, will return the TabStop. */ toSource(): string; } /** * A table. */ declare class Table { /** * Lists all graphics contained by the Table. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the Table. */ readonly allPageItems: PageItem[]; /** * The pattern for alternating fills. */ alternatingFills: AlternatingFillsTypes; /** * The table style applied to the table. Can also accept: String. */ appliedTableStyle: TableStyle | string; /** * The XML element associated with the Table. */ readonly associatedXMLElement: XMLItem; /** * The number of body rows. * @remarks Range: 1 to 10000 */ bodyRowCount: number; /** * The color, specified as a swatch (color, gradient, tint, or mixed ink), of * the bottom border stroke. */ bottomBorderStrokeColor: Swatch; /** * The gap color, specified as a swatch (color, gradient, tint, or mixed ink), * of the bottom border stroke. Note: Valid only when bottom border stroke type * is not solid. */ bottomBorderStrokeGapColor: Swatch; /** * If true, the gap of the bottom border stroke will overprint. Note: Valid * only when bottom border stroke type is not solid. */ bottomBorderStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of the bottom border stroke. * (Range: 0 to 100) Note: Valid only when bottom border stroke type is not * solid. * @remarks Range: 0 to 100 */ bottomBorderStrokeGapTint: number; /** * If true, the bottom border stroke will overprint. */ bottomBorderStrokeOverprint: boolean; /** * The tint (as a percentage) of the bottom border stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ bottomBorderStrokeTint: number; /** * The stroke type of the bottom border. Can also accept: String. */ bottomBorderStrokeType: StrokeStyle | string; /** * The stroke weight of the bottom border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomBorderStrokeWeight: number | string; /** * The footer placement. */ breakFooters: HeaderFooterBreakTypes; /** * The header placement. */ breakHeaders: HeaderFooterBreakTypes; /** * A collection of buttons. */ readonly buttons: Buttons; /** * The number of paragraphs adjacent to the table that are designated as a * table caption for PDF/UA export. Use 0 to disable. * @remarks Range: 0 to 100 */ captionParagraphCount: number; /** * Whether the caption paragraphs come before or after the table. */ captionPosition: TableCaptionPositionOptions; /** * A collection of table cells. */ readonly cells: Cells; /** * A collection of changes. */ readonly changes: Changes; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * If true, clips the graphic cell's content to width and height of the cell. */ clipContentToGraphicCell: boolean; /** * If true, clips the text cell's content to width and height of the cell. */ clipContentToTextCell: boolean; /** * The number of columns. * @remarks Range: 1 to 200 */ columnCount: number; /** * If true, hides alternating row fills. If false, hides alternating column * fills. */ columnFillsPriority: boolean; /** * A collection of table columns. */ readonly columns: Columns; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * The contents to place in cells, specified as an array whose first item * populates the top left cell and whose second item populates the next cell to * the right, and so on until each cell in the top row is populated, at which * point the next item populates the left-most cell in the second row, and so * on. Note: If the array contains fewer strings than the table contains cells, * the remaining cells are left blank. Can return: Array of Strings or * SpecialCharacters enumerators. Can also accept: Array of Strings, * SpecialCharacters enumerators or NothingEnum enumerators. */ contents: (string[] | SpecialCharacters | NothingEnum[])[]; /** * If true, then the table will show collapsed in story and galley views. */ displayCollapsed: boolean; /** * Specifies the order the table cells will display in when viewing in story * and galley views. */ displayOrder: DisplayOrderOptions; /** * The fill color, specified as a swatch (color, gradient, tint, or mixed ink), * of columns in the second alternating fill group. Note: Valid when * alternating fills are defined for table columns. */ endColumnFillColor: Swatch; /** * The number of columns in the second alternating fills group. Note: Valid * when alternating fills are defined for table columns. */ endColumnFillCount: number; /** * If true, the columns in the second alternating fills group will overprint. * Note: Valid when alternating fills are defined for table columns. */ endColumnFillOverprint: boolean; /** * The tint (as a percentage) of the columns in the second alternating fills * group. (Range: 0 to 100) Note: Valid when alternating fills are defined for * table columns. * @remarks Range: 0 to 100 */ endColumnFillTint: number; /** * The stroke type of columns in the second alternating strokes group. Can also * accept: String. */ endColumnLineStyle: StrokeStyle | string; /** * The stroke color, specified as a swatch (color, gradient, tint, or mixed * ink), of column borders in the second alternating column strokes group. * Note: Valid when end column stroke count is 1 or greater. */ endColumnStrokeColor: Swatch; /** * The number of columns in the second alternating column strokes group. */ endColumnStrokeCount: number; /** * The stroke gap color, specified as a swatch (color, gradient, tint, or mixed * ink), of column borders in the second alternating column strokes group. * Note: Valid when end column stroke count is 1 or greater. */ endColumnStrokeGapColor: Swatch; /** * If true, the gap of the column border stroke in the second alternating * column strokes group will overprint. Note: Valid when end column stroke * count is 1 or greater. */ endColumnStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of column borders in the second * alternating column strokes group. (Range: 0 to 100) Note: Valid when end * column stroke count is 1 or greater. * @remarks Range: 0 to 100 */ endColumnStrokeGapTint: number; /** * If true, the column borders in the second alternating column strokes group * will overprint. Note: Valid when end column stroke count is 1 or greater. */ endColumnStrokeOverprint: boolean; /** * The tint (as a percentage) of column borders in the second alternating * column strokes group. (Range: 0 to 100) Note: Valid when end column stroke * count is 1 or greater. * @remarks Range: 0 to 100 */ endColumnStrokeTint: number; /** * The stroke weight of column borders in the second alternating column strokes * group. Note: Valid when end column stroke count is 1 or greater. * @remarks Measurement unit — also accepts a string such as "12mm". */ endColumnStrokeWeight: number | string; /** * The fill color, specified as a swatch (color, gradient, tint, or mixed ink), * of rows in the second alternating fills group. Note: Valid when alternating * fills are defined for table rows. */ endRowFillColor: Swatch; /** * The number of rows in the second alternating fills group. Note: Valid when * alternating fills are defined for table rows. */ endRowFillCount: number; /** * If true, the rows in the second alternating fills group will overprint. * Note: Valid when alternating fills are defined for table rows. */ endRowFillOverprint: boolean; /** * The tint (as a percentage) of the rows in the second alternating fills * group. (Range: 0 to 100) Note: Valid when alternating fills are defined for * table rows. * @remarks Range: 0 to 100 */ endRowFillTint: number; /** * The stroke color, specified as a swatch (color, gradient, tint, or mixed * ink), of row borders in the second alternating row strokes group. Note: * Valid when end row stroke count is 1 or greater. */ endRowStrokeColor: Swatch; /** * The number of rows in the second alternating row strokes group. */ endRowStrokeCount: number; /** * The gap color, specified as a swatch (color, gradient, tint, or mixed ink), * of row borders in the second alternating rows group. Note: Valid when end * row stroke count is 1 or greater. */ endRowStrokeGapColor: Swatch; /** * If true, the gap of the row borders in the second alternating rows group * will overprint. Note: Valid when end row stroke count is 1 or greater. */ endRowStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of rows in the second * alternating strokes group. (Range: 0 to 100) Note: Valid when end row stroke * count is 1 or greater and end row stroke type is not solid. * @remarks Range: 0 to 100 */ endRowStrokeGapTint: number; /** * If true, the rows in the second alternating rows group will overprint. Note: * Valid when end row stroke count is 1 or greater. */ endRowStrokeOverprint: boolean; /** * The tint (as a percentage) of the row borders in the second alternating * strokes group. (Range: 0 to 100) Note: Valid when end row stroke count is 1 * or greater. * @remarks Range: 0 to 100 */ endRowStrokeTint: number; /** * The stroke type of rows in the second alternating strokes group. Can also * accept: String. */ endRowStrokeType: StrokeStyle | string; /** * The stroke weight of row borders in the second alternating row strokes * group. Note: Valid when end row stroke count is 1 or greater. * @remarks Measurement unit — also accepts a string such as "12mm". */ endRowStrokeWeight: number | string; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * A collection of endnotes. */ readonly endnotes: Endnotes; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The number of footer rows. * @remarks Range: 0 to 25 */ footerRowCount: number; /** * A collection of footnotes. */ readonly footnotes: Footnotes; /** * A collection of form fields. */ readonly formFields: FormFields; /** * The bottom inset of the graphic cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ graphicBottomInset: number | string; /** * The left inset of the graphic cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ graphicLeftInset: number | string; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * The right inset of the graphic cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ graphicRightInset: number | string; /** * The top inset of the graphic cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ graphicTopInset: number | string; /** * A collection of groups. */ readonly groups: Groups; /** * The position (left or right) of the header columns in the table. */ headerColumnsPosition: HeaderColumnsPositionTypes; /** * The number of header rows. * @remarks Range: 0 to 25 */ headerRowCount: number; /** * The height of the Table. For a table or column, specifies the sum of the row * heights. * @remarks Measurement unit — also accepts a string such as "12mm". */ height: number | string; /** * A collection of hidden text objects. */ readonly hiddenTexts: HiddenTexts; /** * The unique ID of the Table. */ readonly id: number; /** * The index of the Table within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The color, specified as a swatch (color, gradient, tint, or mixed ink), of * the left border stroke. */ leftBorderStrokeColor: Swatch; /** * The gap color, specified as a swatch (color, gradient, tint, or mixed ink), * of the left border stroke. Note: Valid only when left border stroke type is * not solid. */ leftBorderStrokeGapColor: Swatch; /** * If true, the gap of the left border stroke will overprint. Note: Valid only * when left border stroke type is not solid. */ leftBorderStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of the left border stroke. * (Range: 0 to 100) Note: Valid only when left border stroke type is not * solid. * @remarks Range: 0 to 100 */ leftBorderStrokeGapTint: number; /** * If true, the left border stroke will overprint. */ leftBorderStrokeOverprint: boolean; /** * The tint (as a percentage) of the left border stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ leftBorderStrokeTint: number; /** * The stroke type of the left border. Can also accept: String. */ leftBorderStrokeType: StrokeStyle | string; /** * The stroke weight of the left border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ leftBorderStrokeWeight: number | string; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * The name of the Table; this is an alias to the Table's label property. */ name: string; /** * A collection of notes. */ readonly notes: Notes; /** * The number of header columns in the table. */ numHeaderColumns: number; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the Table (a XMLElement, XmlStory, TextFrame, * EndnoteTextFrame, Text, InsertionPoint, TextStyleRange, Paragraph, * TextColumn, Line, Word, Character, Story or Cell). */ readonly parent: Character | EndnoteTextFrame | InsertionPoint | Line | Paragraph | Story | Text | TextColumn | TextFrame | TextStyleRange | Word | XmlStory | Cell | XMLElement; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * The color, specified as a swatch (color, gradient, tint, or mixed ink), of * the right border stroke. */ rightBorderStrokeColor: Swatch; /** * The gap color, specified as a swatch (color, gradient, tint, or mixed ink), * of the right border stroke. Note: Valid only when right border stroke type * is not solid. */ rightBorderStrokeGapColor: Swatch; /** * If true, the gap color of the right border stroke will overprint. Note: * Valid only when right border stroke type is not solid. */ rightBorderStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of the right border stroke. * (Range: 0 to 100) Note: Valid only when right border stroke type is not * solid. * @remarks Range: 0 to 100 */ rightBorderStrokeGapTint: number; /** * If true, the right border stroke will overprint. */ rightBorderStrokeOverprint: boolean; /** * The tint (as a percentage) of the right border stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ rightBorderStrokeTint: number; /** * The stroke type of the right border. Can also accept: String. */ rightBorderStrokeType: StrokeStyle | string; /** * The stroke weight of the right border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ rightBorderStrokeWeight: number | string; /** * A collection of table rows. */ readonly rows: Rows; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * The number of columns on the left side of the table to skip before applying * the column fill color. Note: Valid when alternating fills are defined for * table columns. */ skipFirstAlternatingFillColumns: number; /** * The number of body rows at the beginning of the table to skip before * applying the row fill color. Note: Valid when alternating fills are defined * for table rows. */ skipFirstAlternatingFillRows: number; /** * The number of columns on the left of the table in which to skip border * stroke formatting. Note: Valid when start column stroke count is 1 or * greater and/or end column stroke count is 1 or greater. */ skipFirstAlternatingStrokeColumns: number; /** * The number of body rows at the beginning of the table in which to skip * border stroke formatting. Note: Valid when start row stroke count is 1 or * greater and/or end row stroke count is 1 or greater. */ skipFirstAlternatingStrokeRows: number; /** * If true, skips the first occurrence of header rows. */ skipFirstHeader: boolean; /** * The number columns on the right side of the table in which to not apply the * column fill color. Note: Valid when alternating fills are defined for table * columns. */ skipLastAlternatingFillColumns: number; /** * The number of body rows at the end of the table in which to not apply the * row fill color. Note: Valid when alternating fills are defined for table * rows. */ skipLastAlternatingFillRows: number; /** * The number of columns on the right side of the table in which to skip border * stroke formatting. Note: Valid when start column stroke count is 1 or * greater and/or end column stroke count is 1 or greater. */ skipLastAlternatingStrokeColumns: number; /** * The number of body rows at the end of the table in which to skip border * stroke formatting. Note: Valid when start row stroke count is 1 or greater * and/or end row stroke count is 1 or greater. */ skipLastAlternatingStrokeRows: number; /** * If true, skips the last occurrence of footer rows. */ skipLastFooter: boolean; /** * The space below the table. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceAfter: number | string; /** * The space above the table. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceBefore: number | string; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The fill color, specified as a swatch (color, gradient, tint, or mixed ink), * of columns in the first alternating fills group. Note: Valid when * alternating fills are defined for table columns. */ startColumnFillColor: Swatch; /** * The number of columns in the first alternating fills group. Note: Valid when * alternating fills are defined for table columns. */ startColumnFillCount: number; /** * If true, the columns in the first alternating fills group will overprint. * Note: Valid when alternating fills are defined for table columns. */ startColumnFillOverprint: boolean; /** * The tint (as a percentage) of the columns in the first alternating fills * group. (Range: 0 to 100) Note: Valid when alternating fills are defined for * table columns. * @remarks Range: 0 to 100 */ startColumnFillTint: number; /** * The stroke color, specified as a swatch (color, gradient, tint, or mixed * ink), of column borders in the first alternating column strokes group. */ startColumnStrokeColor: Swatch; /** * The number of columns in the first alternating column strokes group. */ startColumnStrokeCount: number; /** * The stroke gap color, specified as a swatch (color, gradient, tint, or mixed * ink), of column borders in the first alternating column strokes group. Note: * Valid when start column stroke count is 1 or greater. */ startColumnStrokeGapColor: Swatch; /** * If true, the gap of the column borders in the first alternating column * strokes group will overprint. Note: Valid when start column stroke count is * 1 or greater. */ startColumnStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of column borders in the first * alternating column strokes group. (Range: 0 to 100) Note: Valid when start * column stroke count is 1 or greater. * @remarks Range: 0 to 100 */ startColumnStrokeGapTint: number; /** * If true, the column borders in the first alternating column strokes group * will overprint. Note: Valid when start column stroke count is 1 or greater. */ startColumnStrokeOverprint: boolean; /** * The tint (as a percentage) of column borders in the first alternating column * strokes group. (Range: 0 to 100) Note: Valid when start column stroke count * is 1 or greater. * @remarks Range: 0 to 100 */ startColumnStrokeTint: number; /** * The stroke type of columns in the first alternating strokes group. Can also * accept: String. */ startColumnStrokeType: StrokeStyle | string; /** * The stroke weight of column borders in the first alternating column strokes * group. Note: Valid when start column stroke count is 1 or greater. * @remarks Measurement unit — also accepts a string such as "12mm". */ startColumnStrokeWeight: number | string; /** * The fill color, specified as a swatch (color, gradient, tint, or mixed ink), * of rows in the first alternating fills group. Note: Valid when alternating * fills are defined for table rows. */ startRowFillColor: Swatch; /** * The number of rows in the first alternating fills group. Note: Valid when * alternating fills are defined for table rows. */ startRowFillCount: number; /** * If true, the rows in the first alternating fills group will overprint. Note: * Valid when alternating fills are defined for table rows. */ startRowFillOverprint: boolean; /** * The tint (as a percentage) of the rows in the first alternating fills group. * (Range: 0 to 100) Note: Valid when alternating fills are defined for table * rows. * @remarks Range: 0 to 100 */ startRowFillTint: number; /** * The color, specified as a swatch (color, gradient, tint, or mixed ink), of * row borders in the first alternating row strokes group. Note: Valid when * start row stroke count is 1 or greater. */ startRowStrokeColor: Swatch; /** * The number of rows in the first alternating row strokes group. */ startRowStrokeCount: number; /** * The stroke gap color of row borders in the first alternating row strokes * group, specified as a swatch (color, gradient, tint, or mixed ink). Note: * Valid when start row stroke count is 1 or greater. */ startRowStrokeGapColor: Swatch; /** * If true, the gap color of the row border stroke in the first alternating row * strokes group will overprint. Note: Valid when start row stroke count is 1 * or greater. */ startRowStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of row borders in the first * alternating rows group. (Range: 0 to 100) Note: Valid when start row stroke * count is 1 or greater. * @remarks Range: 0 to 100 */ startRowStrokeGapTint: number; /** * If true, the row borders in the first alternating row strokes group will * overprint. Note: Valid when start row stroke count is 1 or greater. */ startRowStrokeOverprint: boolean; /** * The tint (as a percentage) of the borders in the first alternating row * strokes group. (Range: 0 to 100) Note: Valid when start row stroke count is * 1 or greater. * @remarks Range: 0 to 100 */ startRowStrokeTint: number; /** * The stroke type of rows in the first alternating strokes group. Can also * accept: String. */ startRowStrokeType: StrokeStyle | string; /** * The stroke weight of row borders in the first alternating row strokes group. * Note: Valid when start row stroke count is 1 or greater. * @remarks Measurement unit — also accepts a string such as "12mm". */ startRowStrokeWeight: number | string; /** * The insertion point before the table in the story containing the table. */ readonly storyOffset: InsertionPoint; /** * The order in which to display row and column strokes at corners. */ strokeOrder: StrokeOrderTypes; /** * The direction of the the table */ tableDirection: TableDirectionOptions; /** * The bottom inset of the text cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ textBottomInset: number | string; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * The left inset of the text cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ textLeftInset: number | string; /** * The right inset of the text cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ textRightInset: number | string; /** * The top inset of the text cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ textTopInset: number | string; /** * A collection of text variable instances. */ readonly textVariableInstances: TextVariableInstances; /** * The color, specified as a swatch (color, gradient, tint, or mixed ink), of * the table's top border stroke. */ topBorderStrokeColor: Swatch; /** * The gap color, specified as a swatch (color, gradient, tint, or mixed ink), * of the table's top border stroke. Note: Valid only when top border stroke * type is not solid. */ topBorderStrokeGapColor: Swatch; /** * If true, the gap of the top border stroke will overprint. Note: Valid only * when top border stroke type is not solid. */ topBorderStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of the table's top border * stroke. (Range: 0 to 100) Note: Valid only when top border stroke type is * not solid. * @remarks Range: 0 to 100 */ topBorderStrokeGapTint: number; /** * If true, the top border strokes will overprint. */ topBorderStrokeOverprint: boolean; /** * The tint (as a percentage) of the table's top border stroke. (Range: 0 to * 100) * @remarks Range: 0 to 100 */ topBorderStrokeTint: number; /** * The stroke type of the top border. Can also accept: String. */ topBorderStrokeType: StrokeStyle | string; /** * The stroke weight of the table's top border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ topBorderStrokeWeight: number | string; /** * The width of the Table. For a table or row, specifies the sum of the column * widths. * @remarks Measurement unit — also accepts a string such as "12mm". */ width: number | string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds glyphs that match the find what value and replaces the glyphs with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value and replaces the text * with the change character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeTransliterate(reverseOrder?: boolean): Text[]; /** * Clear Table Style Overrides */ clearTableStyleOverrides(): void; /** * Convert bullets and numbering to text. */ convertBulletsAndNumberingToText(): void; /** * Converts the table to text. * @param columnSeparator The character to insert between the each column's content in the converted text. Note: Can be defined as any single character, such as a letter, number, or punctuation mark, or by typing a space or tab. Use the actual character rather than its name, such as ',' rather than 'Comma'. Precede double or single quotes or a backslash with an extra backslash as an escape character. For paragraphs, use ^p. (Optional) * @param rowSeparator The character to use to separate each row's content in the converted text. Note: Can be defined as any single character, such as a letter, number, or punctuation mark, or by typing a space or tab. Use the actual character rather than its name, such as , rather than Comma. Precede double or single quotes or a backslash with an extra backslash as an escape character. For paragraphs, use ^p. (Optional) */ convertToText(columnSeparator?: string, rowSeparator?: string): Text; /** * Converts text to outlines. Each line of text becomes a polygon object. When * the converted text is a single letter that has no internal spaces or * detached parts, the polygon contains only a single path. Note: To determine * whether a font allows the creation of outlines, see allow outlines. * @param deleteOriginal If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) */ createOutlines(deleteOriginal?: boolean): PageItem[]; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds glyphs that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findTransliterate(reverseOrder?: boolean): Text[]; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Table[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Recomposes the text in the Table. */ recompose(): void; /** * Deletes the Table. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Selects the object. * @param existingSelection The selection status of the Table in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Generates a string which, if executed, will return the Table. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Unmerges all merged cells in the Table. */ unmerge(): Cell[]; } /** * The position of caption paragraphs relative to the table. */ declare enum TableCaptionPositionOptions { /** * Caption paragraphs follow the table. */ AFTER_TABLE = 1415725889, /** * Caption paragraphs precede the table. */ BEFORE_TABLE = 1415725890, } /** * Table direction options. */ declare enum TableDirectionOptions { /** * Set left to right table direction */ LEFT_TO_RIGHT_DIRECTION = 1278366308, /** * Set right to left table direction */ RIGHT_TO_LEFT_DIRECTION = 1379028068, } /** * Formatting options for imported spreadsheets. */ declare enum TableFormattingOptions { /** * Use formatting from the original spreadsheet. */ EXCEL_FORMATTED_TABLE = 2020361812, /** * Converts the spreadsheet to a table that is formatted only on initial import * but not on update. */ EXCEL_FORMAT_ONLY_ONCE = 2017873748, /** * Convert the spreadsheet to unformatted, tab-delimited text. */ EXCEL_UNFORMATTED_TABBED_TEXT = 2018858068, /** * Convert the spreadsheet to an unformatted table. */ EXCEL_UNFORMATTED_TABLE = 2020365652, } /** * A table style. */ declare class TableStyle { /** * The style that this style is based on. Can return: TableStyle or String. */ basedOn: TableStyle | string; /** * The cell style of the body region. Can also accept: String. */ bodyRegionCellStyle: CellStyle | string; /** * The color, specified as a swatch (color, gradient, tint, or mixed ink), of * the bottom border stroke. */ bottomBorderStrokeColor: Swatch; /** * The gap color, specified as a swatch (color, gradient, tint, or mixed ink), * of the bottom border stroke. Note: Valid only when bottom border stroke type * is not solid. */ bottomBorderStrokeGapColor: Swatch; /** * If true, the gap of the bottom border stroke will overprint. Note: Valid * only when bottom border stroke type is not solid. */ bottomBorderStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of the bottom border stroke. * (Range: 0 to 100) Note: Valid only when bottom border stroke type is not * solid. * @remarks Range: 0 to 100 */ bottomBorderStrokeGapTint: number; /** * If true, the bottom border stroke will overprint. */ bottomBorderStrokeOverprint: boolean; /** * The tint (as a percentage) of the bottom border stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ bottomBorderStrokeTint: number; /** * The stroke type of the bottom border. Can also accept: String. */ bottomBorderStrokeType: StrokeStyle | string; /** * The stroke weight of the bottom border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomBorderStrokeWeight: number | string; /** * The number of paragraphs adjacent to the table that are designated as a * table caption for PDF/UA export. Use 0 to disable. * @remarks Range: 0 to 100 */ captionParagraphCount: number; /** * Whether the caption paragraphs come before or after the table. */ captionPosition: TableCaptionPositionOptions; /** * If true, clips the graphic cell's content to width and height of the cell. */ clipContentToGraphicCell: boolean; /** * If true, clips the text cell's content to width and height of the cell. */ clipContentToTextCell: boolean; /** * If true, hides alternating row fills. If false, hides alternating column * fills. */ columnFillsPriority: boolean; /** * The fill color, specified as a swatch (color, gradient, tint, or mixed ink), * of columns in the second alternating fill group. Note: Valid when * alternating fills are defined for table columns. */ endColumnFillColor: Swatch; /** * The number of columns in the second alternating fills group. Note: Valid * when alternating fills are defined for table columns. */ endColumnFillCount: number; /** * If true, the columns in the second alternating fills group will overprint. * Note: Valid when alternating fills are defined for table columns. */ endColumnFillOverprint: boolean; /** * The tint (as a percentage) of the columns in the second alternating fills * group. (Range: 0 to 100) Note: Valid when alternating fills are defined for * table columns. * @remarks Range: 0 to 100 */ endColumnFillTint: number; /** * The stroke type of columns in the second alternating strokes group. Can also * accept: String. */ endColumnLineStyle: StrokeStyle | string; /** * The stroke color, specified as a swatch (color, gradient, tint, or mixed * ink), of column borders in the second alternating column strokes group. * Note: Valid when end column stroke count is 1 or greater. */ endColumnStrokeColor: Swatch; /** * The number of columns in the second alternating column strokes group. */ endColumnStrokeCount: number; /** * The stroke gap color, specified as a swatch (color, gradient, tint, or mixed * ink), of column borders in the second alternating column strokes group. * Note: Valid when end column stroke count is 1 or greater. */ endColumnStrokeGapColor: Swatch; /** * If true, the gap of the column border stroke in the second alternating * column strokes group will overprint. Note: Valid when end column stroke * count is 1 or greater. */ endColumnStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of column borders in the second * alternating column strokes group. (Range: 0 to 100) Note: Valid when end * column stroke count is 1 or greater. * @remarks Range: 0 to 100 */ endColumnStrokeGapTint: number; /** * If true, the column borders in the second alternating column strokes group * will overprint. Note: Valid when end column stroke count is 1 or greater. */ endColumnStrokeOverprint: boolean; /** * The tint (as a percentage) of column borders in the second alternating * column strokes group. (Range: 0 to 100) Note: Valid when end column stroke * count is 1 or greater. * @remarks Range: 0 to 100 */ endColumnStrokeTint: number; /** * The stroke weight of column borders in the second alternating column strokes * group. Note: Valid when end column stroke count is 1 or greater. * @remarks Measurement unit — also accepts a string such as "12mm". */ endColumnStrokeWeight: number | string; /** * The fill color, specified as a swatch (color, gradient, tint, or mixed ink), * of rows in the second alternating fills group. Note: Valid when alternating * fills are defined for table rows. */ endRowFillColor: Swatch; /** * The number of rows in the second alternating fills group. Note: Valid when * alternating fills are defined for table rows. */ endRowFillCount: number; /** * If true, the rows in the second alternating fills group will overprint. * Note: Valid when alternating fills are defined for table rows. */ endRowFillOverprint: boolean; /** * The tint (as a percentage) of the rows in the second alternating fills * group. (Range: 0 to 100) Note: Valid when alternating fills are defined for * table rows. * @remarks Range: 0 to 100 */ endRowFillTint: number; /** * The stroke color, specified as a swatch (color, gradient, tint, or mixed * ink), of row borders in the second alternating row strokes group. Note: * Valid when end row stroke count is 1 or greater. */ endRowStrokeColor: Swatch; /** * The number of rows in the second alternating row strokes group. */ endRowStrokeCount: number; /** * The gap color, specified as a swatch (color, gradient, tint, or mixed ink), * of row borders in the second alternating rows group. Note: Valid when end * row stroke count is 1 or greater. */ endRowStrokeGapColor: Swatch; /** * If true, the gap of the row borders in the second alternating rows group * will overprint. Note: Valid when end row stroke count is 1 or greater. */ endRowStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of rows in the second * alternating strokes group. (Range: 0 to 100) Note: Valid when end row stroke * count is 1 or greater and end row stroke type is not solid. * @remarks Range: 0 to 100 */ endRowStrokeGapTint: number; /** * If true, the rows in the second alternating rows group will overprint. Note: * Valid when end row stroke count is 1 or greater. */ endRowStrokeOverprint: boolean; /** * The tint (as a percentage) of the row borders in the second alternating * strokes group. (Range: 0 to 100) Note: Valid when end row stroke count is 1 * or greater. * @remarks Range: 0 to 100 */ endRowStrokeTint: number; /** * The stroke type of rows in the second alternating strokes group. Can also * accept: String. */ endRowStrokeType: StrokeStyle | string; /** * The stroke weight of row borders in the second alternating row strokes * group. Note: Valid when end row stroke count is 1 or greater. * @remarks Measurement unit — also accepts a string such as "12mm". */ endRowStrokeWeight: number | string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The cell style of the footer region. Can also accept: String. */ footerRegionCellStyle: CellStyle | string; /** * If true, uses the cell style of the body region for the footer region. */ footerRegionSameAsBodyRegion: boolean; /** * The bottom inset of the graphic cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ graphicBottomInset: number | string; /** * The left inset of the graphic cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ graphicLeftInset: number | string; /** * The right inset of the graphic cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ graphicRightInset: number | string; /** * The top inset of the graphic cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ graphicTopInset: number | string; /** * The cell style of the header column. Can also accept: String. */ headerColumnCellStyle: CellStyle | string; /** * The cell style of the header region. Can also accept: String. */ headerRegionCellStyle: CellStyle | string; /** * If true, use the cell style of the body region for the header region. */ headerRegionSameAsBodyRegion: boolean; /** * The unique ID of the TableStyle. */ readonly id: number; /** * The index of the TableStyle within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The color, specified as a swatch (color, gradient, tint, or mixed ink), of * the left border stroke. */ leftBorderStrokeColor: Swatch; /** * The gap color, specified as a swatch (color, gradient, tint, or mixed ink), * of the left border stroke. Note: Valid only when left border stroke type is * not solid. */ leftBorderStrokeGapColor: Swatch; /** * If true, the gap of the left border stroke will overprint. Note: Valid only * when left border stroke type is not solid. */ leftBorderStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of the left border stroke. * (Range: 0 to 100) Note: Valid only when left border stroke type is not * solid. * @remarks Range: 0 to 100 */ leftBorderStrokeGapTint: number; /** * If true, the left border stroke will overprint. */ leftBorderStrokeOverprint: boolean; /** * The tint (as a percentage) of the left border stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ leftBorderStrokeTint: number; /** * The stroke type of the left border. Can also accept: String. */ leftBorderStrokeType: StrokeStyle | string; /** * The stroke weight of the left border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ leftBorderStrokeWeight: number | string; /** * The cell style of the left column region. Can also accept: String. */ leftColumnRegionCellStyle: CellStyle | string; /** * If true, uses the cell style of the body region for the left column region. */ leftColumnRegionSameAsBodyRegion: boolean; /** * The name of the TableStyle. */ name: string; /** * The parent of the TableStyle (a Document, Application or TableStyleGroup). */ readonly parent: Application | Document | TableStyleGroup; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The color, specified as a swatch (color, gradient, tint, or mixed ink), of * the right border stroke. */ rightBorderStrokeColor: Swatch; /** * The gap color, specified as a swatch (color, gradient, tint, or mixed ink), * of the right border stroke. Note: Valid only when right border stroke type * is not solid. */ rightBorderStrokeGapColor: Swatch; /** * If true, the gap color of the right border stroke will overprint. Note: * Valid only when right border stroke type is not solid. */ rightBorderStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of the right border stroke. * (Range: 0 to 100) Note: Valid only when right border stroke type is not * solid. * @remarks Range: 0 to 100 */ rightBorderStrokeGapTint: number; /** * If true, the right border stroke will overprint. */ rightBorderStrokeOverprint: boolean; /** * The tint (as a percentage) of the right border stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ rightBorderStrokeTint: number; /** * The stroke type of the right border. Can also accept: String. */ rightBorderStrokeType: StrokeStyle | string; /** * The stroke weight of the right border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ rightBorderStrokeWeight: number | string; /** * The cell style of the right column region. Can also accept: String. */ rightColumnRegionCellStyle: CellStyle | string; /** * If true, uses the cell style of the body region for the right column region. */ rightColumnRegionSameAsBodyRegion: boolean; /** * The number of columns on the left side of the table to skip before applying * the column fill color. Note: Valid when alternating fills are defined for * table columns. */ skipFirstAlternatingFillColumns: number; /** * The number of body rows at the beginning of the table to skip before * applying the row fill color. Note: Valid when alternating fills are defined * for table rows. */ skipFirstAlternatingFillRows: number; /** * The number of columns on the left of the table in which to skip border * stroke formatting. Note: Valid when start column stroke count is 1 or * greater and/or end column stroke count is 1 or greater. */ skipFirstAlternatingStrokeColumns: number; /** * The number of body rows at the beginning of the table in which to skip * border stroke formatting. Note: Valid when start row stroke count is 1 or * greater and/or end row stroke count is 1 or greater. */ skipFirstAlternatingStrokeRows: number; /** * The number columns on the right side of the table in which to not apply the * column fill color. Note: Valid when alternating fills are defined for table * columns. */ skipLastAlternatingFillColumns: number; /** * The number of body rows at the end of the table in which to not apply the * row fill color. Note: Valid when alternating fills are defined for table * rows. */ skipLastAlternatingFillRows: number; /** * The number of columns on the right side of the table in which to skip border * stroke formatting. Note: Valid when start column stroke count is 1 or * greater and/or end column stroke count is 1 or greater. */ skipLastAlternatingStrokeColumns: number; /** * The number of body rows at the end of the table in which to skip border * stroke formatting. Note: Valid when start row stroke count is 1 or greater * and/or end row stroke count is 1 or greater. */ skipLastAlternatingStrokeRows: number; /** * The space below the table. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceAfter: number | string; /** * The space above the table. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceBefore: number | string; /** * The fill color, specified as a swatch (color, gradient, tint, or mixed ink), * of columns in the first alternating fills group. Note: Valid when * alternating fills are defined for table columns. */ startColumnFillColor: Swatch; /** * The number of columns in the first alternating fills group. Note: Valid when * alternating fills are defined for table columns. */ startColumnFillCount: number; /** * If true, the columns in the first alternating fills group will overprint. * Note: Valid when alternating fills are defined for table columns. */ startColumnFillOverprint: boolean; /** * The tint (as a percentage) of the columns in the first alternating fills * group. (Range: 0 to 100) Note: Valid when alternating fills are defined for * table columns. * @remarks Range: 0 to 100 */ startColumnFillTint: number; /** * The stroke color, specified as a swatch (color, gradient, tint, or mixed * ink), of column borders in the first alternating column strokes group. */ startColumnStrokeColor: Swatch; /** * The number of columns in the first alternating column strokes group. */ startColumnStrokeCount: number; /** * The stroke gap color, specified as a swatch (color, gradient, tint, or mixed * ink), of column borders in the first alternating column strokes group. Note: * Valid when start column stroke count is 1 or greater. */ startColumnStrokeGapColor: Swatch; /** * If true, the gap of the column borders in the first alternating column * strokes group will overprint. Note: Valid when start column stroke count is * 1 or greater. */ startColumnStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of column borders in the first * alternating column strokes group. (Range: 0 to 100) Note: Valid when start * column stroke count is 1 or greater. * @remarks Range: 0 to 100 */ startColumnStrokeGapTint: number; /** * If true, the column borders in the first alternating column strokes group * will overprint. Note: Valid when start column stroke count is 1 or greater. */ startColumnStrokeOverprint: boolean; /** * The tint (as a percentage) of column borders in the first alternating column * strokes group. (Range: 0 to 100) Note: Valid when start column stroke count * is 1 or greater. * @remarks Range: 0 to 100 */ startColumnStrokeTint: number; /** * The stroke type of columns in the first alternating strokes group. Can also * accept: String. */ startColumnStrokeType: StrokeStyle | string; /** * The stroke weight of column borders in the first alternating column strokes * group. Note: Valid when start column stroke count is 1 or greater. * @remarks Measurement unit — also accepts a string such as "12mm". */ startColumnStrokeWeight: number | string; /** * The fill color, specified as a swatch (color, gradient, tint, or mixed ink), * of rows in the first alternating fills group. Note: Valid when alternating * fills are defined for table rows. */ startRowFillColor: Swatch; /** * The number of rows in the first alternating fills group. Note: Valid when * alternating fills are defined for table rows. */ startRowFillCount: number; /** * If true, the rows in the first alternating fills group will overprint. Note: * Valid when alternating fills are defined for table rows. */ startRowFillOverprint: boolean; /** * The tint (as a percentage) of the rows in the first alternating fills group. * (Range: 0 to 100) Note: Valid when alternating fills are defined for table * rows. * @remarks Range: 0 to 100 */ startRowFillTint: number; /** * The color, specified as a swatch (color, gradient, tint, or mixed ink), of * row borders in the first alternating row strokes group. Note: Valid when * start row stroke count is 1 or greater. */ startRowStrokeColor: Swatch; /** * The number of rows in the first alternating row strokes group. */ startRowStrokeCount: number; /** * The stroke gap color of row borders in the first alternating row strokes * group, specified as a swatch (color, gradient, tint, or mixed ink). Note: * Valid when start row stroke count is 1 or greater. */ startRowStrokeGapColor: Swatch; /** * If true, the gap color of the row border stroke in the first alternating row * strokes group will overprint. Note: Valid when start row stroke count is 1 * or greater. */ startRowStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of row borders in the first * alternating rows group. (Range: 0 to 100) Note: Valid when start row stroke * count is 1 or greater. * @remarks Range: 0 to 100 */ startRowStrokeGapTint: number; /** * If true, the row borders in the first alternating row strokes group will * overprint. Note: Valid when start row stroke count is 1 or greater. */ startRowStrokeOverprint: boolean; /** * The tint (as a percentage) of the borders in the first alternating row * strokes group. (Range: 0 to 100) Note: Valid when start row stroke count is * 1 or greater. * @remarks Range: 0 to 100 */ startRowStrokeTint: number; /** * The stroke type of rows in the first alternating strokes group. Can also * accept: String. */ startRowStrokeType: StrokeStyle | string; /** * The stroke weight of row borders in the first alternating row strokes group. * Note: Valid when start row stroke count is 1 or greater. * @remarks Measurement unit — also accepts a string such as "12mm". */ startRowStrokeWeight: number | string; /** * The order in which to display row and column strokes at corners. */ strokeOrder: StrokeOrderTypes; /** * The bottom inset of the text cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ textBottomInset: number | string; /** * The left inset of the text cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ textLeftInset: number | string; /** * The right inset of the text cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ textRightInset: number | string; /** * The top inset of the text cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ textTopInset: number | string; /** * The color, specified as a swatch (color, gradient, tint, or mixed ink), of * the table's top border stroke. */ topBorderStrokeColor: Swatch; /** * The gap color, specified as a swatch (color, gradient, tint, or mixed ink), * of the table's top border stroke. Note: Valid only when top border stroke * type is not solid. */ topBorderStrokeGapColor: Swatch; /** * If true, the gap of the top border stroke will overprint. Note: Valid only * when top border stroke type is not solid. */ topBorderStrokeGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of the table's top border * stroke. (Range: 0 to 100) Note: Valid only when top border stroke type is * not solid. * @remarks Range: 0 to 100 */ topBorderStrokeGapTint: number; /** * If true, the top border strokes will overprint. */ topBorderStrokeOverprint: boolean; /** * The tint (as a percentage) of the table's top border stroke. (Range: 0 to * 100) * @remarks Range: 0 to 100 */ topBorderStrokeTint: number; /** * The stroke type of the top border. Can also accept: String. */ topBorderStrokeType: StrokeStyle | string; /** * The stroke weight of the table's top border stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ topBorderStrokeWeight: number | string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the TableStyle. */ duplicate(): TableStyle; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TableStyle[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Moves the style to the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: ParagraphStyle, ParagraphStyleGroup, CharacterStyle, CharacterStyleGroup, CellStyle, CellStyleGroup, TableStyle, TableStyleGroup, Document or Application. (Optional) */ move(to: LocationOptions, reference?: CellStyle | CellStyleGroup | CharacterStyle | CharacterStyleGroup | Document | ParagraphStyle | ParagraphStyleGroup | TableStyle | TableStyleGroup | Application): TableStyle; /** * Deletes the style. * @param replacingWith The style to apply in place of the deleted style. (Optional) */ remove(replacingWith?: TableStyle): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TableStyle. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A table style group. */ declare class TableStyleGroup { /** * All Table styles */ readonly allTableStyles: TableStyle[]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the TableStyleGroup. */ readonly id: number; /** * The index of the TableStyleGroup within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the TableStyleGroup. */ name: string; /** * The parent of the TableStyleGroup (a Document, Application or * TableStyleGroup). */ readonly parent: Application | Document | TableStyleGroup; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of table style groups. */ readonly tableStyleGroups: TableStyleGroups; /** * A collection of table styles. */ readonly tableStyles: TableStyles; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the TableStyleGroup. */ duplicate(): TableStyleGroup; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TableStyleGroup[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Moves the style to the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: ParagraphStyle, ParagraphStyleGroup, CharacterStyle, CharacterStyleGroup, CellStyle, CellStyleGroup, TableStyle, TableStyleGroup, Document or Application. (Optional) */ move(to: LocationOptions, reference?: CellStyle | CellStyleGroup | CharacterStyle | CharacterStyleGroup | Document | ParagraphStyle | ParagraphStyleGroup | TableStyle | TableStyleGroup | Application): TableStyleGroup; /** * Deletes the style. * @param replacingWith The style to apply in place of the deleted style. Can accept: ParagraphStyle or CharacterStyle. (Optional) */ remove(replacingWith?: ParagraphStyle | CharacterStyle): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TableStyleGroup. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of table style groups. */ declare class TableStyleGroups { /** Returns the TableStyleGroup with the specified index or name. */ [index: number]: TableStyleGroup; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new TableStyleGroup. * @param withProperties Initial values for properties of the new TableStyleGroup (Optional) */ add(withProperties?: Object): TableStyleGroup; /** * Returns any TableStyleGroup in the collection. */ anyItem(): TableStyleGroup; /** * Displays the number of elements in the TableStyleGroup. */ count(): number; /** * Returns every TableStyleGroup in the collection. */ everyItem(): TableStyleGroup; /** * Returns the first TableStyleGroup in the collection. */ firstItem(): TableStyleGroup; /** * Returns the TableStyleGroup with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): TableStyleGroup; /** * Returns the TableStyleGroup with the specified ID. * @param id The ID. */ itemByID(id: number): TableStyleGroup; /** * Returns the TableStyleGroup with the specified name. * @param name The name. */ itemByName(name: string): TableStyleGroup; /** * Returns the TableStyleGroups within the specified range. * @param from The TableStyleGroup, index, or name at the beginning of the range. Can accept: TableStyleGroup, Long Integer or String. * @param to The TableStyleGroup, index, or name at the end of the range. Can accept: TableStyleGroup, Long Integer or String. */ itemByRange(from: number | TableStyleGroup | string, to: number | TableStyleGroup | string): TableStyleGroup[]; /** * Returns the last TableStyleGroup in the collection. */ lastItem(): TableStyleGroup; /** * Returns the middle TableStyleGroup in the collection. */ middleItem(): TableStyleGroup; /** * Returns the TableStyleGroup whose index follows the specified * TableStyleGroup in the collection. * @param obj The TableStyleGroup whose index comes before the desired TableStyleGroup. */ nextItem(obj: TableStyleGroup): TableStyleGroup; /** * Returns the TableStyleGroup with the index previous to the specified index. * @param obj The index of the TableStyleGroup that follows the desired TableStyleGroup. */ previousItem(obj: TableStyleGroup): TableStyleGroup; /** * Generates a string which, if executed, will return the TableStyleGroup. */ toSource(): string; } /** * A table style mapping. */ declare class TableStyleMapping { /** * The destination style name property. */ destinationStyleName: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the TableStyleMapping within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The type of the mapping rule. */ mappingRuleType: MapType; /** * The parent of the TableStyleMapping (a Application, Document, Story or * XmlStory). */ readonly parent: Document | Story | Application | XmlStory; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The source style name property. */ sourceStyleName: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TableStyleMapping[]; /** * deletes a style mapping. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TableStyleMapping. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of table style mappings. */ declare class TableStyleMappings { /** Returns the TableStyleMapping with the specified index or name. */ [index: number]: TableStyleMapping; /** * The number of objects in the collection. */ readonly length: number; /** * Adds a style mapping. * @param sourceStyleName The source style name. * @param destinationStyleName The destination style name. * @param mappingRuleType The mapping type * @param withProperties Initial values for properties of the new TableStyleMapping (Optional) */ add(sourceStyleName: string, destinationStyleName: string, mappingRuleType: MapType, withProperties?: Object): TableStyleMapping; /** * Returns any TableStyleMapping in the collection. */ anyItem(): TableStyleMapping; /** * Displays the number of elements in the TableStyleMapping. */ count(): number; /** * Returns every TableStyleMapping in the collection. */ everyItem(): TableStyleMapping; /** * Returns the first TableStyleMapping in the collection. */ firstItem(): TableStyleMapping; /** * Returns the TableStyleMapping with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): TableStyleMapping; /** * Returns the TableStyleMappings within the specified range. * @param from The TableStyleMapping, index, or name at the beginning of the range. Can accept: TableStyleMapping, Long Integer or String. * @param to The TableStyleMapping, index, or name at the end of the range. Can accept: TableStyleMapping, Long Integer or String. */ itemByRange(from: number | TableStyleMapping | string, to: number | TableStyleMapping | string): TableStyleMapping[]; /** * Returns the last TableStyleMapping in the collection. */ lastItem(): TableStyleMapping; /** * Returns the middle TableStyleMapping in the collection. */ middleItem(): TableStyleMapping; /** * Returns the TableStyleMapping whose index follows the specified * TableStyleMapping in the collection. * @param obj The TableStyleMapping whose index comes before the desired TableStyleMapping. */ nextItem(obj: TableStyleMapping): TableStyleMapping; /** * Returns the TableStyleMapping with the index previous to the specified * index. * @param obj The index of the TableStyleMapping that follows the desired TableStyleMapping. */ previousItem(obj: TableStyleMapping): TableStyleMapping; /** * Generates a string which, if executed, will return the TableStyleMapping. */ toSource(): string; } /** * A collection of table styles. */ declare class TableStyles { /** Returns the TableStyle with the specified index or name. */ [index: number]: TableStyle; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new TableStyle. * @param withProperties Initial values for properties of the new TableStyle (Optional) */ add(withProperties?: Object): TableStyle; /** * Returns any TableStyle in the collection. */ anyItem(): TableStyle; /** * Displays the number of elements in the TableStyle. */ count(): number; /** * Returns every TableStyle in the collection. */ everyItem(): TableStyle; /** * Returns the first TableStyle in the collection. */ firstItem(): TableStyle; /** * Returns the TableStyle with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): TableStyle; /** * Returns the TableStyle with the specified ID. * @param id The ID. */ itemByID(id: number): TableStyle; /** * Returns the TableStyle with the specified name. * @param name The name. */ itemByName(name: string): TableStyle; /** * Returns the TableStyles within the specified range. * @param from The TableStyle, index, or name at the beginning of the range. Can accept: TableStyle, Long Integer or String. * @param to The TableStyle, index, or name at the end of the range. Can accept: TableStyle, Long Integer or String. */ itemByRange(from: number | TableStyle | string, to: number | TableStyle | string): TableStyle[]; /** * Returns the last TableStyle in the collection. */ lastItem(): TableStyle; /** * Returns the middle TableStyle in the collection. */ middleItem(): TableStyle; /** * Returns the TableStyle whose index follows the specified TableStyle in the * collection. * @param obj The TableStyle whose index comes before the desired TableStyle. */ nextItem(obj: TableStyle): TableStyle; /** * Returns the TableStyle with the index previous to the specified index. * @param obj The index of the TableStyle that follows the desired TableStyle. */ previousItem(obj: TableStyle): TableStyle; /** * Generates a string which, if executed, will return the TableStyle. */ toSource(): string; } /** * A collection of tables. */ declare class Tables { /** Returns the Table with the specified index or name. */ [index: number]: Table; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new table. * @param to The location of the new table relative to the reference object or within the container object. (Optional) * @param reference The reference object. Note: Required when the to value specifies before or after. Can accept: Table, XMLElement, XmlStory, TextFrame, EndnoteTextFrame, Text, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, Character, Story or Cell. (Optional) * @param withProperties Initial values for properties of the new Table (Optional) */ add(to?: LocationOptions, reference?: Character | EndnoteTextFrame | InsertionPoint | Line | Paragraph | Story | Table | Text | TextColumn | TextFrame | TextStyleRange | Word | XMLElement | XmlStory | Cell, withProperties?: Object): Table; /** * Returns any Table in the collection. */ anyItem(): Table; /** * Displays the number of elements in the Table. */ count(): number; /** * Returns every Table in the collection. */ everyItem(): Table; /** * Returns the first Table in the collection. */ firstItem(): Table; /** * Returns the Table with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Table; /** * Returns the Table with the specified ID. * @param id The ID. */ itemByID(id: number): Table; /** * Returns the Table with the specified name. * @param name The name. */ itemByName(name: string): Table; /** * Returns the Tables within the specified range. * @param from The Table, index, or name at the beginning of the range. Can accept: Table, Long Integer or String. * @param to The Table, index, or name at the end of the range. Can accept: Table, Long Integer or String. */ itemByRange(from: number | Table | string, to: number | Table | string): Table[]; /** * Returns the last Table in the collection. */ lastItem(): Table; /** * Returns the middle Table in the collection. */ middleItem(): Table; /** * Returns the Table whose index follows the specified Table in the collection. * @param obj The Table whose index comes before the desired Table. */ nextItem(obj: Table): Table; /** * Returns the Table with the index previous to the specified index. * @param obj The index of the Table that follows the desired Table. */ previousItem(obj: Table): Table; /** * Generates a string which, if executed, will return the Table. */ toSource(): string; } /** * The display method for raster images. */ declare enum TagRaster { /** * Uses the default setting. For information, see display performance * preferences. */ DEFAULT_VALUE = 1147563124, /** * Grays out raster images. */ GRAY_OUT = 1917284985, /** * Displays a high-resolution version of the image. */ HIGH_RESOLUTION = 1917348177, /** * Displays a low-resolution proxy image appropriate for identifying and * positioning an image. */ PROXY = 1917874808, } /** * Character set options exporting tagged text files. */ declare enum TagTextExportCharacterSet { /** * ANSI. */ ANSI = 1095652169, /** * ASCII. */ ASCII = 1095975753, /** * The Central European (ISO) character set. */ CENTRALEUROPEAN_ISO = 1416184645, /** * Chinese Big 5 */ CHINESE_BIG_5 = 1415799349, /** * The Cyrillic (ISO) character set. */ CYRILLIC_ISO = 1416184697, /** * Uses GB18030 encoding. */ GB18030 = 1416061491, /** * The Greek (ISO) character set. */ GREEK_ISO = 1416185707, /** * Uses KSC5601 encoding. */ KSC5601 = 1414230883, /** * Shift_JIS. */ SHIFT_JIS = 1249077875, /** * Unicode. */ UNICODE = 1249209961, /** * The Windows Arabic character set. */ WINDOWS_ARABIC = 1417101682, /** * The Windows Hebrew character set. */ WINDOWS_HEBREW = 1417103458, } /** * Tag form options. */ declare enum TagTextForm { /** * Abbreviates tags; creates smaller text files. */ ABBREVIATED = 1414816098, /** * Displays tags in long form; creates larger text files. */ VERBOSE = 1414821474, } /** * Options for specifying how tranparencies are displayed. */ declare enum TagTransparency { /** * Uses the default setting. For information, see display performance * preferences. */ DEFAULT_VALUE = 1147563124, /** * Displays higher-resolution (144 dpi) drop shadows and feathers, CMYK mattes, * and spread isolation. */ HIGH_QUALITY = 1346922866, /** * Displays basic transparency (opacity and blend modes) and shows transparency * effects such as drop shadow and feathering in a low-resolution * approximation. Note: Does not isolate page content from the background. * Objects with blend modes other than Normal might appear different in other * applications and output. */ LOW_QUALITY = 1481666146, /** * Displays drop shadows and feathering in low resolution. */ MEDIUM_QUALITY = 1481663597, /** * Turns off the on-screen display of transparency. Note: Does not turn off * transparency when printing or exporting the file. */ OFF = 1330005536, } /** * The tag type of page item */ declare enum TagType { /** * Tag as artifact */ TAG_ARTIFACT = 1952924006, /** * Tag as Story or Figure based on object type */ TAG_BASED_ON_OBJECT = 1952924271, /** * Determine the tag from XML structure, or fallback to standard tag */ TAG_FROM_STRUCTURE = 1952928613, } /** * The display method for vector images. */ declare enum TagVector { /** * Uses the default setting. For information, see display performance * preferences. */ DEFAULT_VALUE = 1147563124, /** * Grays out the image. */ GRAY_OUT = 1917284985, /** * Displays a high-resolution version of the image. */ HIGH_RESOLUTION = 1917348177, /** * Displays a low-resolution proxy version of the image. */ PROXY = 1917874808, } /** * Tagged PDF preferences. */ declare class TaggedPDFPreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the TaggedPDFPreference (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Tagged PDF structure order preference. */ structureOrder: TaggedPDFStructureOrderOptions; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TaggedPDFPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TaggedPDFPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Tagged PDF structure order options */ declare enum TaggedPDFStructureOrderOptions { /** * Use Articles order for the tagged PDF structure. */ USE_ARTICLES = 1348554610, /** * Use XML structure and layout heuristic fallback for the tagged PDF * structure. */ USE_XML_STRUCTURE = 1350062959, } /** * Tagged text export preferences. */ declare class TaggedTextExportPreference extends Preference { /** * The character set. */ characterSet: TagTextExportCharacterSet; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the TaggedTextExportPreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The form for tags in the exported text. */ tagForm: TagTextForm; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TaggedTextExportPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * TaggedTextExportPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Tagged text import preferences. */ declare class TaggedTextImportPreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the TaggedTextImportPreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, removes text formatting. */ removeTextFormatting: boolean; /** * The policy for resolving conflicts when style names in the imported tagged * text file match style names the current publication. */ styleConflict: StyleConflict; /** * If true, convert straight quotes and apostrophes in the imported text to * typographic quotation marks and apostrophes. */ useTypographersQuotes: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TaggedTextImportPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * TaggedTextImportPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * The type of a task alert. */ declare enum TaskAlertType { /** * error message */ TASK_ERROR = 1699040627, /** * Information message */ TASK_INFORMATION = 1699302771, /** * Warning message */ TASK_WARNING = 1700220275, } /** * The state of a task. */ declare enum TaskState { /** * Task was cancelled (either before it ran or during execution */ CANCELLED = 1700029292, /** * Task was signalled to cancel but did not stop yet */ CANCELLING = 1700029281, /** * Task completed execution (successfully or with errors) */ COMPLETED = 1700029296, /** * Task was queued and is waiting to be scheduled for execution */ QUEUED = 1699837285, /** * Task is running */ RUNNING = 1700033141, /** * Task is waiting */ WAITING = 1700225396, } /** * A text object. */ declare class Text { /** * If true, aligns the baseline of the text to the baseline grid. */ alignToBaseline: boolean; /** * Lists all graphics contained by the Text. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the Text. */ readonly allPageItems: PageItem[]; /** * If true, words unassociated with a hyphenation dictionary can break to the * next line on any character. */ allowArbitraryHyphenation: boolean; /** * The character style applied to the text. Can also accept: String. */ appliedCharacterStyle: CharacterStyle | string; /** * The applied conditions. */ appliedConditions: Condition[]; /** * The font applied to the Text, specified as either a font object or the name * of font family. Can return: Font or String. */ appliedFont: Font | string; /** * The language of the text. Can return: LanguageWithVendors or Language. Can * also accept: String. */ appliedLanguage: LanguageWithVendors | string | Language; /** * The applied character styles dictated by nested styles. */ readonly appliedNestedStyles: CharacterStyle[]; /** * The list to be part of. Can return: NumberingList or String. */ appliedNumberingList: NumberingList | string; /** * The paragraph style applied to the text. Can also accept: String. */ appliedParagraphStyle: ParagraphStyle | string; /** * The maximum ascent of any character in the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly ascent: number | string; /** * The XML elements associated with the Text. */ readonly associatedXMLElements: XMLItem[]; /** * The percent of the type size to use for auto leading. (Range: 0 to 500). * @remarks Range: 0 to 500 */ autoLeading: number; /** * The number of half-width characters at or below which the characters * automatically run horizontally in vertical text. */ autoTcy: number; /** * If true, auto tcy includes Roman characters. */ autoTcyIncludeRoman: boolean; /** * If true or set to an enumeration value, balances ragged lines. Note: Not * valid with a single-line text composer. Can return: Boolean or * BalanceLinesStyle enumerator. */ balanceRaggedLines: boolean | BalanceLinesStyle; /** * The vertical offset of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly baseline: number | string; /** * The baseline shift applied to the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ baselineShift: number | string; /** * Bullet character. */ readonly bulletChar: Bullet; /** * The alignment of the bullet character. */ bulletsAlignment: ListAlignment; /** * List type for bullets and numbering. */ bulletsAndNumberingListType: ListType; /** * The character style to be used for the text after string. Can return: * CharacterStyle or String. */ bulletsCharacterStyle: CharacterStyle | string; /** * The text after string expression for bullets. */ bulletsTextAfter: string; /** * If true, adds the double period (..), ellipse (...), and double hyphen (--) * to the selected kinsoku set. Note: Valid only when a kinsoku set is in * effect. */ bunriKinshi: boolean; /** * A collection of buttons. */ readonly buttons: Buttons; /** * The capitalization scheme. */ capitalization: Capitalization; /** * The alignment of small characters to the largest character in the line. */ characterAlignment: CharacterAlignment; /** * The direction of the character. */ characterDirection: CharacterDirectionOptions; /** * The rotation angle (in degrees) of individual characters. Note: The rotation * is counterclockwise. */ characterRotation: number; /** * A collection of characters. */ readonly characters: Characters; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * If true, uses grid tracking to track non-Roman characters in CJK grids. */ cjkGridTracking: boolean; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * The text composer to use to compose the text. */ composer: string; /** * The contents of the text. Can return: String or SpecialCharacters * enumerator. */ contents: string | SpecialCharacters; /** * The maximum descent of any character in the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly descent: number | string; /** * Value of Design Axes */ designAxes: number[]; /** * The desired width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ desiredGlyphScaling: number; /** * The desired letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) */ desiredLetterSpacing: number; /** * The desired word spacing, specified as a percentage of the font word space * value. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ desiredWordSpacing: number; /** * Position of diacriticical characters. */ diacriticPosition: DiacriticPositionOptions; /** * The digits type. */ digitsType: DigitsTypeOptions; /** * The number of characters to drop cap. * @remarks Range: 0 to 150 */ dropCapCharacters: number; /** * The number of lines to drop cap. * @remarks Range: 0 to 25 */ dropCapLines: number; /** * The character style to apply to the drop cap. Can also accept: String. */ dropCapStyle: CharacterStyle | string; /** * Details about the drop cap based on the glyph outlines. 1 = left side * bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid. */ dropcapDetail: number; /** * Vertical offset of the end of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly endBaseline: number | string; /** * Horizontal offset of the end of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly endHorizontalOffset: number | string; /** * The stroke join type applied to the characters of the text. */ endJoin: OutlineJoin; /** * A collection of endnote text ranges. */ readonly endnoteRanges: EndnoteRanges; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * Text. . Can also accept: String. */ fillColor: Swatch | string; /** * The tint (as a percentage) of the fill color of the Text. (To specify a tint * percentage, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * The amount to indent the first line. * @remarks Measurement unit — also accepts a string such as "12mm". */ firstLineIndent: number | string; /** * The name of the font style. */ fontStyle: string; /** * A collection of footnotes. */ readonly footnotes: Footnotes; /** * A collection of form fields. */ readonly formFields: FormFields; /** * The glyph variant to substitute for standard glyphs. */ glyphForm: AlternateGlyphForms; /** * The angle of a linear gradient applied to the fill of the text. (Range: -180 * to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the text. */ gradientFillLength: number; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the text. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the text. */ gradientStrokeLength: number; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * If true, aligns only the first line to the frame grid or baseline grid. If * false, aligns all lines to the grid. */ gridAlignFirstLineOnly: boolean; /** * The alignment to the frame grid or baseline grid. */ gridAlignment: GridAlignment; /** * The manual gyoudori setting. */ gridGyoudori: number; /** * A collection of groups. */ readonly groups: Groups; /** * A collection of hidden text objects. */ readonly hiddenTexts: HiddenTexts; /** * The horizontal offset of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly horizontalOffset: number | string; /** * The horizontal scaling applied to the Text. */ horizontalScale: number; /** * The relative desirability of better spacing vs. fewer hyphens. A lower value * results in greater use of hyphens. (Range: 0 to 100) * @remarks Range: 0 to 10 */ hyphenWeight: number; /** * If true, allows the last word in a text column to be hyphenated. */ hyphenateAcrossColumns: boolean; /** * The mininum number of letters at the beginning of a word that can be broken * by a hyphen. * @remarks Range: 1 to 15 */ hyphenateAfterFirst: number; /** * The minimum number of letters at the end of a word that can be broken by a * hyphen. * @remarks Range: 1 to 15 */ hyphenateBeforeLast: number; /** * If true, allows hyphenation of capitalized words. */ hyphenateCapitalizedWords: boolean; /** * The maximum number of hyphens that can appear on consecutive lines. To * specify unlimited consecutive lines, use zero. * @remarks Range: 0 to 25 */ hyphenateLadderLimit: number; /** * If true, allows hyphenation in the last word in a paragraph. Note: Valid * only when hyphenation is true. */ hyphenateLastWord: boolean; /** * The minimum number of letters a word must have in order to qualify for * hyphenation. * @remarks Range: 3 to 25 */ hyphenateWordsLongerThan: number; /** * If true, allows hyphenation. */ hyphenation: boolean; /** * The amount of white space allowed at the end of a line of non-justified text * before hypenation begins. Note: Valid when composer is single-line composer. * @remarks Measurement unit — also accepts a string such as "12mm". */ hyphenationZone: number | string; /** * If true, ignores optical edge alignment for the paragraph. */ ignoreEdgeAlignment: boolean; /** * The index of the text in the collection or parent object. */ readonly index: number; /** * A collection of insertion points. */ readonly insertionPoints: InsertionPoints; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The number of grid squares in which to arrange the text. */ jidori: number; /** * The paragraph alignment. */ justification: Justification; /** * Use of Kashidas for justification */ kashidas: KashidasOptions; /** * If true, keeps all lines of the paragraph together. If false, allows * paragraphs to break across pages or columns. */ keepAllLinesTogether: boolean; /** * The minimum number of lines to keep together in a paragraph before allowing * a page break. * @remarks Range: 1 to 50 */ keepFirstLines: number; /** * The minimum number of lines to keep together in a paragraph after a page * break. * @remarks Range: 1 to 50 */ keepLastLines: number; /** * If true, keeps a specified number of lines together when the paragraph * breaks across columns or text frames. */ keepLinesTogether: boolean; /** * If true, forces the rule above the paragraph to remain in the frame bounds. * Note: Valid only when rule above is true. */ keepRuleAboveInFrame: boolean; /** * The minimum number of lines to keep with the next paragraph. * @remarks Range: 0 to 5 */ keepWithNext: number; /** * If the first line in the paragraph should be kept with the last line of * previous paragraph. */ keepWithPrevious: boolean; /** * The alignment of kenten characters relative to the parent characters. */ kentenAlignment: KentenAlignment; /** * The character set used for the custom kenten character. Note: Valid only * when kenten kind is custom. */ kentenCharacterSet: KentenCharacterSet; /** * The character used for kenten. Note: Valid only when kenten kind is custom. */ kentenCustomCharacter: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of * kenten characters. Can return: Swatch or String. */ kentenFillColor: Swatch | string; /** * The font to use for kenten characters. Can return: Font or String. */ kentenFont: Font | string; /** * The size (in points) of kenten characters. */ kentenFontSize: number; /** * The font style of kenten characters. Can return: String or NothingEnum * enumerator. */ kentenFontStyle: string | NothingEnum; /** * The style of kenten characters. */ kentenKind: KentenCharacter; /** * The method of overprinting the kenten fill. */ kentenOverprintFill: AdornmentOverprint; /** * The method of overprinting the kenten stroke. */ kentenOverprintStroke: AdornmentOverprint; /** * The distance between kenten characters and their parent characters. */ kentenPlacement: number; /** * The kenten position relative to the parent character. */ kentenPosition: RubyKentenPosition; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * kenten characters. Can return: Swatch or String. */ kentenStrokeColor: Swatch | string; /** * The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenStrokeTint: number; /** * The fill tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenTint: number; /** * The stroke weight (in points) of kenten characters. */ kentenWeight: number; /** * The horizontal size of kenten characters as a percent of the original size. */ kentenXScale: number; /** * The vertical size of kenten charachers as a percent of the original size. */ kentenYScale: number; /** * The type of pair kerning. */ kerningMethod: string; /** * The amount of space to add or remove between characters, specified in * thousands of an em. */ kerningValue: number; /** * The keyboard direction of the character. */ keyboardDirection: CharacterDirectionOptions; /** * The type of hanging punctuation to allow. Note: Valid only when a kinsoku * set is in effect. */ kinsokuHangType: KinsokuHangTypes; /** * The kinsoku set that determines legitimate line breaks. Can return: * KinsokuTable, KinsokuSet enumerator or String. */ kinsokuSet: KinsokuSet | KinsokuTable | string; /** * The type of kinsoku processing for preventing kinsoku characters from * beginning or ending a line. Note: Valid only when a kinsoku set is defined. */ kinsokuType: KinsokuType; /** * The amount to indent the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ lastLineIndent: number | string; /** * The leading applied to the text. Can return: Unit or Leading enumerator. */ leading: number | Leading; /** * The amount of space before each character. */ leadingAki: number; /** * The point from which leading is measured from line to line. */ leadingModel: LeadingModel; /** * The width of the left indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ leftIndent: number | string; /** * The number of objects in the collection. */ readonly length: number; /** * If true, replaces specific character combinations (e.g., fl, fi) with * ligature characters. */ ligatures: boolean; /** * A collection of lines. */ readonly lines: Lines; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * The maximum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ maximumGlyphScaling: number; /** * The maximum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ maximumLetterSpacing: number; /** * The maximum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ maximumWordSpacing: number; /** * If true, consecutive para borders with completely similar properties are * merged. */ mergeConsecutiveParaBorders: boolean; /** * The minimum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ minimumGlyphScaling: number; /** * The minimum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ minimumLetterSpacing: number; /** * The minimum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ minimumWordSpacing: number; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 0 to 1000 */ miterLimit: number; /** * The mojikumi table. For information, see mojikumi table defaults. Can * return: MojikumiTable, String or MojikumiTableDefaults enumerator. */ mojikumi: MojikumiTable | string | MojikumiTableDefaults; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * A collection of nested GREP styles. */ readonly nestedGrepStyles: NestedGrepStyles; /** * A collection of nested line styles. */ readonly nestedLineStyles: NestedLineStyles; /** * A collection of nested styles. */ readonly nestedStyles: NestedStyles; /** * If true, keeps the text on the same line. */ noBreak: boolean; /** * A collection of notes. */ readonly notes: Notes; /** * The alignment of the number. */ numberingAlignment: ListAlignment; /** * If true, apply the numbering restart policy. */ numberingApplyRestartPolicy: boolean; /** * The character style to be used for the number string. Can return: * CharacterStyle or String. */ numberingCharacterStyle: CharacterStyle | string; /** * Continue the numbering at this level. */ numberingContinue: boolean; /** * The number string expression for numbering. */ numberingExpression: string; /** * Numbering format options. Can return: NumberingStyle enumerator or String. */ numberingFormat: NumberingStyle | string; /** * The level of the paragraph. */ numberingLevel: number; /** * Numbering restart policies. */ readonly numberingRestartPolicies: NumberingRestartPolicy; /** * Determines starting number in a numbered list. */ numberingStartAt: number; /** * OpenType features. Can return: Array of Array of 2 Strings or Long Integers. */ opentypeFeatures: (string[][] | number[])[]; /** * If true, uses contextual alternate forms in OpenType fonts. */ otfContextualAlternate: boolean; /** * If true, uses discretionary ligatures in OpenType fonts. */ otfDiscretionaryLigature: boolean; /** * The figure style in OpenType fonts. */ otfFigureStyle: OTFFigureStyle; /** * If true, uses fractions in OpenType fonts. */ otfFraction: boolean; /** * If true, switches hiragana fonts, which have different glyphs for horizontal * and vertical. */ otfHVKana: boolean; /** * If true, use historical forms in OpenType fonts. */ otfHistorical: boolean; /** * If true, use alternate justification forms in OpenType fonts */ otfJustificationAlternate: boolean; /** * If true, uses localized forms in OpenType fonts. */ otfLocale: boolean; /** * If true, uses mark positioning in OpenType fonts. */ otfMark: boolean; /** * If true, uses ordinals in OpenType fonts. */ otfOrdinal: boolean; /** * If true, use overlapping swash forms in OpenType fonts */ otfOverlapSwash: boolean; /** * If true, kerns according to proportional CJK metrics in OpenType fonts. */ otfProportionalMetrics: boolean; /** * If true, applies italics to half-width alphanumerics. */ otfRomanItalics: boolean; /** * If true, use a slashed zeroes in OpenType fonts. */ otfSlashedZero: boolean; /** * If true, use stretched alternate forms in OpenType fonts */ otfStretchedAlternate: boolean; /** * If true, use stylistic alternate forms in OpenType fonts */ otfStylisticAlternate: boolean; /** * The stylistic sets to use in OpenType fonts. */ otfStylisticSets: number; /** * If true, uses swash forms in OpenType fonts. */ otfSwash: boolean; /** * If true, uses titling forms in OpenType fonts. */ otfTitling: boolean; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the fill color of the characters will overprint. */ overprintFill: boolean; /** * If true, the stroke of the characters will overprint. */ overprintStroke: boolean; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphBorderBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLeftCornerRadius: number | string; /** * The bottom line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLineWeight: number | string; /** * The distance to offset the bottom edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph border. */ paragraphBorderBottomOrigin: ParagraphBorderBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphBorderBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomRightCornerRadius: number | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * stroke. Can return: Swatch or String. */ paragraphBorderColor: Swatch | string; /** * If true, then paragraph border is also displayed at the points where the * paragraph splits across frames or columns. */ paragraphBorderDisplayIfSplits: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * border gap. Note: Valid only when the border type is not solid. Can return: * Swatch or String. */ paragraphBorderGapColor: Swatch | string; /** * If true, the paragraph border gap will overprint. Note: Valid only when * border type is not solid. */ paragraphBorderGapOverprint: boolean; /** * The tint (as a percentage) of the paragraph border gap. Note: Valid only * when the border type is not solid. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderGapTint: number; /** * The left line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftLineWeight: number | string; /** * The distance to offset the left edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftOffset: number | string; /** * If true, the paragraph border is on. */ paragraphBorderOn: boolean; /** * If true, the paragraph border will overprint. */ paragraphBorderOverprint: boolean; /** * The right line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightLineWeight: number | string; /** * The distance to offset the right edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightOffset: number | string; /** * The end shape of an open path. */ paragraphBorderStrokeEndCap: EndCap; /** * The corner join applied to the Text. */ paragraphBorderStrokeEndJoin: EndJoin; /** * The tint (as a percentage) of the paragraph stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphBorderTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLeftCornerRadius: number | string; /** * The top line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLineWeight: number | string; /** * The distance to offset the top edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph border. */ paragraphBorderTopOrigin: ParagraphBorderTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphBorderTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopRightCornerRadius: number | string; /** * The type of the border for the paragraph. Can return: StrokeStyle or String. */ paragraphBorderType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph border. */ paragraphBorderWidth: ParagraphBorderEnum; /** * Paragraph direction. */ paragraphDirection: ParagraphDirectionOptions; /** * If true, the gyoudori mode applies to the entire paragraph. If false, the * gyoudori mode applies to each line in the paragraph. */ paragraphGyoudori: boolean; /** * Paragraph justification. */ paragraphJustification: ParagraphJustificationOptions; /** * Paragraph kashida width. 0 is none, 1 is short, 2 is medium, 3 is long */ paragraphKashidaWidth: number; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphShadingBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomLeftCornerRadius: number | string; /** * The distance to offset the bottom edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph shading. */ paragraphShadingBottomOrigin: ParagraphShadingBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphShadingBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomRightCornerRadius: number | string; /** * If true, forces the shading of the paragraph to be clipped with respect to * frame shape. */ paragraphShadingClipToFrame: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * shading. Can return: Swatch or String. */ paragraphShadingColor: Swatch | string; /** * The distance to offset the left edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingLeftOffset: number | string; /** * If true, the paragraph shading is On. */ paragraphShadingOn: boolean; /** * If true, the paragraph shading will overprint. */ paragraphShadingOverprint: boolean; /** * The distance to offset the right edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingRightOffset: number | string; /** * If true, suppress printing of the shading of the paragraph. */ paragraphShadingSuppressPrinting: boolean; /** * The tint (as a percentage) of the paragraph shading. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphShadingTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphShadingTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopLeftCornerRadius: number | string; /** * The distance to offset the top edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph shading. */ paragraphShadingTopOrigin: ParagraphShadingTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphShadingTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopRightCornerRadius: number | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph shading. */ paragraphShadingWidth: ParagraphShadingWidthEnum; /** * A collection of paragraphs. */ readonly paragraphs: Paragraphs; /** * The parent of the Text (a XmlStory, TextPath, TextFrame, EndnoteTextFrame, * Text, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, * Character, Story, Cell, XMLElement, Endnote, Footnote, Note, Change or * HiddenText). */ readonly parent: Cell | Change | Character | Endnote | EndnoteTextFrame | Footnote | InsertionPoint | Line | Note | Paragraph | Story | Text | TextColumn | TextFrame | TextPath | TextStyleRange | Word | XMLElement | HiddenText | XmlStory; /** * The story that contains the text. */ readonly parentStory: Story; /** * An array of the text frames that contain the text. Can return: Array of * TextFrames or TextPaths. */ readonly parentTextFrames: (TextFrames | TextPaths)[]; /** * The text size. * @remarks Measurement unit — also accepts a string such as "12mm". */ pointSize: number | string; /** * A collection of polygons. */ readonly polygons: Polygons; /** * The text position relative to the baseline. */ position: Position; /** * The OpenType positional form. */ positionalForm: PositionalForms; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The hyphenation style chosen for the provider. */ providerHyphenationStyle: HyphenationStyleEnum; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * If true, disallows line breaks in numbers. If false, lines can break between * digits in multi-digit numbers. */ rensuuji: boolean; /** * The width of the right indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ rightIndent: number | string; /** * If true, rotates Roman characters in vertical text. */ rotateSingleByteCharacters: boolean; /** * The ruby alignment. */ rubyAlignment: RubyAlignments; /** * If true, auto aligns ruby. */ rubyAutoAlign: boolean; /** * If true, automatically scales ruby to the specified percent of parent text * size. For information on specifying a percent, see ruby parent scaling * percent. */ rubyAutoScaling: boolean; /** * If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to * fit one em. */ rubyAutoTcyAutoScale: boolean; /** * The number of digits included in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyDigits: number; /** * If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyIncludeRoman: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby * characters. Can return: Swatch or String. */ rubyFill: Swatch | string; /** * If true, ruby is on. */ rubyFlag: boolean; /** * The font applied to ruby characters. Can return: Font or String. */ rubyFont: Font | string; /** * The size (in points) of ruby characters. */ rubyFontSize: number; /** * The font style of ruby characters. Can return: String or NothingEnum * enumerator. */ rubyFontStyle: string | NothingEnum; /** * If true, uses OpenType Pro fonts for ruby. */ rubyOpenTypePro: boolean; /** * If true, constrains ruby overhang to the specified amount. For information * on specifying an amount, see ruby parent overhang amount. */ rubyOverhang: boolean; /** * The method of overprinting the ruby fill. */ rubyOverprintFill: AdornmentOverprint; /** * The method of overprinting the ruby stroke. */ rubyOverprintStroke: AdornmentOverprint; /** * The amount by which ruby characters can overhang the parent text. */ rubyParentOverhangAmount: RubyOverhang; /** * The amount (as a percentage) to scale the parent text size to determine the * ruby text size. */ rubyParentScalingPercent: number; /** * The ruby spacing relative to the parent text. */ rubyParentSpacing: RubyParentSpacing; /** * The position of ruby characters relative to the parent text. */ rubyPosition: RubyKentenPosition; /** * The ruby string contents. */ rubyString: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * ruby characters. Can return: Swatch or String. */ rubyStroke: Swatch | string; /** * The stroke tint (as a percentage) of ruby characters. */ rubyStrokeTint: number; /** * The tint (as a percentage) of the ruby fill color. (Range: 0 to 100) * @remarks Range: 0 to 100 */ rubyTint: number; /** * The ruby type. */ rubyType: RubyTypes; /** * The stroke weight (in points) of ruby characters. */ rubyWeight: number; /** * The amount of horizontal space between ruby and parent characters. */ rubyXOffset: number; /** * The horizontal size of ruby characters, specified as a percent of the * original size. */ rubyXScale: number; /** * The amount of vertical space between ruby and parent characters. */ rubyYOffset: number; /** * The vertical size of ruby characters, specified as a percent of the original * size. */ rubyYScale: number; /** * If true, places a rule above the paragraph. */ ruleAbove: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule above. Can return: Swatch or String. */ ruleAboveColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule above. Note: Valid only when the paragraph rule above * type is not solid. Can return: Swatch or String. */ ruleAboveGapColor: Swatch | string; /** * If true, the stroke gap of the paragraph rule above will overprint. Note: * Valid only the rule above type is not solid. */ ruleAboveGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule. * (Range: 0 to 100) Note: Valid only when the rule above type is not solid. * @remarks Range: 0 to 100 */ ruleAboveGapTint: number; /** * The distance to indent the left edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLeftIndent: number | string; /** * The line weight of the rule above. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLineWeight: number | string; /** * The amount to offset the paragraph rule above from the baseline of the first * line the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveOffset: number | string; /** * If true, the paragraph rule above will overprint. */ ruleAboveOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleAboveTint: number; /** * The stroke type of the rule above the paragraph. Can return: StrokeStyle or * String. */ ruleAboveType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule above. */ ruleAboveWidth: RuleWidth; /** * If true, applies a paragraph rule below. */ ruleBelow: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule below. Can return: Swatch or String. */ ruleBelowColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule below. Note: Valid only when the paragraph rule below * type is not solid. Can return: Swatch or String. */ ruleBelowGapColor: Swatch | string; /** * If true, the gap color of the rule below will overprint. */ ruleBelowGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule * below. (Range: 0 to 100) Note: Valid only when the paragraph rule below type * is not solid. * @remarks Range: 0 to 100 */ ruleBelowGapTint: number; /** * The distance to indent the left edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLeftIndent: number | string; /** * The line weight of the rule below. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLineWeight: number | string; /** * The amount to offset the the paragraph rule below from the baseline of the * last line of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowOffset: number | string; /** * If true, the rule below will overprint. */ ruleBelowOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleBelowTint: number; /** * The stroke type of the rule below the paragraph. Can return: StrokeStyle or * String. */ ruleBelowType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule below. */ ruleBelowWidth: RuleWidth; /** * The space between paragraphs using same style. Can return: Unit or Spacing * enumerator. */ sameParaStyleSpacing: number | Spacing; /** * If true, the line changes size when characters are scaled. */ scaleAffectsLineHeight: boolean; /** * If true, applies shatai rotation. */ shataiAdjustRotation: boolean; /** * If true, adjusts shatai tsume. */ shataiAdjustTsume: boolean; /** * The shatai lens angle (in degrees). */ shataiDegreeAngle: number; /** * The amount (as a percentage) of shatai obliquing to apply. */ shataiMagnification: number; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * The alignment to use for lines that contain a single word. */ singleWordJustification: SingleWordJustification; /** * The skew angle of the Text. */ skew: number; /** * The height of the paragraph space below. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceAfter: number | string; /** * The height of the paragraph space above. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceBefore: number | string; /** * The minimum space after a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceAfter: number | string; /** * The minimum space before a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceBefore: number | string; /** * Whether a paragraph should be a single column, span columns or split columns */ spanColumnType: SpanColumnTypeOptions; /** * The number of columns a paragraph spans or the number of split columns. Can * return: Short Integer (1 - 40) or SpanColumnCountOptions enumerator. */ spanSplitColumnCount: number | SpanColumnCountOptions; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The inside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnInsideGutter: number | string; /** * The outside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnOutsideGutter: number | string; /** * The location at which to start the paragraph. */ startParagraph: StartParagraph; /** * The swatch (color, gradient, tint, or mixed ink) applied to the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughGapColor: Swatch | string; /** * If true, the gap color of the strikethrough stroke will overprint. Note: * Valid when strike through type is not solid. */ strikeThroughGapOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 * to 100) Note: Valid when strike through type is not solid. * @remarks Range: 0 to 100 */ strikeThroughGapTint: number; /** * The amount by which to offset the strikethrough stroke from the text * baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughOffset: number | string; /** * If true, the strikethrough stroke will overprint. */ strikeThroughOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ strikeThroughTint: number; /** * The stroke type of the strikethrough stroke. Can return: StrokeStyle or * String. */ strikeThroughType: StrokeStyle | string; /** * The stroke weight of the strikethrough stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughWeight: number | string; /** * If true, draws a strikethrough line through the text. */ strikeThru: boolean; /** * The stroke alignment applied to the text. */ strokeAlignment: TextStrokeAlign; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the Text. Can also accept: String. */ strokeColor: Swatch | string; /** * The tint (as a percentage) of the stroke color of the Text. (To specify a * tint percentage, use a number in the range of 0 to 100; to use the inherited * or overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * The stroke weight applied to the characters of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * If true, the applied style has been overridden with additional attributes. */ readonly styleOverridden: boolean; /** * A list of the tab stops in the paragraph. Can return: Array of Arrays of * Property Name/Value Pairs. */ tabList: any[][][]; /** * A collection of tab stops. */ readonly tabStops: TabStops; /** * A collection of tables. */ readonly tables: Tables; /** * If true, makes the character horizontal in vertical text. */ tatechuyoko: boolean; /** * The horizontal offset for horizontal characters in vertical text. */ tatechuyokoXOffset: number; /** * The vertical offset for horizontal characters in vertical text. */ tatechuyokoYOffset: number; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text columns. */ readonly textColumns: TextColumns; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * A collection of text style ranges. */ readonly textStyleRanges: TextStyleRanges; /** * A collection of text variable instances. */ readonly textVariableInstances: TextVariableInstances; /** * A collection of text objects. */ readonly texts: Texts; /** * The amount by which to loosen or tighten a block of text, specified in * thousands of an em. */ tracking: number; /** * The amount of space after each character. */ trailingAki: number; /** * If true, ideographic spaces will not wrap to the next line like text * characters. */ treatIdeographicSpaceAsSpace: boolean; /** * The amount of horizontal character compression. */ tsume: number; /** * If true, underlines the text. */ underline: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the underline * stroke. . Can return: Swatch or String. */ underlineColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * underline stroke. Note: Valid when underline type is not solid. Can return: * Swatch or String. */ underlineGapColor: Swatch | string; /** * If true, the gap color of the underline stroke will overprint. */ underlineGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of the underline stroke. (Range: * 0 to 100) Note: Valid when underline type is not solid. * @remarks Range: 0 to 100 */ underlineGapTint: number; /** * The amount by which to offset the underline from the text baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineOffset: number | string; /** * If true, the underline stroke color will overprint. */ underlineOverprint: boolean; /** * The underline stroke tint (as a percentage). (Range: 0 to 100) * @remarks Range: 0 to 100 */ underlineTint: number; /** * The stroke type of the underline stroke. Can return: StrokeStyle or String. */ underlineType: StrokeStyle | string; /** * The stroke weight of the underline stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineWeight: number | string; /** * The vertical scaling applied to the Text. */ verticalScale: number; /** * If true, turns on warichu. */ warichu: boolean; /** * The warichu alignment. */ warichuAlignment: WarichuAlignment; /** * The minimum number of characters allowed after a line break. */ warichuCharsAfterBreak: number; /** * The minimum number of characters allowed before a line break. */ warichuCharsBeforeBreak: number; /** * The gap between lines of warichu characters. */ warichuLineSpacing: number; /** * The number of lines of warichu within a single normal line. */ warichuLines: number; /** * The amount (as a percentage) to scale parent text size to determine warichu * size. */ warichuSize: number; /** * A collection of words. */ readonly words: Words; /** * The x (horizontal) offset for diacritic adjustment. */ xOffsetDiacritic: number; /** * The y (vertical) offset for diacritic adjustment. */ yOffsetDiacritic: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Apply a character style. * @param using The character style to apply. */ applyCharacterStyle(using: CharacterStyle): void; /** * Apply one or more conditions. * @param using The condition(s) to apply * @param removeExisting If true, remove existing conditions. (Optional) */ applyConditions(using: Condition[], removeExisting?: boolean): void; /** * Apply a paragraph style. * @param using The paragraph style to apply. * @param clearingOverrides If true, clear any text attributes before applying the style. (Optional) */ applyParagraphStyle(using: ParagraphStyle, clearingOverrides?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds glyphs that match the find what value and replaces the glyphs with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value and replaces the text * with the change character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeTransliterate(reverseOrder?: boolean): Text[]; /** * Sets the case of the text. * @param using The text case option. */ changecase(using: ChangecaseMode): void; /** * Clears the specified types of override. * @param overridesToClear The types of override to clear. (Optional) */ clearOverrides(overridesToClear?: OverrideType): void; /** * Convert bullets and numbering to text. */ convertBulletsAndNumberingToText(): void; /** * Converts the text to a note. */ convertToNote(): Note; /** * Converts the text to a table. * @param columnSeparator The character that starts a new column in the new table. (Optional) * @param rowSeparator The character starts a new row in the new table. (Optional) * @param numberOfColumns The number of columns in the table. Note: Valid only when the column and row separator characters are the same. (Optional) */ convertToTable(columnSeparator?: string, rowSeparator?: string, numberOfColumns?: number): Table; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Text. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Text. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Converts text to outlines. Each line of text becomes a polygon object. When * the converted text is a single letter that has no internal spaces or * detached parts, the polygon contains only a single path. Note: To determine * whether a font allows the creation of outlines, see allow outlines. * @param deleteOriginal If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) */ createOutlines(deleteOriginal?: boolean): PageItem[]; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Text. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create thumbnail for selected text using the applied style and overrides * with the given properties. * @param previewText Text to use as sample * @param pointSize Text font size (in points) * @param space Color space RGB, CMYK or LAB * @param colorValue Color values * @param to The path to the export file. * @param charOrParaStyle The applied style type to use. */ createStyleThumbnailWithProperties(previewText: string, pointSize: number, space: ColorSpace, colorValue: number[], to: File, charOrParaStyle: StyleType): boolean; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Text. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create thumbnail for selected text with the given properties. * @param previewText Text to use as sample * @param pointSize Text font size (in points) * @param space Color space RGB, CMYK or LAB * @param colorValue Color values * @param to The path to the export file. */ createThumbnailWithProperties(previewText: string, pointSize: number, space: ColorSpace, colorValue: number[], to: File): boolean; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Text. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Duplicates the text in the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional) */ duplicate(to: LocationOptions, reference?: Cell | Column | Row | Story | Table | Text | PageItem): Text; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Finds glyphs that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGrep(reverseOrder?: boolean): Text[]; /** * Finds hyperlink sources that intersecting with specified text range. * @param sortOrder The sort order of found ranges. (Optional) */ findHyperlinks(sortOrder?: RangeSortOrder): HyperlinkTextSource[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findTransliterate(reverseOrder?: boolean): Text[]; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Text[]; /** * If true, Nth design axis of variable font is hidden. * @param nthAxisIndex Index of design axis. */ isNthDesignAxisHidden(nthAxisIndex: number): boolean; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the text to the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional) */ move(to: LocationOptions, reference?: Cell | Column | Row | Story | Table | Text | PageItem): Text; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Recomposes the text in the Text. */ recompose(): void; /** * Deletes the Text. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Selects the object. * @param existingSelection The selection status of the Text in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Set Nth design axis of a variable font. * @param nthAxisIndex Index of design axis. * @param nthAxisValue Value of nth design axis. */ setNthDesignAxis(nthAxisIndex: number, nthAxisValue: number): void; /** * Jump to the text range. */ showText(): void; /** * If true, text has local overrides * @param charOrParaStyle Style type to look at. * @param charStyleAsOverride Whether to consider character styles as overrides or not (Optional) */ textHasOverrides(charOrParaStyle: StyleType, charStyleAsOverride?: boolean): boolean; /** * Generates a string which, if executed, will return the Text. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A text box. */ declare class TextBox extends FormField { /** * Indicates whether the TextBox has been flipped independently of its parent * object and, if yes, the direction in which the TextBox was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the TextBox relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the TextBox relative to its containing object. (Range: * -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the TextBox relative to its containing object. (Range: * -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the TextBox relative to its containing object. */ absoluteVerticalScale: number; /** * The index of the active state in the object's states collection. */ activeStateIndex: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the TextBox. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the TextBox. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * Anchored object settings. */ readonly anchoredObjectSettings: AnchoredObjectSetting; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The font family for the form field in the exported PDF. */ appliedFont: string; /** * The object style applied to the TextBox. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the TextBox. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the TextBox. */ readonly associatedXMLElement: XMLItem; /** * A collection of behavior objects. */ readonly behaviors: Behaviors; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * A collection of clear form behavior objects. */ readonly clearFormBehaviors: ClearFormBehaviors; /** * Transparency settings for the content of the TextBox. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The description of the TextBox. */ description: string; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the TextBox. */ endJoin: EndJoin; /** * A collection of EPS files. */ readonly epss: EPSs; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * TextBox. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the TextBox's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the TextBox. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * The font size for the form field in the exported PDF. */ fontSize: number; /** * The font style for the form field in the exported PDF. */ fontStyle: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the TextBox excluding the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * A collection of goto anchor behavior objects. */ readonly gotoAnchorBehaviors: GotoAnchorBehaviors; /** * A collection of goto first page behavior objects. */ readonly gotoFirstPageBehaviors: GotoFirstPageBehaviors; /** * A collection of goto last page behavior objects. */ readonly gotoLastPageBehaviors: GotoLastPageBehaviors; /** * A collection of goto next page behavior objects. */ readonly gotoNextPageBehaviors: GotoNextPageBehaviors; /** * A collection of goto next view behavior objects. */ readonly gotoNextViewBehaviors: GotoNextViewBehaviors; /** * A collection of goto previous page behavior objects. */ readonly gotoPreviousPageBehaviors: GotoPreviousPageBehaviors; /** * A collection of goto previous view behavior objects. */ readonly gotoPreviousViewBehaviors: GotoPreviousViewBehaviors; /** * A collection of goto URL behavior objects. */ readonly gotoURLBehaviors: GotoURLBehaviors; /** * The angle of a linear gradient applied to the fill of the TextBox. (Range: * -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the TextBox. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the TextBox, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the TextBox. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the TextBox. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the TextBox, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * A collection of groups. */ readonly groups: Groups; /** * If true, the form field/push button is hidden until triggered in the * exported PDF. */ hiddenUntilTriggered: boolean; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the TextBox. */ horizontalScale: number; /** * The unique ID of the TextBox. */ readonly id: number; /** * A collection of bitmap images in any bitmap file format (including TIFF, * JPEG, or GIF). */ readonly images: Images; /** * The index of the TextBox within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the TextBox is on. */ itemLayer: Layer; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the TextBox. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the TextBox is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * A collection of movie behavior objects. */ readonly movieBehaviors: MovieBehaviors; /** * If true, the text field is multiline in the exported PDF. */ multiline: boolean; /** * The name of the TextBox. */ name: string; /** * If true, the TextBox does not print. */ nonprinting: boolean; /** * A collection of open file behavior objects. */ readonly openFileBehaviors: OpenFileBehaviors; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the TextBox's fill color overprints any underlying objects. If * false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the TextBox's stroke color overprints any underlying objects. If * false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the TextBox (a Snippet, PlaceGun, FlexObject, Character, * Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval or * Group). */ readonly parent: Character | FlexObject | GraphicLine | MasterSpread | Oval | PlaceGun | Polygon | Rectangle | SplineItem | Spread | Group | Snippet; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * If true, the text field is a password field in the exported PDF. */ password: boolean; /** * A collection of PDF files. */ readonly pdfs: PDFs; /** * A collection of PICT graphics. */ readonly picts: PICTs; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A collection of print form behavior objects. */ readonly printFormBehaviors: PrintFormBehaviors; /** * If true, the form field/push button is printable in the exported PDF. */ printableInPdf: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, the form field is read only in the exported PDF. */ readOnly: boolean; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * If true, the form field is required in the exported PDF. */ required: boolean; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * If true, the form field has right to left text enabled in the exported PDF. */ rightToLeftField: boolean; /** * The rotatation angle of the TextBox. (Range: -360 to 360) */ rotationAngle: number; /** * If true, the text field is scrollable in the exported PDF. */ scrollable: boolean; /** * The skewing angle applied to the TextBox. (Range: -360 to 360) */ shearAngle: number; /** * A collection of show/hide fields behavior objects. */ readonly showHideFieldsBehaviors: ShowHideFieldsBehaviors; /** * A collection of sound behavior objects. */ readonly soundBehaviors: SoundBehaviors; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The stroke alignment applied to the TextBox. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the TextBox. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the TextBox. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the TextBox's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of submit form behavior objects. */ readonly submitFormBehaviors: SubmitFormBehaviors; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the TextBox. */ verticalScale: number; /** * A collection of view zoom behavior objects. */ readonly viewZoomBehaviors: ViewZoomBehaviors; /** * If true, the TextBox is visible. */ visible: boolean; /** * The bounds of the TextBox including the stroke width, in the format [y1, x1, * y2, x2], which give the coordinates of the top-left and bottom-right corners * of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * A collection of WMF graphics. */ readonly wmfs: WMFs; /** * Dispatched after a TextBox is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a TextBox is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the TextBox's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the TextBox that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Brings the TextBox forward one level in its layer. */ bringForward(): void; /** * Brings the TextBox to the front of its layer or in front of a particular * item. * @param reference The reference object to bring the object in front of (must have same parent) (Optional) */ bringToFront(reference?: PageItem): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the TextBox. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the TextBox to a different shape. * @param given The TextBox's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Converts the button object to the page item currently in the active state. * Page items from other states will be lost. */ convertToObject(): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new TextBox. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new TextBox. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new TextBox. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new TextBox. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new TextBox. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the TextBox at the specified location or offset. * @param to The location of the new TextBox, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new TextBox from the original TextBox's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the TextBox. * @param given The axis around which to flip the TextBox. * @param around The point around which to flip the TextBox. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TextBox[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the TextBox to a new location. Note: Either the 'to' or 'by' parameter * is required; if both parameters are defined, only the to value is used. * @param to The new location of the TextBox,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the TextBox relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the TextBox. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the TextBox in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Sends the TextBox back one level in its layer. */ sendBackward(): void; /** * Sends the TextBox to the back of its layer or behind a particular item (must * have same parent). * @param reference The reference object to send the object behind (Optional) */ sendToBack(reference?: PageItem): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new TextBox (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the TextBox. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the TextBox using the last transformation performed on any * object. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgain(): string[]; /** * Transforms the TextBox using the last transformation performed on any * TextBox. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgainIndividually(): string[]; /** * Transforms the TextBox using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the TextBox using the last sequence of transformations performed * on any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * A collection of text boxes. */ declare class TextBoxes { /** Returns the TextBox with the specified index or name. */ [index: number]: TextBox; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new TextBox * @param layer The layer on which to create the TextBox. (Optional) * @param at The location at which to insert the TextBox relative to the reference object or within the container object. (Optional) * @param reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) * @param withProperties Initial values for properties of the new TextBox (Optional) */ add(layer?: Layer, at?: LocationOptions, reference?: Document | Layer | MasterSpread | Page | Spread | PageItem, withProperties?: Object): TextBox; /** * Returns any TextBox in the collection. */ anyItem(): TextBox; /** * Displays the number of elements in the TextBox. */ count(): number; /** * Returns every TextBox in the collection. */ everyItem(): TextBox; /** * Returns the first TextBox in the collection. */ firstItem(): TextBox; /** * Returns the TextBox with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): TextBox; /** * Returns the TextBox with the specified ID. * @param id The ID. */ itemByID(id: number): TextBox; /** * Returns the TextBox with the specified name. * @param name The name. */ itemByName(name: string): TextBox; /** * Returns the TextBoxes within the specified range. * @param from The TextBox, index, or name at the beginning of the range. Can accept: TextBox, Long Integer or String. * @param to The TextBox, index, or name at the end of the range. Can accept: TextBox, Long Integer or String. */ itemByRange(from: number | TextBox | string, to: number | TextBox | string): TextBox[]; /** * Returns the last TextBox in the collection. */ lastItem(): TextBox; /** * Returns the middle TextBox in the collection. */ middleItem(): TextBox; /** * Returns the TextBox whose index follows the specified TextBox in the * collection. * @param obj The TextBox whose index comes before the desired TextBox. */ nextItem(obj: TextBox): TextBox; /** * Returns the TextBox with the index previous to the specified index. * @param obj The index of the TextBox that follows the desired TextBox. */ previousItem(obj: TextBox): TextBox; /** * Generates a string which, if executed, will return the TextBox. */ toSource(): string; } /** * A text column. */ declare class TextColumn extends Text { /** * If true, aligns the baseline of the text to the baseline grid. */ alignToBaseline: boolean; /** * Lists all graphics contained by the TextColumn. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the TextColumn. */ readonly allPageItems: PageItem[]; /** * If true, words unassociated with a hyphenation dictionary can break to the * next line on any character. */ allowArbitraryHyphenation: boolean; /** * The character style applied to the text. Can also accept: String. */ appliedCharacterStyle: CharacterStyle | string; /** * The applied conditions. */ appliedConditions: Condition[]; /** * The font applied to the TextColumn, specified as either a font object or the * name of font family. Can return: Font or String. */ appliedFont: Font | string; /** * The language of the text. Can return: LanguageWithVendors or Language. Can * also accept: String. */ appliedLanguage: LanguageWithVendors | string | Language; /** * The applied character styles dictated by nested styles. */ readonly appliedNestedStyles: CharacterStyle[]; /** * The list to be part of. Can return: NumberingList or String. */ appliedNumberingList: NumberingList | string; /** * The paragraph style applied to the text. Can also accept: String. */ appliedParagraphStyle: ParagraphStyle | string; /** * The maximum ascent of any character in the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly ascent: number | string; /** * The XML elements associated with the TextColumn. */ readonly associatedXMLElements: XMLItem[]; /** * The percent of the type size to use for auto leading. (Range: 0 to 500). * @remarks Range: 0 to 500 */ autoLeading: number; /** * The number of half-width characters at or below which the characters * automatically run horizontally in vertical text. */ autoTcy: number; /** * If true, auto tcy includes Roman characters. */ autoTcyIncludeRoman: boolean; /** * If true or set to an enumeration value, balances ragged lines. Note: Not * valid with a single-line text composer. Can return: Boolean or * BalanceLinesStyle enumerator. */ balanceRaggedLines: boolean | BalanceLinesStyle; /** * The vertical offset of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly baseline: number | string; /** * The baseline shift applied to the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ baselineShift: number | string; /** * Bullet character. */ readonly bulletChar: Bullet; /** * The alignment of the bullet character. */ bulletsAlignment: ListAlignment; /** * List type for bullets and numbering. */ bulletsAndNumberingListType: ListType; /** * The character style to be used for the text after string. Can return: * CharacterStyle or String. */ bulletsCharacterStyle: CharacterStyle | string; /** * The text after string expression for bullets. */ bulletsTextAfter: string; /** * If true, adds the double period (..), ellipse (...), and double hyphen (--) * to the selected kinsoku set. Note: Valid only when a kinsoku set is in * effect. */ bunriKinshi: boolean; /** * A collection of buttons. */ readonly buttons: Buttons; /** * The capitalization scheme. */ capitalization: Capitalization; /** * The alignment of small characters to the largest character in the line. */ characterAlignment: CharacterAlignment; /** * The direction of the character. */ characterDirection: CharacterDirectionOptions; /** * The rotation angle (in degrees) of individual characters. Note: The rotation * is counterclockwise. */ characterRotation: number; /** * A collection of characters. */ readonly characters: Characters; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * If true, uses grid tracking to track non-Roman characters in CJK grids. */ cjkGridTracking: boolean; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * The text composer to use to compose the text. */ composer: string; /** * The contents of the text. Can return: String or SpecialCharacters * enumerator. */ contents: string | SpecialCharacters; /** * The maximum descent of any character in the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly descent: number | string; /** * Value of Design Axes */ designAxes: number[]; /** * The desired width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ desiredGlyphScaling: number; /** * The desired letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) */ desiredLetterSpacing: number; /** * The desired word spacing, specified as a percentage of the font word space * value. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ desiredWordSpacing: number; /** * Position of diacriticical characters. */ diacriticPosition: DiacriticPositionOptions; /** * The digits type. */ digitsType: DigitsTypeOptions; /** * The number of characters to drop cap. * @remarks Range: 0 to 150 */ dropCapCharacters: number; /** * The number of lines to drop cap. * @remarks Range: 0 to 25 */ dropCapLines: number; /** * The character style to apply to the drop cap. Can also accept: String. */ dropCapStyle: CharacterStyle | string; /** * Details about the drop cap based on the glyph outlines. 1 = left side * bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid. */ dropcapDetail: number; /** * Vertical offset of the end of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly endBaseline: number | string; /** * Horizontal offset of the end of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly endHorizontalOffset: number | string; /** * The stroke join type applied to the characters of the text. */ endJoin: OutlineJoin; /** * A collection of endnote text ranges. */ readonly endnoteRanges: EndnoteRanges; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * TextColumn. . Can also accept: String. */ fillColor: Swatch | string; /** * The tint (as a percentage) of the fill color of the TextColumn. (To specify * a tint percentage, use a number in the range of 0 to 100; to use the * inherited or overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * The amount to indent the first line. * @remarks Measurement unit — also accepts a string such as "12mm". */ firstLineIndent: number | string; /** * The name of the font style. */ fontStyle: string; /** * A collection of footnotes. */ readonly footnotes: Footnotes; /** * A collection of form fields. */ readonly formFields: FormFields; /** * The glyph variant to substitute for standard glyphs. */ glyphForm: AlternateGlyphForms; /** * The angle of a linear gradient applied to the fill of the text. (Range: -180 * to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the text. */ gradientFillLength: number; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the text. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the text. */ gradientStrokeLength: number; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * If true, aligns only the first line to the frame grid or baseline grid. If * false, aligns all lines to the grid. */ gridAlignFirstLineOnly: boolean; /** * The alignment to the frame grid or baseline grid. */ gridAlignment: GridAlignment; /** * The manual gyoudori setting. */ gridGyoudori: number; /** * A collection of groups. */ readonly groups: Groups; /** * A collection of hidden text objects. */ readonly hiddenTexts: HiddenTexts; /** * The horizontal offset of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly horizontalOffset: number | string; /** * The horizontal scaling applied to the TextColumn. */ horizontalScale: number; /** * The relative desirability of better spacing vs. fewer hyphens. A lower value * results in greater use of hyphens. (Range: 0 to 100) * @remarks Range: 0 to 10 */ hyphenWeight: number; /** * If true, allows the last word in a text column to be hyphenated. */ hyphenateAcrossColumns: boolean; /** * The mininum number of letters at the beginning of a word that can be broken * by a hyphen. * @remarks Range: 1 to 15 */ hyphenateAfterFirst: number; /** * The minimum number of letters at the end of a word that can be broken by a * hyphen. * @remarks Range: 1 to 15 */ hyphenateBeforeLast: number; /** * If true, allows hyphenation of capitalized words. */ hyphenateCapitalizedWords: boolean; /** * The maximum number of hyphens that can appear on consecutive lines. To * specify unlimited consecutive lines, use zero. * @remarks Range: 0 to 25 */ hyphenateLadderLimit: number; /** * If true, allows hyphenation in the last word in a paragraph. Note: Valid * only when hyphenation is true. */ hyphenateLastWord: boolean; /** * The minimum number of letters a word must have in order to qualify for * hyphenation. * @remarks Range: 3 to 25 */ hyphenateWordsLongerThan: number; /** * If true, allows hyphenation. */ hyphenation: boolean; /** * The amount of white space allowed at the end of a line of non-justified text * before hypenation begins. Note: Valid when composer is single-line composer. * @remarks Measurement unit — also accepts a string such as "12mm". */ hyphenationZone: number | string; /** * If true, ignores optical edge alignment for the paragraph. */ ignoreEdgeAlignment: boolean; /** * The index of the text in the collection or parent object. */ readonly index: number; /** * A collection of insertion points. */ readonly insertionPoints: InsertionPoints; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The number of grid squares in which to arrange the text. */ jidori: number; /** * The paragraph alignment. */ justification: Justification; /** * Use of Kashidas for justification */ kashidas: KashidasOptions; /** * If true, keeps all lines of the paragraph together. If false, allows * paragraphs to break across pages or columns. */ keepAllLinesTogether: boolean; /** * The minimum number of lines to keep together in a paragraph before allowing * a page break. * @remarks Range: 1 to 50 */ keepFirstLines: number; /** * The minimum number of lines to keep together in a paragraph after a page * break. * @remarks Range: 1 to 50 */ keepLastLines: number; /** * If true, keeps a specified number of lines together when the paragraph * breaks across columns or text frames. */ keepLinesTogether: boolean; /** * If true, forces the rule above the paragraph to remain in the frame bounds. * Note: Valid only when rule above is true. */ keepRuleAboveInFrame: boolean; /** * The minimum number of lines to keep with the next paragraph. * @remarks Range: 0 to 5 */ keepWithNext: number; /** * If the first line in the paragraph should be kept with the last line of * previous paragraph. */ keepWithPrevious: boolean; /** * The alignment of kenten characters relative to the parent characters. */ kentenAlignment: KentenAlignment; /** * The character set used for the custom kenten character. Note: Valid only * when kenten kind is custom. */ kentenCharacterSet: KentenCharacterSet; /** * The character used for kenten. Note: Valid only when kenten kind is custom. */ kentenCustomCharacter: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of * kenten characters. Can return: Swatch or String. */ kentenFillColor: Swatch | string; /** * The font to use for kenten characters. Can return: Font or String. */ kentenFont: Font | string; /** * The size (in points) of kenten characters. */ kentenFontSize: number; /** * The font style of kenten characters. Can return: String or NothingEnum * enumerator. */ kentenFontStyle: string | NothingEnum; /** * The style of kenten characters. */ kentenKind: KentenCharacter; /** * The method of overprinting the kenten fill. */ kentenOverprintFill: AdornmentOverprint; /** * The method of overprinting the kenten stroke. */ kentenOverprintStroke: AdornmentOverprint; /** * The distance between kenten characters and their parent characters. */ kentenPlacement: number; /** * The kenten position relative to the parent character. */ kentenPosition: RubyKentenPosition; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * kenten characters. Can return: Swatch or String. */ kentenStrokeColor: Swatch | string; /** * The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenStrokeTint: number; /** * The fill tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenTint: number; /** * The stroke weight (in points) of kenten characters. */ kentenWeight: number; /** * The horizontal size of kenten characters as a percent of the original size. */ kentenXScale: number; /** * The vertical size of kenten charachers as a percent of the original size. */ kentenYScale: number; /** * The type of pair kerning. */ kerningMethod: string; /** * The amount of space to add or remove between characters, specified in * thousands of an em. */ kerningValue: number; /** * The keyboard direction of the character. */ keyboardDirection: CharacterDirectionOptions; /** * The type of hanging punctuation to allow. Note: Valid only when a kinsoku * set is in effect. */ kinsokuHangType: KinsokuHangTypes; /** * The kinsoku set that determines legitimate line breaks. Can return: * KinsokuTable, KinsokuSet enumerator or String. */ kinsokuSet: KinsokuSet | KinsokuTable | string; /** * The type of kinsoku processing for preventing kinsoku characters from * beginning or ending a line. Note: Valid only when a kinsoku set is defined. */ kinsokuType: KinsokuType; /** * The amount to indent the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ lastLineIndent: number | string; /** * The leading applied to the text. Can return: Unit or Leading enumerator. */ leading: number | Leading; /** * The amount of space before each character. */ leadingAki: number; /** * The point from which leading is measured from line to line. */ leadingModel: LeadingModel; /** * The width of the left indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ leftIndent: number | string; /** * The number of objects in the collection. */ readonly length: number; /** * If true, replaces specific character combinations (e.g., fl, fi) with * ligature characters. */ ligatures: boolean; /** * A collection of lines. */ readonly lines: Lines; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * The maximum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ maximumGlyphScaling: number; /** * The maximum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ maximumLetterSpacing: number; /** * The maximum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ maximumWordSpacing: number; /** * If true, consecutive para borders with completely similar properties are * merged. */ mergeConsecutiveParaBorders: boolean; /** * The minimum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ minimumGlyphScaling: number; /** * The minimum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ minimumLetterSpacing: number; /** * The minimum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ minimumWordSpacing: number; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 0 to 1000 */ miterLimit: number; /** * The mojikumi table. For information, see mojikumi table defaults. Can * return: MojikumiTable, String or MojikumiTableDefaults enumerator. */ mojikumi: MojikumiTable | string | MojikumiTableDefaults; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * A collection of nested GREP styles. */ readonly nestedGrepStyles: NestedGrepStyles; /** * A collection of nested line styles. */ readonly nestedLineStyles: NestedLineStyles; /** * A collection of nested styles. */ readonly nestedStyles: NestedStyles; /** * If true, keeps the text on the same line. */ noBreak: boolean; /** * A collection of notes. */ readonly notes: Notes; /** * The alignment of the number. */ numberingAlignment: ListAlignment; /** * If true, apply the numbering restart policy. */ numberingApplyRestartPolicy: boolean; /** * The character style to be used for the number string. Can return: * CharacterStyle or String. */ numberingCharacterStyle: CharacterStyle | string; /** * Continue the numbering at this level. */ numberingContinue: boolean; /** * The number string expression for numbering. */ numberingExpression: string; /** * Numbering format options. Can return: NumberingStyle enumerator or String. */ numberingFormat: NumberingStyle | string; /** * The level of the paragraph. */ numberingLevel: number; /** * Numbering restart policies. */ readonly numberingRestartPolicies: NumberingRestartPolicy; /** * Determines starting number in a numbered list. */ numberingStartAt: number; /** * OpenType features. Can return: Array of Array of 2 Strings or Long Integers. */ opentypeFeatures: (string[][] | number[])[]; /** * If true, uses contextual alternate forms in OpenType fonts. */ otfContextualAlternate: boolean; /** * If true, uses discretionary ligatures in OpenType fonts. */ otfDiscretionaryLigature: boolean; /** * The figure style in OpenType fonts. */ otfFigureStyle: OTFFigureStyle; /** * If true, uses fractions in OpenType fonts. */ otfFraction: boolean; /** * If true, switches hiragana fonts, which have different glyphs for horizontal * and vertical. */ otfHVKana: boolean; /** * If true, use historical forms in OpenType fonts. */ otfHistorical: boolean; /** * If true, use alternate justification forms in OpenType fonts */ otfJustificationAlternate: boolean; /** * If true, uses localized forms in OpenType fonts. */ otfLocale: boolean; /** * If true, uses mark positioning in OpenType fonts. */ otfMark: boolean; /** * If true, uses ordinals in OpenType fonts. */ otfOrdinal: boolean; /** * If true, use overlapping swash forms in OpenType fonts */ otfOverlapSwash: boolean; /** * If true, kerns according to proportional CJK metrics in OpenType fonts. */ otfProportionalMetrics: boolean; /** * If true, applies italics to half-width alphanumerics. */ otfRomanItalics: boolean; /** * If true, use a slashed zeroes in OpenType fonts. */ otfSlashedZero: boolean; /** * If true, use stretched alternate forms in OpenType fonts */ otfStretchedAlternate: boolean; /** * If true, use stylistic alternate forms in OpenType fonts */ otfStylisticAlternate: boolean; /** * The stylistic sets to use in OpenType fonts. */ otfStylisticSets: number; /** * If true, uses swash forms in OpenType fonts. */ otfSwash: boolean; /** * If true, uses titling forms in OpenType fonts. */ otfTitling: boolean; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the fill color of the characters will overprint. */ overprintFill: boolean; /** * If true, the stroke of the characters will overprint. */ overprintStroke: boolean; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphBorderBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLeftCornerRadius: number | string; /** * The bottom line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLineWeight: number | string; /** * The distance to offset the bottom edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph border. */ paragraphBorderBottomOrigin: ParagraphBorderBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphBorderBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomRightCornerRadius: number | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * stroke. Can return: Swatch or String. */ paragraphBorderColor: Swatch | string; /** * If true, then paragraph border is also displayed at the points where the * paragraph splits across frames or columns. */ paragraphBorderDisplayIfSplits: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * border gap. Note: Valid only when the border type is not solid. Can return: * Swatch or String. */ paragraphBorderGapColor: Swatch | string; /** * If true, the paragraph border gap will overprint. Note: Valid only when * border type is not solid. */ paragraphBorderGapOverprint: boolean; /** * The tint (as a percentage) of the paragraph border gap. Note: Valid only * when the border type is not solid. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderGapTint: number; /** * The left line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftLineWeight: number | string; /** * The distance to offset the left edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftOffset: number | string; /** * If true, the paragraph border is on. */ paragraphBorderOn: boolean; /** * If true, the paragraph border will overprint. */ paragraphBorderOverprint: boolean; /** * The right line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightLineWeight: number | string; /** * The distance to offset the right edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightOffset: number | string; /** * The end shape of an open path. */ paragraphBorderStrokeEndCap: EndCap; /** * The corner join applied to the TextColumn. */ paragraphBorderStrokeEndJoin: EndJoin; /** * The tint (as a percentage) of the paragraph stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphBorderTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLeftCornerRadius: number | string; /** * The top line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLineWeight: number | string; /** * The distance to offset the top edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph border. */ paragraphBorderTopOrigin: ParagraphBorderTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphBorderTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopRightCornerRadius: number | string; /** * The type of the border for the paragraph. Can return: StrokeStyle or String. */ paragraphBorderType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph border. */ paragraphBorderWidth: ParagraphBorderEnum; /** * Paragraph direction. */ paragraphDirection: ParagraphDirectionOptions; /** * If true, the gyoudori mode applies to the entire paragraph. If false, the * gyoudori mode applies to each line in the paragraph. */ paragraphGyoudori: boolean; /** * Paragraph justification. */ paragraphJustification: ParagraphJustificationOptions; /** * Paragraph kashida width. 0 is none, 1 is short, 2 is medium, 3 is long */ paragraphKashidaWidth: number; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphShadingBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomLeftCornerRadius: number | string; /** * The distance to offset the bottom edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph shading. */ paragraphShadingBottomOrigin: ParagraphShadingBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphShadingBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomRightCornerRadius: number | string; /** * If true, forces the shading of the paragraph to be clipped with respect to * frame shape. */ paragraphShadingClipToFrame: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * shading. Can return: Swatch or String. */ paragraphShadingColor: Swatch | string; /** * The distance to offset the left edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingLeftOffset: number | string; /** * If true, the paragraph shading is On. */ paragraphShadingOn: boolean; /** * If true, the paragraph shading will overprint. */ paragraphShadingOverprint: boolean; /** * The distance to offset the right edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingRightOffset: number | string; /** * If true, suppress printing of the shading of the paragraph. */ paragraphShadingSuppressPrinting: boolean; /** * The tint (as a percentage) of the paragraph shading. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphShadingTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphShadingTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopLeftCornerRadius: number | string; /** * The distance to offset the top edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph shading. */ paragraphShadingTopOrigin: ParagraphShadingTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphShadingTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopRightCornerRadius: number | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph shading. */ paragraphShadingWidth: ParagraphShadingWidthEnum; /** * A collection of paragraphs. */ readonly paragraphs: Paragraphs; /** * The parent of the TextColumn (a XmlStory, TextPath, TextFrame, * EndnoteTextFrame, Text, InsertionPoint, TextStyleRange, Paragraph, * TextColumn, Line, Word, Character, Story, Cell, XMLElement, Endnote, * Footnote, Note, Change or HiddenText). */ readonly parent: Cell | Change | Character | Endnote | EndnoteTextFrame | Footnote | InsertionPoint | Line | Note | Paragraph | Story | Text | TextColumn | TextFrame | TextPath | TextStyleRange | Word | XMLElement | HiddenText | XmlStory; /** * The story that contains the text. */ readonly parentStory: Story; /** * An array of the text frames that contain the text. Can return: Array of * TextFrames or TextPaths. */ readonly parentTextFrames: (TextFrames | TextPaths)[]; /** * The text size. * @remarks Measurement unit — also accepts a string such as "12mm". */ pointSize: number | string; /** * A collection of polygons. */ readonly polygons: Polygons; /** * The text position relative to the baseline. */ position: Position; /** * The OpenType positional form. */ positionalForm: PositionalForms; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The hyphenation style chosen for the provider. */ providerHyphenationStyle: HyphenationStyleEnum; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * If true, disallows line breaks in numbers. If false, lines can break between * digits in multi-digit numbers. */ rensuuji: boolean; /** * The width of the right indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ rightIndent: number | string; /** * If true, rotates Roman characters in vertical text. */ rotateSingleByteCharacters: boolean; /** * The ruby alignment. */ rubyAlignment: RubyAlignments; /** * If true, auto aligns ruby. */ rubyAutoAlign: boolean; /** * If true, automatically scales ruby to the specified percent of parent text * size. For information on specifying a percent, see ruby parent scaling * percent. */ rubyAutoScaling: boolean; /** * If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to * fit one em. */ rubyAutoTcyAutoScale: boolean; /** * The number of digits included in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyDigits: number; /** * If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyIncludeRoman: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby * characters. Can return: Swatch or String. */ rubyFill: Swatch | string; /** * If true, ruby is on. */ rubyFlag: boolean; /** * The font applied to ruby characters. Can return: Font or String. */ rubyFont: Font | string; /** * The size (in points) of ruby characters. */ rubyFontSize: number; /** * The font style of ruby characters. Can return: String or NothingEnum * enumerator. */ rubyFontStyle: string | NothingEnum; /** * If true, uses OpenType Pro fonts for ruby. */ rubyOpenTypePro: boolean; /** * If true, constrains ruby overhang to the specified amount. For information * on specifying an amount, see ruby parent overhang amount. */ rubyOverhang: boolean; /** * The method of overprinting the ruby fill. */ rubyOverprintFill: AdornmentOverprint; /** * The method of overprinting the ruby stroke. */ rubyOverprintStroke: AdornmentOverprint; /** * The amount by which ruby characters can overhang the parent text. */ rubyParentOverhangAmount: RubyOverhang; /** * The amount (as a percentage) to scale the parent text size to determine the * ruby text size. */ rubyParentScalingPercent: number; /** * The ruby spacing relative to the parent text. */ rubyParentSpacing: RubyParentSpacing; /** * The position of ruby characters relative to the parent text. */ rubyPosition: RubyKentenPosition; /** * The ruby string contents. */ rubyString: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * ruby characters. Can return: Swatch or String. */ rubyStroke: Swatch | string; /** * The stroke tint (as a percentage) of ruby characters. */ rubyStrokeTint: number; /** * The tint (as a percentage) of the ruby fill color. (Range: 0 to 100) * @remarks Range: 0 to 100 */ rubyTint: number; /** * The ruby type. */ rubyType: RubyTypes; /** * The stroke weight (in points) of ruby characters. */ rubyWeight: number; /** * The amount of horizontal space between ruby and parent characters. */ rubyXOffset: number; /** * The horizontal size of ruby characters, specified as a percent of the * original size. */ rubyXScale: number; /** * The amount of vertical space between ruby and parent characters. */ rubyYOffset: number; /** * The vertical size of ruby characters, specified as a percent of the original * size. */ rubyYScale: number; /** * If true, places a rule above the paragraph. */ ruleAbove: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule above. Can return: Swatch or String. */ ruleAboveColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule above. Note: Valid only when the paragraph rule above * type is not solid. Can return: Swatch or String. */ ruleAboveGapColor: Swatch | string; /** * If true, the stroke gap of the paragraph rule above will overprint. Note: * Valid only the rule above type is not solid. */ ruleAboveGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule. * (Range: 0 to 100) Note: Valid only when the rule above type is not solid. * @remarks Range: 0 to 100 */ ruleAboveGapTint: number; /** * The distance to indent the left edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLeftIndent: number | string; /** * The line weight of the rule above. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLineWeight: number | string; /** * The amount to offset the paragraph rule above from the baseline of the first * line the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveOffset: number | string; /** * If true, the paragraph rule above will overprint. */ ruleAboveOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleAboveTint: number; /** * The stroke type of the rule above the paragraph. Can return: StrokeStyle or * String. */ ruleAboveType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule above. */ ruleAboveWidth: RuleWidth; /** * If true, applies a paragraph rule below. */ ruleBelow: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule below. Can return: Swatch or String. */ ruleBelowColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule below. Note: Valid only when the paragraph rule below * type is not solid. Can return: Swatch or String. */ ruleBelowGapColor: Swatch | string; /** * If true, the gap color of the rule below will overprint. */ ruleBelowGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule * below. (Range: 0 to 100) Note: Valid only when the paragraph rule below type * is not solid. * @remarks Range: 0 to 100 */ ruleBelowGapTint: number; /** * The distance to indent the left edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLeftIndent: number | string; /** * The line weight of the rule below. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLineWeight: number | string; /** * The amount to offset the the paragraph rule below from the baseline of the * last line of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowOffset: number | string; /** * If true, the rule below will overprint. */ ruleBelowOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleBelowTint: number; /** * The stroke type of the rule below the paragraph. Can return: StrokeStyle or * String. */ ruleBelowType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule below. */ ruleBelowWidth: RuleWidth; /** * The space between paragraphs using same style. Can return: Unit or Spacing * enumerator. */ sameParaStyleSpacing: number | Spacing; /** * If true, the line changes size when characters are scaled. */ scaleAffectsLineHeight: boolean; /** * If true, applies shatai rotation. */ shataiAdjustRotation: boolean; /** * If true, adjusts shatai tsume. */ shataiAdjustTsume: boolean; /** * The shatai lens angle (in degrees). */ shataiDegreeAngle: number; /** * The amount (as a percentage) of shatai obliquing to apply. */ shataiMagnification: number; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * The alignment to use for lines that contain a single word. */ singleWordJustification: SingleWordJustification; /** * The skew angle of the TextColumn. */ skew: number; /** * The height of the paragraph space below. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceAfter: number | string; /** * The height of the paragraph space above. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceBefore: number | string; /** * The minimum space after a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceAfter: number | string; /** * The minimum space before a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceBefore: number | string; /** * Whether a paragraph should be a single column, span columns or split columns */ spanColumnType: SpanColumnTypeOptions; /** * The number of columns a paragraph spans or the number of split columns. Can * return: Short Integer (1 - 40) or SpanColumnCountOptions enumerator. */ spanSplitColumnCount: number | SpanColumnCountOptions; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The inside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnInsideGutter: number | string; /** * The outside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnOutsideGutter: number | string; /** * The location at which to start the paragraph. */ startParagraph: StartParagraph; /** * The swatch (color, gradient, tint, or mixed ink) applied to the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughGapColor: Swatch | string; /** * If true, the gap color of the strikethrough stroke will overprint. Note: * Valid when strike through type is not solid. */ strikeThroughGapOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 * to 100) Note: Valid when strike through type is not solid. * @remarks Range: 0 to 100 */ strikeThroughGapTint: number; /** * The amount by which to offset the strikethrough stroke from the text * baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughOffset: number | string; /** * If true, the strikethrough stroke will overprint. */ strikeThroughOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ strikeThroughTint: number; /** * The stroke type of the strikethrough stroke. Can return: StrokeStyle or * String. */ strikeThroughType: StrokeStyle | string; /** * The stroke weight of the strikethrough stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughWeight: number | string; /** * If true, draws a strikethrough line through the text. */ strikeThru: boolean; /** * The stroke alignment applied to the text. */ strokeAlignment: TextStrokeAlign; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the TextColumn. Can also accept: String. */ strokeColor: Swatch | string; /** * The tint (as a percentage) of the stroke color of the TextColumn. (To * specify a tint percentage, use a number in the range of 0 to 100; to use the * inherited or overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * The stroke weight applied to the characters of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * If true, the applied style has been overridden with additional attributes. */ readonly styleOverridden: boolean; /** * A list of the tab stops in the paragraph. Can return: Array of Arrays of * Property Name/Value Pairs. */ tabList: any[][][]; /** * A collection of tab stops. */ readonly tabStops: TabStops; /** * A collection of tables. */ readonly tables: Tables; /** * If true, makes the character horizontal in vertical text. */ tatechuyoko: boolean; /** * The horizontal offset for horizontal characters in vertical text. */ tatechuyokoXOffset: number; /** * The vertical offset for horizontal characters in vertical text. */ tatechuyokoYOffset: number; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text columns. */ readonly textColumns: TextColumns; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * A collection of text style ranges. */ readonly textStyleRanges: TextStyleRanges; /** * A collection of text variable instances. */ readonly textVariableInstances: TextVariableInstances; /** * A collection of text objects. */ readonly texts: Texts; /** * The amount by which to loosen or tighten a block of text, specified in * thousands of an em. */ tracking: number; /** * The amount of space after each character. */ trailingAki: number; /** * If true, ideographic spaces will not wrap to the next line like text * characters. */ treatIdeographicSpaceAsSpace: boolean; /** * The amount of horizontal character compression. */ tsume: number; /** * If true, underlines the text. */ underline: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the underline * stroke. . Can return: Swatch or String. */ underlineColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * underline stroke. Note: Valid when underline type is not solid. Can return: * Swatch or String. */ underlineGapColor: Swatch | string; /** * If true, the gap color of the underline stroke will overprint. */ underlineGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of the underline stroke. (Range: * 0 to 100) Note: Valid when underline type is not solid. * @remarks Range: 0 to 100 */ underlineGapTint: number; /** * The amount by which to offset the underline from the text baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineOffset: number | string; /** * If true, the underline stroke color will overprint. */ underlineOverprint: boolean; /** * The underline stroke tint (as a percentage). (Range: 0 to 100) * @remarks Range: 0 to 100 */ underlineTint: number; /** * The stroke type of the underline stroke. Can return: StrokeStyle or String. */ underlineType: StrokeStyle | string; /** * The stroke weight of the underline stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineWeight: number | string; /** * The vertical scaling applied to the TextColumn. */ verticalScale: number; /** * If true, turns on warichu. */ warichu: boolean; /** * The warichu alignment. */ warichuAlignment: WarichuAlignment; /** * The minimum number of characters allowed after a line break. */ warichuCharsAfterBreak: number; /** * The minimum number of characters allowed before a line break. */ warichuCharsBeforeBreak: number; /** * The gap between lines of warichu characters. */ warichuLineSpacing: number; /** * The number of lines of warichu within a single normal line. */ warichuLines: number; /** * The amount (as a percentage) to scale parent text size to determine warichu * size. */ warichuSize: number; /** * A collection of words. */ readonly words: Words; /** * The x (horizontal) offset for diacritic adjustment. */ xOffsetDiacritic: number; /** * The y (vertical) offset for diacritic adjustment. */ yOffsetDiacritic: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Apply a character style. * @param using The character style to apply. */ applyCharacterStyle(using: CharacterStyle): void; /** * Apply one or more conditions. * @param using The condition(s) to apply * @param removeExisting If true, remove existing conditions. (Optional) */ applyConditions(using: Condition[], removeExisting?: boolean): void; /** * Apply a paragraph style. * @param using The paragraph style to apply. * @param clearingOverrides If true, clear any text attributes before applying the style. (Optional) */ applyParagraphStyle(using: ParagraphStyle, clearingOverrides?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds glyphs that match the find what value and replaces the glyphs with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value and replaces the text * with the change character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeTransliterate(reverseOrder?: boolean): Text[]; /** * Sets the case of the text. * @param using The text case option. */ changecase(using: ChangecaseMode): void; /** * Clears the specified types of override. * @param overridesToClear The types of override to clear. (Optional) */ clearOverrides(overridesToClear?: OverrideType): void; /** * Convert bullets and numbering to text. */ convertBulletsAndNumberingToText(): void; /** * Converts the text to a note. */ convertToNote(): Note; /** * Converts the text to a table. * @param columnSeparator The character that starts a new column in the new table. (Optional) * @param rowSeparator The character starts a new row in the new table. (Optional) * @param numberOfColumns The number of columns in the table. Note: Valid only when the column and row separator characters are the same. (Optional) */ convertToTable(columnSeparator?: string, rowSeparator?: string, numberOfColumns?: number): Table; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new TextColumn. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new TextColumn. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Converts text to outlines. Each line of text becomes a polygon object. When * the converted text is a single letter that has no internal spaces or * detached parts, the polygon contains only a single path. Note: To determine * whether a font allows the creation of outlines, see allow outlines. * @param deleteOriginal If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) */ createOutlines(deleteOriginal?: boolean): PageItem[]; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new TextColumn. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create thumbnail for selected text using the applied style and overrides * with the given properties. * @param previewText Text to use as sample * @param pointSize Text font size (in points) * @param space Color space RGB, CMYK or LAB * @param colorValue Color values * @param to The path to the export file. * @param charOrParaStyle The applied style type to use. */ createStyleThumbnailWithProperties(previewText: string, pointSize: number, space: ColorSpace, colorValue: number[], to: File, charOrParaStyle: StyleType): boolean; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new TextColumn. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create thumbnail for selected text with the given properties. * @param previewText Text to use as sample * @param pointSize Text font size (in points) * @param space Color space RGB, CMYK or LAB * @param colorValue Color values * @param to The path to the export file. */ createThumbnailWithProperties(previewText: string, pointSize: number, space: ColorSpace, colorValue: number[], to: File): boolean; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new TextColumn. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Duplicates the text in the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional) */ duplicate(to: LocationOptions, reference?: Cell | Column | Row | Story | Table | Text | PageItem): Text; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Finds glyphs that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGrep(reverseOrder?: boolean): Text[]; /** * Finds hyperlink sources that intersecting with specified text range. * @param sortOrder The sort order of found ranges. (Optional) */ findHyperlinks(sortOrder?: RangeSortOrder): HyperlinkTextSource[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findTransliterate(reverseOrder?: boolean): Text[]; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TextColumn[]; /** * If true, Nth design axis of variable font is hidden. * @param nthAxisIndex Index of design axis. */ isNthDesignAxisHidden(nthAxisIndex: number): boolean; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the text to the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional) */ move(to: LocationOptions, reference?: Cell | Column | Row | Story | Table | Text | PageItem): Text; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Recomposes the text in the TextColumn. */ recompose(): void; /** * Deletes the TextColumn. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Selects the object. * @param existingSelection The selection status of the TextColumn in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Set Nth design axis of a variable font. * @param nthAxisIndex Index of design axis. * @param nthAxisValue Value of nth design axis. */ setNthDesignAxis(nthAxisIndex: number, nthAxisValue: number): void; /** * Jump to the text range. */ showText(): void; /** * If true, text has local overrides * @param charOrParaStyle Style type to look at. * @param charStyleAsOverride Whether to consider character styles as overrides or not (Optional) */ textHasOverrides(charOrParaStyle: StyleType, charStyleAsOverride?: boolean): boolean; /** * Generates a string which, if executed, will return the TextColumn. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of text columns. */ declare class TextColumns { /** Returns the TextColumn with the specified index or name. */ [index: number]: TextColumn; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any TextColumn in the collection. */ anyItem(): TextColumn; /** * Displays the number of elements in the TextColumn. */ count(): number; /** * Returns every TextColumn in the collection. */ everyItem(): TextColumn; /** * Returns the first TextColumn in the collection. */ firstItem(): TextColumn; /** * Returns the TextColumn with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): TextColumn; /** * Returns the TextColumns within the specified range. * @param from The TextColumn, index, or name at the beginning of the range. Can accept: TextColumn, Long Integer or String. * @param to The TextColumn, index, or name at the end of the range. Can accept: TextColumn, Long Integer or String. */ itemByRange(from: number | TextColumn | string, to: number | TextColumn | string): TextColumn[]; /** * Returns the last TextColumn in the collection. */ lastItem(): TextColumn; /** * Returns the middle TextColumn in the collection. */ middleItem(): TextColumn; /** * Returns the TextColumn whose index follows the specified TextColumn in the * collection. * @param obj The TextColumn whose index comes before the desired TextColumn. */ nextItem(obj: TextColumn): TextColumn; /** * Returns the TextColumn with the index previous to the specified index. * @param obj The index of the TextColumn that follows the desired TextColumn. */ previousItem(obj: TextColumn): TextColumn; /** * Generates a string which, if executed, will return the TextColumn. */ toSource(): string; } /** * Text defaults. */ declare class TextDefault extends Preference { /** * If true, aligns the baseline of the text to the baseline grid. */ alignToBaseline: boolean; /** * If true, words unassociated with a hyphenation dictionary can break to the * next line on any character. */ allowArbitraryHyphenation: boolean; /** * The character style applied to the text. Can also accept: String. */ appliedCharacterStyle: CharacterStyle | string; /** * The font applied to the TextDefault, specified as either a font object or * the name of font family. Can return: Font or String. */ appliedFont: Font | string; /** * The language of the text. Can return: LanguageWithVendors or Language. Can * also accept: String. */ appliedLanguage: LanguageWithVendors | string | Language; /** * The named grid in use. */ appliedNamedGrid: NamedGrid; /** * The list to be part of. Can return: NumberingList or String. */ appliedNumberingList: NumberingList | string; /** * The paragraph style applied to the text. Can also accept: String. */ appliedParagraphStyle: ParagraphStyle | string; /** * The percent of the type size to use for auto leading. (Range: 0 to 500). * @remarks Range: 0 to 500 */ autoLeading: number; /** * The number of half-width characters at or below which the characters * automatically run horizontally in vertical text. */ autoTcy: number; /** * If true, auto tcy includes Roman characters. */ autoTcyIncludeRoman: boolean; /** * If true or set to an enumeration value, balances ragged lines. Note: Not * valid with a single-line text composer. Can return: Boolean or * BalanceLinesStyle enumerator. */ balanceRaggedLines: boolean | BalanceLinesStyle; /** * The baseline shift applied to the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ baselineShift: number | string; /** * Bullet character. */ readonly bulletChar: Bullet; /** * The alignment of the bullet character. */ bulletsAlignment: ListAlignment; /** * List type for bullets and numbering. */ bulletsAndNumberingListType: ListType; /** * The character style to be used for the text after string. Can return: * CharacterStyle or String. */ bulletsCharacterStyle: CharacterStyle | string; /** * The text after string expression for bullets. */ bulletsTextAfter: string; /** * If true, adds the double period (..), ellipse (...), and double hyphen (--) * to the selected kinsoku set. Note: Valid only when a kinsoku set is in * effect. */ bunriKinshi: boolean; /** * The capitalization scheme. */ capitalization: Capitalization; /** * The alignment of small characters to the largest character in the line. */ characterAlignment: CharacterAlignment; /** * The direction of the character. */ characterDirection: CharacterDirectionOptions; /** * The rotation angle (in degrees) of individual characters. Note: The rotation * is counterclockwise. */ characterRotation: number; /** * If true, uses grid tracking to track non-Roman characters in CJK grids. */ cjkGridTracking: boolean; /** * The text composer to use to compose the text. */ composer: string; /** * Value of Design Axes */ designAxes: number[]; /** * The desired width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ desiredGlyphScaling: number; /** * The desired letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) */ desiredLetterSpacing: number; /** * The desired word spacing, specified as a percentage of the font word space * value. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ desiredWordSpacing: number; /** * Position of diacriticical characters. */ diacriticPosition: DiacriticPositionOptions; /** * The digits type. */ digitsType: DigitsTypeOptions; /** * The number of characters to drop cap. * @remarks Range: 0 to 150 */ dropCapCharacters: number; /** * The number of lines to drop cap. * @remarks Range: 0 to 25 */ dropCapLines: number; /** * The character style to apply to the drop cap. Can also accept: String. */ dropCapStyle: CharacterStyle | string; /** * Details about the drop cap based on the glyph outlines. 1 = left side * bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid. */ dropcapDetail: number; /** * The stroke join type applied to the characters of the text. */ endJoin: OutlineJoin; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * TextDefault. . Can also accept: String. */ fillColor: Swatch | string; /** * The tint (as a percentage) of the fill color of the TextDefault. (To specify * a tint percentage, use a number in the range of 0 to 100; to use the * inherited or overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * The amount to indent the first line. * @remarks Measurement unit — also accepts a string such as "12mm". */ firstLineIndent: number | string; /** * The name of the font style. */ fontStyle: string; /** * The glyph variant to substitute for standard glyphs. */ glyphForm: AlternateGlyphForms; /** * The angle of a linear gradient applied to the fill of the text. (Range: -180 * to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the text. */ gradientFillLength: number; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the text. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the text. */ gradientStrokeLength: number; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * If true, aligns only the first line to the frame grid or baseline grid. If * false, aligns all lines to the grid. */ gridAlignFirstLineOnly: boolean; /** * The alignment to the frame grid or baseline grid. */ gridAlignment: GridAlignment; /** * The manual gyoudori setting. */ gridGyoudori: number; /** * The horizontal scaling applied to the TextDefault. */ horizontalScale: number; /** * The relative desirability of better spacing vs. fewer hyphens. A lower value * results in greater use of hyphens. (Range: 0 to 100) * @remarks Range: 0 to 10 */ hyphenWeight: number; /** * If true, allows the last word in a text column to be hyphenated. */ hyphenateAcrossColumns: boolean; /** * The mininum number of letters at the beginning of a word that can be broken * by a hyphen. * @remarks Range: 1 to 15 */ hyphenateAfterFirst: number; /** * The minimum number of letters at the end of a word that can be broken by a * hyphen. * @remarks Range: 1 to 15 */ hyphenateBeforeLast: number; /** * If true, allows hyphenation of capitalized words. */ hyphenateCapitalizedWords: boolean; /** * The maximum number of hyphens that can appear on consecutive lines. To * specify unlimited consecutive lines, use zero. * @remarks Range: 0 to 25 */ hyphenateLadderLimit: number; /** * If true, allows hyphenation in the last word in a paragraph. Note: Valid * only when hyphenation is true. */ hyphenateLastWord: boolean; /** * The minimum number of letters a word must have in order to qualify for * hyphenation. * @remarks Range: 3 to 25 */ hyphenateWordsLongerThan: number; /** * If true, allows hyphenation. */ hyphenation: boolean; /** * The amount of white space allowed at the end of a line of non-justified text * before hypenation begins. Note: Valid when composer is single-line composer. * @remarks Measurement unit — also accepts a string such as "12mm". */ hyphenationZone: number | string; /** * If true, ignores optical edge alignment for the paragraph. */ ignoreEdgeAlignment: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The number of grid squares in which to arrange the text. */ jidori: number; /** * The paragraph alignment. */ justification: Justification; /** * Use of Kashidas for justification */ kashidas: KashidasOptions; /** * If true, keeps all lines of the paragraph together. If false, allows * paragraphs to break across pages or columns. */ keepAllLinesTogether: boolean; /** * The minimum number of lines to keep together in a paragraph before allowing * a page break. * @remarks Range: 1 to 50 */ keepFirstLines: number; /** * The minimum number of lines to keep together in a paragraph after a page * break. * @remarks Range: 1 to 50 */ keepLastLines: number; /** * If true, keeps a specified number of lines together when the paragraph * breaks across columns or text frames. */ keepLinesTogether: boolean; /** * If true, forces the rule above the paragraph to remain in the frame bounds. * Note: Valid only when rule above is true. */ keepRuleAboveInFrame: boolean; /** * The minimum number of lines to keep with the next paragraph. * @remarks Range: 0 to 5 */ keepWithNext: number; /** * If the first line in the paragraph should be kept with the last line of * previous paragraph. */ keepWithPrevious: boolean; /** * The alignment of kenten characters relative to the parent characters. */ kentenAlignment: KentenAlignment; /** * The character set used for the custom kenten character. Note: Valid only * when kenten kind is custom. */ kentenCharacterSet: KentenCharacterSet; /** * The character used for kenten. Note: Valid only when kenten kind is custom. */ kentenCustomCharacter: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of * kenten characters. Can return: Swatch or String. */ kentenFillColor: Swatch | string; /** * The font to use for kenten characters. Can return: Font or String. */ kentenFont: Font | string; /** * The size (in points) of kenten characters. */ kentenFontSize: number; /** * The font style of kenten characters. Can return: String or NothingEnum * enumerator. */ kentenFontStyle: string | NothingEnum; /** * The style of kenten characters. */ kentenKind: KentenCharacter; /** * The method of overprinting the kenten fill. */ kentenOverprintFill: AdornmentOverprint; /** * The method of overprinting the kenten stroke. */ kentenOverprintStroke: AdornmentOverprint; /** * The distance between kenten characters and their parent characters. */ kentenPlacement: number; /** * The kenten position relative to the parent character. */ kentenPosition: RubyKentenPosition; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * kenten characters. Can return: Swatch or String. */ kentenStrokeColor: Swatch | string; /** * The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenStrokeTint: number; /** * The fill tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenTint: number; /** * The stroke weight (in points) of kenten characters. */ kentenWeight: number; /** * The horizontal size of kenten characters as a percent of the original size. */ kentenXScale: number; /** * The vertical size of kenten charachers as a percent of the original size. */ kentenYScale: number; /** * The type of pair kerning. */ kerningMethod: string; /** * The keyboard direction of the character. */ keyboardDirection: CharacterDirectionOptions; /** * The type of hanging punctuation to allow. Note: Valid only when a kinsoku * set is in effect. */ kinsokuHangType: KinsokuHangTypes; /** * The kinsoku set that determines legitimate line breaks. Can return: * KinsokuTable, KinsokuSet enumerator or String. */ kinsokuSet: KinsokuSet | KinsokuTable | string; /** * The type of kinsoku processing for preventing kinsoku characters from * beginning or ending a line. Note: Valid only when a kinsoku set is defined. */ kinsokuType: KinsokuType; /** * The amount to indent the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ lastLineIndent: number | string; /** * The leading applied to the text. Can return: Unit or Leading enumerator. */ leading: number | Leading; /** * The amount of space before each character. */ leadingAki: number; /** * The point from which leading is measured from line to line. */ leadingModel: LeadingModel; /** * The width of the left indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ leftIndent: number | string; /** * If true, replaces specific character combinations (e.g., fl, fi) with * ligature characters. */ ligatures: boolean; /** * The maximum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ maximumGlyphScaling: number; /** * The maximum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ maximumLetterSpacing: number; /** * The maximum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ maximumWordSpacing: number; /** * If true, consecutive para borders with completely similar properties are * merged. */ mergeConsecutiveParaBorders: boolean; /** * The minimum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ minimumGlyphScaling: number; /** * The minimum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ minimumLetterSpacing: number; /** * The minimum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ minimumWordSpacing: number; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 0 to 1000 */ miterLimit: number; /** * The mojikumi table. For information, see mojikumi table defaults. Can * return: MojikumiTable, String or MojikumiTableDefaults enumerator. */ mojikumi: MojikumiTable | string | MojikumiTableDefaults; /** * A collection of nested GREP styles. */ readonly nestedGrepStyles: NestedGrepStyles; /** * A collection of nested line styles. */ readonly nestedLineStyles: NestedLineStyles; /** * A collection of nested styles. */ readonly nestedStyles: NestedStyles; /** * If true, keeps the text on the same line. */ noBreak: boolean; /** * The alignment of the number. */ numberingAlignment: ListAlignment; /** * If true, apply the numbering restart policy. */ numberingApplyRestartPolicy: boolean; /** * The character style to be used for the number string. Can return: * CharacterStyle or String. */ numberingCharacterStyle: CharacterStyle | string; /** * Continue the numbering at this level. */ numberingContinue: boolean; /** * The number string expression for numbering. */ numberingExpression: string; /** * Numbering format options. Can return: NumberingStyle enumerator or String. */ numberingFormat: NumberingStyle | string; /** * The level of the paragraph. */ numberingLevel: number; /** * Numbering restart policies. */ readonly numberingRestartPolicies: NumberingRestartPolicy; /** * Determines starting number in a numbered list. */ numberingStartAt: number; /** * If true, uses contextual alternate forms in OpenType fonts. */ otfContextualAlternate: boolean; /** * If true, uses discretionary ligatures in OpenType fonts. */ otfDiscretionaryLigature: boolean; /** * The figure style in OpenType fonts. */ otfFigureStyle: OTFFigureStyle; /** * If true, uses fractions in OpenType fonts. */ otfFraction: boolean; /** * If true, switches hiragana fonts, which have different glyphs for horizontal * and vertical. */ otfHVKana: boolean; /** * If true, use historical forms in OpenType fonts. */ otfHistorical: boolean; /** * If true, use alternate justification forms in OpenType fonts */ otfJustificationAlternate: boolean; /** * If true, uses localized forms in OpenType fonts. */ otfLocale: boolean; /** * If true, uses mark positioning in OpenType fonts. */ otfMark: boolean; /** * If true, uses ordinals in OpenType fonts. */ otfOrdinal: boolean; /** * If true, use overlapping swash forms in OpenType fonts */ otfOverlapSwash: boolean; /** * If true, kerns according to proportional CJK metrics in OpenType fonts. */ otfProportionalMetrics: boolean; /** * If true, applies italics to half-width alphanumerics. */ otfRomanItalics: boolean; /** * If true, use a slashed zeroes in OpenType fonts. */ otfSlashedZero: boolean; /** * If true, use stretched alternate forms in OpenType fonts */ otfStretchedAlternate: boolean; /** * If true, use stylistic alternate forms in OpenType fonts */ otfStylisticAlternate: boolean; /** * The stylistic sets to use in OpenType fonts. */ otfStylisticSets: number; /** * If true, uses swash forms in OpenType fonts. */ otfSwash: boolean; /** * If true, uses titling forms in OpenType fonts. */ otfTitling: boolean; /** * If true, the fill color of the characters will overprint. */ overprintFill: boolean; /** * If true, the stroke of the characters will overprint. */ overprintStroke: boolean; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphBorderBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLeftCornerRadius: number | string; /** * The bottom line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLineWeight: number | string; /** * The distance to offset the bottom edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph border. */ paragraphBorderBottomOrigin: ParagraphBorderBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphBorderBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomRightCornerRadius: number | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * stroke. Can return: Swatch or String. */ paragraphBorderColor: Swatch | string; /** * If true, then paragraph border is also displayed at the points where the * paragraph splits across frames or columns. */ paragraphBorderDisplayIfSplits: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * border gap. Note: Valid only when the border type is not solid. Can return: * Swatch or String. */ paragraphBorderGapColor: Swatch | string; /** * If true, the paragraph border gap will overprint. Note: Valid only when * border type is not solid. */ paragraphBorderGapOverprint: boolean; /** * The tint (as a percentage) of the paragraph border gap. Note: Valid only * when the border type is not solid. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderGapTint: number; /** * The left line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftLineWeight: number | string; /** * The distance to offset the left edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftOffset: number | string; /** * If true, the paragraph border is on. */ paragraphBorderOn: boolean; /** * If true, the paragraph border will overprint. */ paragraphBorderOverprint: boolean; /** * The right line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightLineWeight: number | string; /** * The distance to offset the right edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightOffset: number | string; /** * The end shape of an open path. */ paragraphBorderStrokeEndCap: EndCap; /** * The corner join applied to the TextDefault. */ paragraphBorderStrokeEndJoin: EndJoin; /** * The tint (as a percentage) of the paragraph stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphBorderTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLeftCornerRadius: number | string; /** * The top line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLineWeight: number | string; /** * The distance to offset the top edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph border. */ paragraphBorderTopOrigin: ParagraphBorderTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphBorderTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopRightCornerRadius: number | string; /** * The type of the border for the paragraph. Can return: StrokeStyle or String. */ paragraphBorderType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph border. */ paragraphBorderWidth: ParagraphBorderEnum; /** * Paragraph direction. */ paragraphDirection: ParagraphDirectionOptions; /** * If true, the gyoudori mode applies to the entire paragraph. If false, the * gyoudori mode applies to each line in the paragraph. */ paragraphGyoudori: boolean; /** * Paragraph justification. */ paragraphJustification: ParagraphJustificationOptions; /** * Paragraph kashida width. 0 is none, 1 is short, 2 is medium, 3 is long */ paragraphKashidaWidth: number; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphShadingBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomLeftCornerRadius: number | string; /** * The distance to offset the bottom edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph shading. */ paragraphShadingBottomOrigin: ParagraphShadingBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphShadingBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomRightCornerRadius: number | string; /** * If true, forces the shading of the paragraph to be clipped with respect to * frame shape. */ paragraphShadingClipToFrame: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * shading. Can return: Swatch or String. */ paragraphShadingColor: Swatch | string; /** * The distance to offset the left edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingLeftOffset: number | string; /** * If true, the paragraph shading is On. */ paragraphShadingOn: boolean; /** * If true, the paragraph shading will overprint. */ paragraphShadingOverprint: boolean; /** * The distance to offset the right edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingRightOffset: number | string; /** * If true, suppress printing of the shading of the paragraph. */ paragraphShadingSuppressPrinting: boolean; /** * The tint (as a percentage) of the paragraph shading. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphShadingTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphShadingTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopLeftCornerRadius: number | string; /** * The distance to offset the top edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph shading. */ paragraphShadingTopOrigin: ParagraphShadingTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphShadingTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopRightCornerRadius: number | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph shading. */ paragraphShadingWidth: ParagraphShadingWidthEnum; /** * The parent of the TextDefault (a Application or Document). */ readonly parent: Application | Document; /** * The text size. * @remarks Measurement unit — also accepts a string such as "12mm". */ pointSize: number | string; /** * The text position relative to the baseline. */ position: Position; /** * The OpenType positional form. */ positionalForm: PositionalForms; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The hyphenation style chosen for the provider. */ providerHyphenationStyle: HyphenationStyleEnum; /** * If true, disallows line breaks in numbers. If false, lines can break between * digits in multi-digit numbers. */ rensuuji: boolean; /** * The width of the right indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ rightIndent: number | string; /** * If true, rotates Roman characters in vertical text. */ rotateSingleByteCharacters: boolean; /** * The ruby alignment. */ rubyAlignment: RubyAlignments; /** * If true, auto aligns ruby. */ rubyAutoAlign: boolean; /** * If true, automatically scales ruby to the specified percent of parent text * size. For information on specifying a percent, see ruby parent scaling * percent. */ rubyAutoScaling: boolean; /** * If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to * fit one em. */ rubyAutoTcyAutoScale: boolean; /** * The number of digits included in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyDigits: number; /** * If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyIncludeRoman: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby * characters. Can return: Swatch or String. */ rubyFill: Swatch | string; /** * The font applied to ruby characters. Can return: Font or String. */ rubyFont: Font | string; /** * The size (in points) of ruby characters. */ rubyFontSize: number; /** * The font style of ruby characters. Can return: String or NothingEnum * enumerator. */ rubyFontStyle: string | NothingEnum; /** * If true, uses OpenType Pro fonts for ruby. */ rubyOpenTypePro: boolean; /** * If true, constrains ruby overhang to the specified amount. For information * on specifying an amount, see ruby parent overhang amount. */ rubyOverhang: boolean; /** * The method of overprinting the ruby fill. */ rubyOverprintFill: AdornmentOverprint; /** * The method of overprinting the ruby stroke. */ rubyOverprintStroke: AdornmentOverprint; /** * The amount by which ruby characters can overhang the parent text. */ rubyParentOverhangAmount: RubyOverhang; /** * The amount (as a percentage) to scale the parent text size to determine the * ruby text size. */ rubyParentScalingPercent: number; /** * The ruby spacing relative to the parent text. */ rubyParentSpacing: RubyParentSpacing; /** * The position of ruby characters relative to the parent text. */ rubyPosition: RubyKentenPosition; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * ruby characters. Can return: Swatch or String. */ rubyStroke: Swatch | string; /** * The stroke tint (as a percentage) of ruby characters. */ rubyStrokeTint: number; /** * The tint (as a percentage) of the ruby fill color. (Range: 0 to 100) * @remarks Range: 0 to 100 */ rubyTint: number; /** * The ruby type. */ rubyType: RubyTypes; /** * The stroke weight (in points) of ruby characters. */ rubyWeight: number; /** * The amount of horizontal space between ruby and parent characters. */ rubyXOffset: number; /** * The horizontal size of ruby characters, specified as a percent of the * original size. */ rubyXScale: number; /** * The amount of vertical space between ruby and parent characters. */ rubyYOffset: number; /** * The vertical size of ruby characters, specified as a percent of the original * size. */ rubyYScale: number; /** * If true, places a rule above the paragraph. */ ruleAbove: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule above. Can return: Swatch or String. */ ruleAboveColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule above. Note: Valid only when the paragraph rule above * type is not solid. Can return: Swatch or String. */ ruleAboveGapColor: Swatch | string; /** * If true, the stroke gap of the paragraph rule above will overprint. Note: * Valid only the rule above type is not solid. */ ruleAboveGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule. * (Range: 0 to 100) Note: Valid only when the rule above type is not solid. * @remarks Range: 0 to 100 */ ruleAboveGapTint: number; /** * The distance to indent the left edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLeftIndent: number | string; /** * The line weight of the rule above. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLineWeight: number | string; /** * The amount to offset the paragraph rule above from the baseline of the first * line the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveOffset: number | string; /** * If true, the paragraph rule above will overprint. */ ruleAboveOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleAboveTint: number; /** * The stroke type of the rule above the paragraph. Can return: StrokeStyle or * String. */ ruleAboveType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule above. */ ruleAboveWidth: RuleWidth; /** * If true, applies a paragraph rule below. */ ruleBelow: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule below. Can return: Swatch or String. */ ruleBelowColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule below. Note: Valid only when the paragraph rule below * type is not solid. Can return: Swatch or String. */ ruleBelowGapColor: Swatch | string; /** * If true, the gap color of the rule below will overprint. */ ruleBelowGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule * below. (Range: 0 to 100) Note: Valid only when the paragraph rule below type * is not solid. * @remarks Range: 0 to 100 */ ruleBelowGapTint: number; /** * The distance to indent the left edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLeftIndent: number | string; /** * The line weight of the rule below. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLineWeight: number | string; /** * The amount to offset the the paragraph rule below from the baseline of the * last line of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowOffset: number | string; /** * If true, the rule below will overprint. */ ruleBelowOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleBelowTint: number; /** * The stroke type of the rule below the paragraph. Can return: StrokeStyle or * String. */ ruleBelowType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule below. */ ruleBelowWidth: RuleWidth; /** * The space between paragraphs using same style. Can return: Unit or Spacing * enumerator. */ sameParaStyleSpacing: number | Spacing; /** * If true, the line changes size when characters are scaled. */ scaleAffectsLineHeight: boolean; /** * If true, applies shatai rotation. */ shataiAdjustRotation: boolean; /** * If true, adjusts shatai tsume. */ shataiAdjustTsume: boolean; /** * The shatai lens angle (in degrees). */ shataiDegreeAngle: number; /** * The amount (as a percentage) of shatai obliquing to apply. */ shataiMagnification: number; /** * The alignment to use for lines that contain a single word. */ singleWordJustification: SingleWordJustification; /** * The skew angle of the TextDefault. */ skew: number; /** * The height of the paragraph space below. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceAfter: number | string; /** * The height of the paragraph space above. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceBefore: number | string; /** * The minimum space after a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceAfter: number | string; /** * The minimum space before a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceBefore: number | string; /** * Whether a paragraph should be a single column, span columns or split columns */ spanColumnType: SpanColumnTypeOptions; /** * The number of columns a paragraph spans or the number of split columns. Can * return: Short Integer (1 - 40) or SpanColumnCountOptions enumerator. */ spanSplitColumnCount: number | SpanColumnCountOptions; /** * The inside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnInsideGutter: number | string; /** * The outside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnOutsideGutter: number | string; /** * The location at which to start the paragraph. */ startParagraph: StartParagraph; /** * The swatch (color, gradient, tint, or mixed ink) applied to the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughGapColor: Swatch | string; /** * If true, the gap color of the strikethrough stroke will overprint. Note: * Valid when strike through type is not solid. */ strikeThroughGapOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 * to 100) Note: Valid when strike through type is not solid. * @remarks Range: 0 to 100 */ strikeThroughGapTint: number; /** * The amount by which to offset the strikethrough stroke from the text * baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughOffset: number | string; /** * If true, the strikethrough stroke will overprint. */ strikeThroughOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ strikeThroughTint: number; /** * The stroke type of the strikethrough stroke. Can return: StrokeStyle or * String. */ strikeThroughType: StrokeStyle | string; /** * The stroke weight of the strikethrough stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughWeight: number | string; /** * If true, draws a strikethrough line through the text. */ strikeThru: boolean; /** * The stroke alignment applied to the text. */ strokeAlignment: TextStrokeAlign; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the TextDefault. Can also accept: String. */ strokeColor: Swatch | string; /** * The tint (as a percentage) of the stroke color of the TextDefault. (To * specify a tint percentage, use a number in the range of 0 to 100; to use the * inherited or overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * The stroke weight applied to the characters of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A list of the tab stops in the paragraph. Can return: Array of Arrays of * Property Name/Value Pairs. */ tabList: any[][][]; /** * A collection of tab stops. */ readonly tabStops: TabStops; /** * If true, makes the character horizontal in vertical text. */ tatechuyoko: boolean; /** * The horizontal offset for horizontal characters in vertical text. */ tatechuyokoXOffset: number; /** * The vertical offset for horizontal characters in vertical text. */ tatechuyokoYOffset: number; /** * The amount by which to loosen or tighten a block of text, specified in * thousands of an em. */ tracking: number; /** * The amount of space after each character. */ trailingAki: number; /** * If true, ideographic spaces will not wrap to the next line like text * characters. */ treatIdeographicSpaceAsSpace: boolean; /** * The amount of horizontal character compression. */ tsume: number; /** * If true, underlines the text. */ underline: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the underline * stroke. . Can return: Swatch or String. */ underlineColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * underline stroke. Note: Valid when underline type is not solid. Can return: * Swatch or String. */ underlineGapColor: Swatch | string; /** * If true, the gap color of the underline stroke will overprint. */ underlineGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of the underline stroke. (Range: * 0 to 100) Note: Valid when underline type is not solid. * @remarks Range: 0 to 100 */ underlineGapTint: number; /** * The amount by which to offset the underline from the text baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineOffset: number | string; /** * If true, the underline stroke color will overprint. */ underlineOverprint: boolean; /** * The underline stroke tint (as a percentage). (Range: 0 to 100) * @remarks Range: 0 to 100 */ underlineTint: number; /** * The stroke type of the underline stroke. Can return: StrokeStyle or String. */ underlineType: StrokeStyle | string; /** * The stroke weight of the underline stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineWeight: number | string; /** * The vertical scaling applied to the TextDefault. */ verticalScale: number; /** * If true, turns on warichu. */ warichu: boolean; /** * The warichu alignment. */ warichuAlignment: WarichuAlignment; /** * The minimum number of characters allowed after a line break. */ warichuCharsAfterBreak: number; /** * The minimum number of characters allowed before a line break. */ warichuCharsBeforeBreak: number; /** * The gap between lines of warichu characters. */ warichuLineSpacing: number; /** * The number of lines of warichu within a single normal line. */ warichuLines: number; /** * The amount (as a percentage) to scale parent text size to determine warichu * size. */ warichuSize: number; /** * The x (horizontal) offset for diacritic adjustment. */ xOffsetDiacritic: number; /** * The y (vertical) offset for diacritic adjustment. */ yOffsetDiacritic: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TextDefault[]; /** * If true, Nth design axis of variable font is hidden. * @param nthAxisIndex Index of design axis. */ isNthDesignAxisHidden(nthAxisIndex: number): boolean; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Set Nth design axis of a variable font. * @param nthAxisIndex Index of design axis. * @param nthAxisValue Value of nth design axis. */ setNthDesignAxis(nthAxisIndex: number, nthAxisValue: number): void; /** * Generates a string which, if executed, will return the TextDefault. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Text Directions. */ declare enum TextDirection { /** * Horizontal Text Direction */ HORIZONTAL_TYPE = 1702126696, /** * Mixed Text Direction */ MIXED_TYPE = 1702126701, /** * Unknown Text Direction */ UNKNOWN_TYPE = 1702126709, /** * Vertical Text Direction */ VERTICAL_TYPE = 1702126710, } /** * A text entry field. */ declare class TextEditbox extends Widget { /** * The default value in an editbox control. Note: Do not specify both edit * contents and edit value. If both are specified, the one that occurs later in * the script is used. */ editContents: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the TextEditbox. */ readonly id: number; /** * The index of the TextEditbox within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The width of the control. For an editbox or combobox, specifies the minimum * width of the box. */ minWidth: number; /** * The parent of the TextEditbox (a DialogColumn, DialogRow, EnablingGroup or * BorderPanel). */ readonly parent: DialogRow | EnablingGroup | BorderPanel | DialogColumn; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TextEditbox[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TextEditbox. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of text editboxes. */ declare class TextEditboxes { /** Returns the TextEditbox with the specified index or name. */ [index: number]: TextEditbox; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new TextEditbox. * @param withProperties Initial values for properties of the new TextEditbox (Optional) */ add(withProperties?: Object): TextEditbox; /** * Returns any TextEditbox in the collection. */ anyItem(): TextEditbox; /** * Displays the number of elements in the TextEditbox. */ count(): number; /** * Returns every TextEditbox in the collection. */ everyItem(): TextEditbox; /** * Returns the first TextEditbox in the collection. */ firstItem(): TextEditbox; /** * Returns the TextEditbox with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): TextEditbox; /** * Returns the TextEditbox with the specified ID. * @param id The ID. */ itemByID(id: number): TextEditbox; /** * Returns the TextEditboxes within the specified range. * @param from The TextEditbox, index, or name at the beginning of the range. Can accept: TextEditbox, Long Integer or String. * @param to The TextEditbox, index, or name at the end of the range. Can accept: TextEditbox, Long Integer or String. */ itemByRange(from: number | TextEditbox | string, to: number | TextEditbox | string): TextEditbox[]; /** * Returns the last TextEditbox in the collection. */ lastItem(): TextEditbox; /** * Returns the middle TextEditbox in the collection. */ middleItem(): TextEditbox; /** * Returns the TextEditbox whose index follows the specified TextEditbox in the * collection. * @param obj The TextEditbox whose index comes before the desired TextEditbox. */ nextItem(obj: TextEditbox): TextEditbox; /** * Returns the TextEditbox with the index previous to the specified index. * @param obj The index of the TextEditbox that follows the desired TextEditbox. */ previousItem(obj: TextEditbox): TextEditbox; /** * Generates a string which, if executed, will return the TextEditbox. */ toSource(): string; } /** * Text editing preferences. */ declare class TextEditingPreference extends Preference { /** * If true, allows text to be dragged and dropped in the story editor or galley * view. */ allowDragAndDropTextInStory: boolean; /** * If true, allows text to be dragged and dropped on a layout page. */ dragAndDropTextInLayout: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the TextEditingPreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, a single click (with the Type tool) converts non-text frames to * text frames. */ singleClickConvertsFramesToTextFrames: boolean; /** * If true, automatically adjusts spacing among words and between words and * punctuation marks when cutting and pasting text. */ smartCutAndPaste: boolean; /** * If true, a triple click selects a line of text. If false, a triple click * selects a paragraph. */ tripleClickSelectsLine: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TextEditingPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * TextEditingPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Character set options for exported text files. */ declare enum TextExportCharacterSet { /** * The default character set for the platform. */ DEFAULT_PLATFORM = 1415865972, /** * The Unicode UTF16 character set. */ UTF16 = 1937125686, /** * The Unicode UTF8 character set. */ UTF8 = 1937134904, } /** * Text export format */ declare enum TextExportFormatEnum { /** * Text with HTML tags */ HTML_TAG = 1701344364, /** * Text with SVG tags */ SVG_TAG = 1702065767, } /** * Text export preferences. */ declare class TextExportPreference extends Preference { /** * The character set. */ characterSet: TextExportCharacterSet; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the TextExportPreference (a Application). */ readonly parent: Application; /** * The platform on which the text file will be used. */ platform: ImportPlatform; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TextExportPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TextExportPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A text frame. */ declare class TextFrame extends PageItem { /** * Indicates whether the TextFrame has been flipped independently of its parent * object and, if yes, the direction in which the TextFrame was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the TextFrame relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the TextFrame relative to its containing object. * (Range: -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the TextFrame relative to its containing object. * (Range: -360 to 360) */ absoluteShearAngle: number; /** * The vertical scale of the TextFrame relative to its containing object. */ absoluteVerticalScale: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the TextFrame. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the TextFrame. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * Anchored object settings. */ readonly anchoredObjectSettings: AnchoredObjectSetting; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the TextFrame. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the TextFrame. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the TextFrame. */ readonly associatedXMLElement: XMLItem; /** * Baseline frame grid option settings. */ readonly baselineFrameGridOptions: BaselineFrameGridOption; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * A collection of buttons. */ readonly buttons: Buttons; /** * A collection of characters. */ readonly characters: Characters; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * Transparency settings for the content of the TextFrame. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The type of content that a frame can contain. */ contentType: ContentType; /** * The contents of the text frame. Can return: String, TextFrameContents * enumerator or SpecialCharacters enumerator. */ contents: string | TextFrameContents | SpecialCharacters; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the TextFrame. */ endJoin: EndJoin; /** * The last text frame in the thread. Can return: TextFrame or TextPath. */ readonly endTextFrame: TextFrame | TextPath; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * TextFrame. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the TextFrame's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the TextFrame. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * A collection of footnotes. */ readonly footnotes: Footnotes; /** * A collection of form fields. */ readonly formFields: FormFields; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the TextFrame excluding the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the TextFrame. (Range: * -180 to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the TextFrame. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the TextFrame, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the TextFrame. * (Range: -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the TextFrame. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the TextFrame, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * Default grid properties. Note: Applies to named, layout, and frame (story) * grids. */ readonly gridData: GridDataInformation; /** * A collection of groups. */ readonly groups: Groups; /** * A collection of hidden text objects. */ readonly hiddenTexts: HiddenTexts; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the TextFrame. */ horizontalScale: number; /** * The unique ID of the TextFrame. */ readonly id: number; /** * The index of the TextFrame within its containing object. */ readonly index: number; /** * A collection of insertion points. */ readonly insertionPoints: InsertionPoints; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the TextFrame is on. */ itemLayer: Layer; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * A collection of lines. */ readonly lines: Lines; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * Display performance options for the TextFrame. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the TextFrame is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * The name of the TextFrame. */ name: string; /** * The next text frame in the thread. Can return: TextFrame or TextPath. Can * also accept: NothingEnum enumerator. */ nextTextFrame: NothingEnum | TextFrame | TextPath; /** * If true, the TextFrame does not print. */ nonprinting: boolean; /** * A collection of notes. */ readonly notes: Notes; /** * Export options for the object */ readonly objectExportOptions: ObjectExportOption; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the story has overset text. */ readonly overflows: boolean; /** * If true, the TextFrame's fill color overprints any underlying objects. If * false, the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the TextFrame's stroke color overprints any underlying objects. If * false, the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * A collection of paragraphs. */ readonly paragraphs: Paragraphs; /** * The parent of the TextFrame (a Snippet, ComboBox, ListBox, TextBox, * SignatureField, Spread, MasterSpread, SplineItem, Polygon, GraphicLine, * Rectangle, Oval, Group, State, Cell, Character, PlaceGun or FlexObject). */ readonly parent: Cell | Character | ComboBox | GraphicLine | Group | ListBox | MasterSpread | Oval | PlaceGun | Polygon | Rectangle | SignatureField | SplineItem | Spread | State | TextBox | FlexObject | Snippet; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * The story that contains the text. */ readonly parentStory: Story; /** * A collection of paths. */ readonly paths: Paths; /** * A collection of polygons. */ readonly polygons: Polygons; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * The previous text frame in the thread. Can return: TextFrame or TextPath. * Can also accept: NothingEnum enumerator. */ previousTextFrame: NothingEnum | TextFrame | TextPath; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the TextFrame. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the TextFrame. (Range: -360 to 360) */ shearAngle: number; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The first text frame in the thread. Can return: TextFrame or TextPath. */ readonly startTextFrame: TextFrame | TextPath; /** * The stroke alignment applied to the TextFrame. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the TextFrame. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the TextFrame. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the TextFrame's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of tables. */ readonly tables: Tables; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text columns. */ readonly textColumns: TextColumns; /** * The index of the text frame within the story. */ readonly textFrameIndex: number; /** * Text frame preference settings. */ readonly textFramePreferences: TextFramePreference; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * A collection of text paths. */ readonly textPaths: TextPaths; /** * A collection of text style ranges. */ readonly textStyleRanges: TextStyleRanges; /** * A collection of text variable instances. */ readonly textVariableInstances: TextVariableInstances; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * A collection of text objects. */ readonly texts: Texts; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the TextFrame. */ verticalScale: number; /** * If true, the TextFrame is visible. */ visible: boolean; /** * The bounds of the TextFrame including the stroke width, in the format [y1, * x1, y2, x2], which give the coordinates of the top-left and bottom-right * corners of the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * A collection of words. */ readonly words: Words; /** * Dispatched after a TextFrame is placed. This event bubbles. This event is * not cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a TextFrame is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Creates a new page item by combining the TextFrame with other objects. * Deletes the objects if they do not intersect. * @param with_ The object(s) to add. */ addPath(with_: PageItem[]): PageItem; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the TextFrame's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the TextFrame that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Brings the TextFrame forward one level in its layer. */ bringForward(): void; /** * Brings the TextFrame to the front of its layer or in front of a particular * item. * @param reference The reference object to bring the object in front of (must have same parent) (Optional) */ bringToFront(reference?: PageItem): void; /** * Finds glyphs that match the find what value and replaces the glyphs with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGrep(reverseOrder?: boolean): Text[]; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value and replaces the text * with the change character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeTransliterate(reverseOrder?: boolean): Text[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the TextFrame. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the TextFrame to a different shape. * @param given The TextFrame's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Convert the text frame contents to raw text */ convertToRawText(): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new TextFrame. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new TextFrame. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Converts text to outlines. Each line of text becomes a polygon object. When * the converted text is a single letter that has no internal spaces or * detached parts, the polygon contains only a single path. Note: To determine * whether a font allows the creation of outlines, see allow outlines. * @param deleteOriginal If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) */ createOutlines(deleteOriginal?: boolean): PageItem[]; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new TextFrame. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new TextFrame. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new TextFrame. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the TextFrame at the specified location or offset. * @param to The location of the new TextFrame, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new TextFrame from the original TextFrame's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Creates a new page item by excluding the overlapping areas of the TextFrame * and other objects. * @param with_ The object(s) to exclude. */ excludeOverlapPath(with_: PageItem[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds glyphs that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGrep(reverseOrder?: boolean): Text[]; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findTransliterate(reverseOrder?: boolean): Text[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the TextFrame. * @param given The axis around which to flip the TextFrame. * @param around The point around which to flip the TextFrame. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TextFrame[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Creates a new page item by intersecting the TextFrame with other objects. * Returns an error if the objects do not intersect. * @param with_ The object(s) with which to intersect. */ intersectPath(with_: PageItem[]): PageItem; /** * Creates a compound path by combining the path(s) of the TextFrame with the * paths of other objects. * @param with_ The other objects whose paths to include in the new compound path. */ makeCompoundPath(with_: PageItem[]): PageItem; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Creates a new page item by reverse subtracting the overlapping areas of the * TextFrame and other objects. * @param with_ The object(s) to reverse subtract. */ minusBack(with_: PageItem[]): PageItem; /** * Moves the TextFrame to a new location. Note: Either the 'to' or 'by' * parameter is required; if both parameters are defined, only the to value is * used. * @param to The new location of the TextFrame,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the TextFrame relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Deprecated: Use contentPlace method. Original Description: Create a linked * story and place it into the target page item. * @param parentStory The story to place and link from. * @param showingOptions Whether to display the link options dialog (Optional) */ placeAndLink(parentStory: Story, showingOptions?: boolean): Story; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Recomposes the text in the TextFrame. */ recompose(): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Releases a compound path. */ releaseCompoundPath(): PageItem[]; /** * Deletes the TextFrame. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the TextFrame in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Sends the TextFrame back one level in its layer. */ sendBackward(): void; /** * Sends the TextFrame to the back of its layer or behind a particular item * (must have same parent). * @param reference The reference object to send the object behind (Optional) */ sendToBack(reference?: PageItem): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new TextFrame (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Creates a new page item by subtracting the overlapping areas of the * TextFrame and other objects. * @param with_ The object(s) to subtract. */ subtractPath(with_: PageItem[]): PageItem; /** * Generates a string which, if executed, will return the TextFrame. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the TextFrame using the last transformation performed on any * object. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgain(): string[]; /** * Transforms the TextFrame using the last transformation performed on any * TextFrame. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformAgainIndividually(): string[]; /** * Transforms the TextFrame using the last sequence of transform operations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgain(): string[]; /** * Transforms the TextFrame using the last sequence of transformations * performed on any single object or performed at the same time on any group of * objects. Transformations include moving, rotating, shearing, scaling, and * flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * Text frame content type options. */ declare enum TextFrameContents { /** * Fills the text frame with placeholder text. */ PLACEHOLDER_TEXT = 1346925688, /** * Fills the text frame with arabic placeholder text. */ PLACEHOLDER_TEXT_ARABIC = 1346925665, /** * Fills the text frame with cyrillic placeholder text. */ PLACEHOLDER_TEXT_CYRILLIC = 1346925667, /** * Fills the text frame with greek placeholder text. */ PLACEHOLDER_TEXT_GREEK = 1346925671, /** * Fills the text frame with hebrew placeholder text. */ PLACEHOLDER_TEXT_HEBREW = 1346925672, } /** * Text frame preferences. */ declare class TextFramePreference extends Preference { /** * The reference point for auto sizing of text frame. Reference point is * automatically adjusted to the suitable value depending on the auto-sizing * type value. As an example, top left reference point becomes top center for * height only dimension */ autoSizingReferencePoint: AutoSizingReferenceEnum; /** * Auto-sizing type of text frame. Based on type, reference value is * automatically adjusted. For example, for height only type, top-left * reference point becomes top-center. Recommended to change auto-sizing type, * after setting other auto-sizing attributes */ autoSizingType: AutoSizingTypeEnum; /** * Text Frame Column Rule Bottom Inset * @remarks Range: -10000 to 10000 */ columnRuleBottomInset: number; /** * If true, enable inset chain override. */ columnRuleInsetChainOverride: boolean; /** * Text Frame Column Rule Offset * @remarks Range: -10000 to 10000 */ columnRuleOffset: number; /** * If true, enable overprint override. */ columnRuleOverprintOverride: boolean; /** * If true, enable overrides to text frame vertical column rule options. */ columnRuleOverride: boolean; /** * Text Frame Column Rule Stroke Color */ columnRuleStrokeColor: Swatch; /** * Text Frame Column Rule Stroke Tint * @remarks Range: 0 to 100 */ columnRuleStrokeTint: number; /** * Text Frame Column Rule Stroke Type */ columnRuleStrokeType: StrokeStyle; /** * Text Frame Column Rule Width * @remarks Range: 0 to 10000 */ columnRuleStrokeWidth: number; /** * Text Frame Column Rule top inset * @remarks Range: -10000 to 10000 */ columnRuleTopInset: number; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The distance between the baseline of the text and the top inset of the text * frame or cell. */ firstBaselineOffset: FirstBaseline; /** * If true, enable overrides to document footnote options. */ footnotesEnableOverrides: boolean; /** * Minimum Spacing Before First Footnote * @remarks Measurement unit — also accepts a string such as "12mm". */ footnotesMinimumSpacing: number | string; /** * Space between footnotes. * @remarks Measurement unit — also accepts a string such as "12mm". */ footnotesSpaceBetween: number | string; /** * If true, enable straddling footnotes. */ footnotesSpanAcrossColumns: boolean; /** * If true, ignores text wrap settings for drawn or placed objects in the text * frame. */ ignoreWrap: boolean; /** * The amount to offset text from the edges of the text frame, specified either * as a single value applied uniformly to all sides of the text frame or as an * array of 4 values in the format [top inset, left inset, bottom inset, right * inset]. Can return: Unit (0 - 8640 points) or Array of 4 Units (0 - 8640 * points). */ insetSpacing: (number | number[][])[]; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The minimum distance between the baseline of the text and the top inset of * the text frame or cell. * @remarks Measurement unit — also accepts a string such as "12mm". */ minimumFirstBaselineOffset: number | string; /** * The minimum height for auto-sizing of the text frame. * @remarks Measurement unit — also accepts a string such as "12mm". */ minimumHeightForAutoSizing: number | string; /** * The minimum width for auto-sizing of the text frame. * @remarks Measurement unit — also accepts a string such as "12mm". */ minimumWidthForAutoSizing: number | string; /** * The parent of the TextFramePreference (a Application, Document, TextFrame, * EndnoteTextFrame or ObjectStyle). */ readonly parent: Document | EndnoteTextFrame | TextFrame | Application | ObjectStyle; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The number of columns in the text frame. Note: Depending on the value of use * fixed column width, the number of columns can change automatically when the * text frame size changes. * @remarks Range: 1 to 40 */ textColumnCount: number; /** * The column width of the columns in the text frame. * @remarks Measurement unit — also accepts a string such as "12mm". */ textColumnFixedWidth: number | string; /** * The space between columns in the text frame. * @remarks Measurement unit — also accepts a string such as "12mm". */ textColumnGutter: number | string; /** * The maximum column width of the columns in the text frame. Use 0 to indicate * no upper limit. * @remarks Measurement unit — also accepts a string such as "12mm". */ textColumnMaxWidth: number | string; /** * If true, maintains column width when the text frame is resized. If false, * causes columns to resize when the text frame is resized. Note: When true, * resizing the frame can change the number of columns in the frame. */ useFixedColumnWidth: boolean; /** * If true, maintains column width between a min and max range when the text * frame is resized. If false, causes columns to resize when the text frame is * resized. Note: When true, resizing the frame can change the number of * columns in the frame. */ useFlexibleColumnWidth: boolean; /** * If true, minimum height value is used during the auto-sizing of text frame. */ useMinimumHeightForAutoSizing: boolean; /** * If true, minimum width value is used during the auto-sizing of text frame. */ useMinimumWidthForAutoSizing: boolean; /** * If true, line-breaks are not introduced after auto sizing. */ useNoLineBreaksForAutoSizing: boolean; /** * Vertically justify balanced across all columns. */ verticalBalanceColumns: boolean; /** * The vertical alignment of the text content. */ verticalJustification: VerticalJustification; /** * The maximum amount of vertical space between two paragraphs. Note: Valid * only when vertical justification is justified; the specified amount is * applied in addition to the space before or space after values defined for * the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ verticalThreshold: number | string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TextFramePreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TextFramePreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of text frames. */ declare class TextFrames { /** Returns the TextFrame with the specified index or name. */ [index: number]: TextFrame; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new TextFrame * @param layer The layer on which to create the TextFrame. (Optional) * @param at The location at which to insert the TextFrame relative to the reference object or within the container object. (Optional) * @param reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) * @param withProperties Initial values for properties of the new TextFrame (Optional) */ add(layer?: Layer, at?: LocationOptions, reference?: Document | Layer | MasterSpread | Page | Spread | PageItem, withProperties?: Object): TextFrame; /** * Returns any TextFrame in the collection. */ anyItem(): TextFrame; /** * Displays the number of elements in the TextFrame. */ count(): number; /** * Returns every TextFrame in the collection. */ everyItem(): TextFrame; /** * Returns the first TextFrame in the collection. */ firstItem(): TextFrame; /** * Returns the TextFrame with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): TextFrame; /** * Returns the TextFrame with the specified ID. * @param id The ID. */ itemByID(id: number): TextFrame; /** * Returns the TextFrame with the specified name. * @param name The name. */ itemByName(name: string): TextFrame; /** * Returns the TextFrames within the specified range. * @param from The TextFrame, index, or name at the beginning of the range. Can accept: TextFrame, Long Integer or String. * @param to The TextFrame, index, or name at the end of the range. Can accept: TextFrame, Long Integer or String. */ itemByRange(from: number | TextFrame | string, to: number | TextFrame | string): TextFrame[]; /** * Returns the last TextFrame in the collection. */ lastItem(): TextFrame; /** * Returns the middle TextFrame in the collection. */ middleItem(): TextFrame; /** * Returns the TextFrame whose index follows the specified TextFrame in the * collection. * @param obj The TextFrame whose index comes before the desired TextFrame. */ nextItem(obj: TextFrame): TextFrame; /** * Returns the TextFrame with the index previous to the specified index. * @param obj The index of the TextFrame that follows the desired TextFrame. */ previousItem(obj: TextFrame): TextFrame; /** * Generates a string which, if executed, will return the TextFrame. */ toSource(): string; } /** * Character set options for importing text files. */ declare enum TextImportCharacterSet { /** * The ANSI character set. */ ANSI = 1095652169, /** * The Arabic ASMO character set. */ ARABIC_ASMO = 1415672685, /** * The Arabic ASMO transparent character set. */ ARABIC_ASMO_TRANSPARENT = 1415672692, /** * The Central European (ISO) character set. */ CENTRALEUROPEAN_ISO = 1416184645, /** * The Chinese Big 5 character set. */ CHINESE_BIG_5 = 1415799349, /** * The Cyrillic (CP855) character set. */ CYRILLIC_CP855 = 1415788597, /** * The Cyrillic (ISO) character set. */ CYRILLIC_ISO = 1416184697, /** * The Cyrillic (KOI8R) character set. */ CYRILLIC_KOI8R = 1416312946, /** * The Cyrillic (KOI8U) character set. */ CYRILLIC_KOI8U = 1416312949, /** * The DOS Latin 2 character set. */ DOS_LATIN_2 = 1415867442, /** * The GB18030 character set. */ GB18030 = 1416061491, /** * The GB2312 character set. */ GB2312 = 1416061535, /** * The Greek (ISO) character set. */ GREEK_ISO = 1416185707, /** * The KSC5601 character set. */ KSC5601 = 1414230883, /** * The Macintosh Arabic character set. */ MACINTOSH_ARABIC = 1416446322, /** * The Macintosh CE (Cantral European) character set. */ MACINTOSH_CE = 1416446789, /** * The Macintosh Croatian character set. */ MACINTOSH_CROATIAN = 1416446834, /** * The Macintosh Cyrillic character set. */ MACINTOSH_CYRILLIC = 1416446841, /** * The Macintosh Greek character set. */ MACINTOSH_GREEK = 1416447858, /** * The Macintosh Greek (Shared caps) character set. */ MACINTOSH_GREEK_SHARED_CAPS = 1416447794, /** * The Macintosh Hebrew character set. */ MACINTOSH_HEBREW = 1416448098, /** * The Macintosh Icelandic character set. */ MACINTOSH_ICELANDIC = 1416448355, /** * The Macintosh Roman character set. */ MACINTOSH_ROMAN = 1416450669, /** * The Macintosh Romanian character set. */ MACINTOSH_ROMANIAN = 1416450671, /** * The Macintosh Turkish character set. */ MACINTOSH_TURKISH = 1416451186, /** * The Recommend:Shift_JIS 83pv character set. */ RECOMMENDSHIFTJIS83PV = 1412969328, /** * The Shift_JIS 90ms character set. */ SHIFTJIS90MS = 1413034093, /** * The Shift_JIS 90pv character set. */ SHIFTJIS90PV = 1413034096, /** * The Turkish (ISO) character set. */ TURKISH_ISO = 1416189045, /** * The Unicode UTF16 character set. */ UTF16 = 1937125686, /** * The Unicode UTF8 character set. */ UTF8 = 1937134904, /** * The Windows Arabic character set. */ WINDOWS_ARABIC = 1417101682, /** * Tthe Windows Baltic character set. */ WINDOWS_BALTIC = 1417101940, /** * The Windows CE (Central European) character set. */ WINDOWS_CE = 1417102149, /** * The Windows Cyrillic character set. */ WINDOWS_CYRILLIC = 1417102201, /** * The Windows EE (Eastern European) character set. */ WINDOWS_EE = 1417102661, /** * The Windows Greek character set. */ WINDOWS_GREEK = 1417103218, /** * The Windows Hebrew character set. */ WINDOWS_HEBREW = 1417103458, /** * The Windows Turkish character set. */ WINDOWS_TURKISH = 1417106549, } /** * Text import preferences. */ declare class TextImportPreference extends Preference { /** * The computer language character set used to create the text file. */ characterSet: TextImportCharacterSet; /** * If true, converts the specified number of spaces into a tab. For information * on specifying the number of spaces, see spaces into tabs count. */ convertSpacesIntoTabs: boolean; /** * The dictionary to use for the imported text. */ dictionary: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the TextImportPreference (a Application). */ readonly parent: Application; /** * The platform used to create the imported text file. */ platform: ImportPlatform; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The number of spaces to convert to a tab. Note: Valid when convert spaces * into tabs is true. */ spacesIntoTabsCount: number; /** * If true, the import filter removes extra carriage returns at the ends of * lines. */ stripReturnsBetweenLines: boolean; /** * If true, the import filter removes extra carriage returns between * paragraphs. */ stripReturnsBetweenParagraphs: boolean; /** * If true, convert straight quotes and apostrophes in the imported text to * typographic quotation marks and apostrophes. */ useTypographersQuotes: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TextImportPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TextImportPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A text object that is on a path. */ declare class TextPath { /** * The halfway point between the start bracket and the end bracket. */ readonly centerBracket: number; /** * A collection of characters. */ readonly characters: Characters; /** * The contents of the text frame. Can return: String, TextFrameContents * enumerator or SpecialCharacters enumerator. */ contents: string | TextFrameContents | SpecialCharacters; /** * The end of the type on a path. Note: Additional text becomes overset text * unless the text is linked to another path or text frame. */ endBracket: number; /** * The last text frame in the thread. Can return: TextFrame or TextPath. */ readonly endTextFrame: TextFrame | TextPath; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The flip effect applied to the type on a path. */ flipPathEffect: FlipValues; /** * The unique ID of the TextPath. */ readonly id: number; /** * The index of the TextPath within its containing object. */ readonly index: number; /** * A collection of insertion points. */ readonly insertionPoints: InsertionPoints; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * A collection of lines. */ readonly lines: Lines; /** * The name of the TextPath; this is an alias to the TextPath's label property. */ name: string; /** * The next text frame in the thread. Can return: TextFrame or TextPath. Can * also accept: NothingEnum enumerator. */ nextTextFrame: NothingEnum | TextFrame | TextPath; /** * If true, the story has overset text. */ readonly overflows: boolean; /** * A collection of paragraphs. */ readonly paragraphs: Paragraphs; /** * The parent of the TextPath (a SplineItem, Polygon, GraphicLine, Rectangle, * Oval, TextFrame, EndnoteTextFrame or EPSText). */ readonly parent: EndnoteTextFrame | GraphicLine | Oval | Polygon | Rectangle | TextFrame | EPSText | SplineItem; /** * The story that contains the text. */ readonly parentStory: Story; /** * The alignment of the type on a path. */ pathAlignment: PathTypeAlignments; /** * The effect applied to the type on a path. */ pathEffect: TextPathEffects; /** * The spacing applied to the type on a path. */ pathSpacing: number; /** * The previous text frame in the thread. Can return: TextFrame or TextPath. * Can also accept: NothingEnum enumerator. */ previousTextFrame: NothingEnum | TextFrame | TextPath; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The location of the start of the type on the path, expressed in points. * Note: 0 is the first point on the path. */ startBracket: number; /** * The first text frame in the thread. Can return: TextFrame or TextPath. */ readonly startTextFrame: TextFrame | TextPath; /** * The alignment applied to the type on a path. */ textAlignment: TextTypeAlignments; /** * A collection of text columns. */ readonly textColumns: TextColumns; /** * The index of the text frame within the story. */ readonly textFrameIndex: number; /** * A collection of text style ranges. */ readonly textStyleRanges: TextStyleRanges; /** * A collection of text objects. */ readonly texts: Texts; /** * A collection of words. */ readonly words: Words; /** * Dispatched after a TextPath is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a TextPath is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Finds glyphs that match the find what value and replaces the glyphs with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value and replaces the text * with the change character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeTransliterate(reverseOrder?: boolean): Text[]; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds glyphs that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findTransliterate(reverseOrder?: boolean): Text[]; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TextPath[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the TextPath. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TextPath. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for the alignment and appearance of type on a path. */ declare enum TextPathEffects { /** * The center of each character's baseline is on the path while each vertical * edge is in line with the path's center point. */ GRAVITY_PATH_EFFECT = 1601201767, /** * The center of each character's baseline is parallel to the path's tangent. * This is the default effect. */ RAINBOW_PATH_EFFECT = 1601201778, /** * The text characters' horizontal edges are perfectly horizontal regardless of * the path shape. */ RIBBON_PATH_EFFECT = 1601201715, /** * The text characters' vertical edges are perfectly vertical regardless of the * path shape. */ SKEW_PATH_EFFECT = 1601201779, /** * The left edge of each character's baseline is on the path and no characters * are rotated. */ STAIR_STEP_PATH_EFFECT = 1601205107, } /** * A collection of text paths. */ declare class TextPaths { /** Returns the TextPath with the specified index or name. */ [index: number]: TextPath; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new TextPath. * @param withProperties Initial values for properties of the new TextPath (Optional) */ add(withProperties?: Object): TextPath; /** * Returns any TextPath in the collection. */ anyItem(): TextPath; /** * Displays the number of elements in the TextPath. */ count(): number; /** * Returns every TextPath in the collection. */ everyItem(): TextPath; /** * Returns the first TextPath in the collection. */ firstItem(): TextPath; /** * Returns the TextPath with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): TextPath; /** * Returns the TextPath with the specified ID. * @param id The ID. */ itemByID(id: number): TextPath; /** * Returns the TextPath with the specified name. * @param name The name. */ itemByName(name: string): TextPath; /** * Returns the TextPaths within the specified range. * @param from The TextPath, index, or name at the beginning of the range. Can accept: TextPath, Long Integer or String. * @param to The TextPath, index, or name at the end of the range. Can accept: TextPath, Long Integer or String. */ itemByRange(from: number | TextPath | string, to: number | TextPath | string): TextPath[]; /** * Returns the last TextPath in the collection. */ lastItem(): TextPath; /** * Returns the middle TextPath in the collection. */ middleItem(): TextPath; /** * Returns the TextPath whose index follows the specified TextPath in the * collection. * @param obj The TextPath whose index comes before the desired TextPath. */ nextItem(obj: TextPath): TextPath; /** * Returns the TextPath with the index previous to the specified index. * @param obj The index of the TextPath that follows the desired TextPath. */ previousItem(obj: TextPath): TextPath; /** * Generates a string which, if executed, will return the TextPath. */ toSource(): string; } /** * Text preferences. */ declare class TextPreference extends Preference { /** * If true, moves wrapped text to the next available leading increment below * the text wrap objects (skip by leading). */ abutTextToTextWrap: boolean; /** * Specifies where to insert new pages in response to overset text. */ addPages: AddPageOptions; /** * The amount that the baseline shift increases each time the user presses the * option/alt-shift-up arrow keys or decreases each time the user presses the * option/alt-shift-down arrow keys. (Range: .001 to 100) * @remarks Measurement unit — also accepts a string such as "12mm". */ baselineShiftKeyIncrement: number | string; /** * Enable auto-deletion of pages containing empty threaded text frames. */ deleteEmptyPages: boolean; /** * If true, highlights character and paragraph styles with colored backgrounds. */ enableStylePreviewMode: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, highlights custom kerned or tracked characters. */ highlightCustomSpacing: boolean; /** * If true, highlights hyphenation and justification rule violations in the * text. */ highlightHjViolations: boolean; /** * If true, highlights paragraphs that violate keep options. */ highlightKeeps: boolean; /** * If true, uses on-screen highlighting to identify kinsoku. */ highlightKinsoku: boolean; /** * If true, highlights missing fonts. */ highlightSubstitutedFonts: boolean; /** * If true, highlights substituted glyphs. */ highlightSubstitutedGlyphs: boolean; /** * If true, modifies indentation for Bulleted Paragraph and Bullets around a * Text Wrap object. */ honourTextIndentsWithTextWrap: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * If true, justifies text around text wrap objects. */ justifyTextWraps: boolean; /** * The amount the kerning value per 1000 ems increases each time the user * presses of the option/alt-right arrow keys or decreases each time the user * presses the option/alt-left arrow keys. (Range: 1 to 100) * @remarks Range: 1 to 100 */ kerningKeyIncrement: number; /** * The amount that leading increases each time the user presses the * option/alt-up arrow keys or decreases each time the user presses the * option/alt-down arrow keys. (Range: .001 to 100) * @remarks Measurement unit — also accepts a string such as "12mm". */ leadingKeyIncrement: number | string; /** * Restrict the adding of pages during smart text reflow to overridden master * text frames. */ limitToMasterTextFrames: boolean; /** * If true, links placed text files and spreadsheet files. If false, embeds the * files. */ linkTextFilesWhenImporting: boolean; /** * The parent of the TextPreference (a Application or Document). */ readonly parent: Application | Document; /** * Preserve left-hand and right-and pages when facing pages are enabled during * smart text reflow. */ preserveFacingPageSpreads: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, Japanese composer treats quotes as half width and rotates them in * vertical. */ quoteCharactersRotatedInVertical: boolean; /** * If this bool is set to true, shaping of Indic & Latin characters will be * done through Harfbuzz Shaping engine, instead of Lipika. */ shapeIndicAndLatinWithHarbuzz: boolean; /** * If true, shows hidden characters. */ showInvisibles: boolean; /** * The size of text formatted as small caps, specified as a percentage of the * font size. (Range: 1 to 200) * @remarks Range: 1 to 200 */ smallCap: number; /** * If true, enable automatic adding and deleting of pages in response to text * reflow. */ smartTextReflow: boolean; /** * If this is True, and if Smart text reflow is also enabled, then this will * synchronously add/delete pages after text reflowing */ smartTextReflowSync: boolean; /** * The position of subscript characters, specified as a percentage of the * regular leading. (Range: -500 to 500) * @remarks Range: -500 to 500 */ subscriptPosition: number; /** * The size of subscript characters, specified as a percentage of the font * size. (Range: 0 to 200) * @remarks Range: 1 to 200 */ subscriptSize: number; /** * The position of superscript characters, specified as a percentage of the * regular leading. (Range: -500 to 500) * @remarks Range: -500 to 500 */ superscriptPosition: number; /** * The size of superscript characters, specified as a percentage of the font * size. (Range: 0 to 200) * @remarks Range: 1 to 200 */ superscriptSize: number; /** * If true, converts straight quotes to typographic quotes. */ typographersQuotes: boolean; /** * If true, uses the glyph CID to get the mojikumi class of the character. */ useCidMojikumi: boolean; /** * If true, reverses X and Y scaling on Roman characters in vertical text. */ useNewVerticalScaling: boolean; /** * If true, automatically selects the correct optical size. */ useOpticalSize: boolean; /** * If true, applies the leading changes made to a text range to the entire * paragraph. If false, applies leading changes only to the text range. */ useParagraphLeading: boolean; /** * If true, text wrap does not affect text on layers above the layer that * contains the text wrap object. If false, text wrap affects text on all * visible layers. */ zOrderTextWrap: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TextPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TextPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Stroke alignment options. */ declare enum TextStrokeAlign { /** * The stroke straddles the path. */ CENTER_ALIGNMENT = 1936998723, /** * The stroke is outside the path, like a picture frame. */ OUTSIDE_ALIGNMENT = 1936998735, } /** * A continuous range of identical text formatting attributes. */ declare class TextStyleRange extends Text { /** * If true, aligns the baseline of the text to the baseline grid. */ alignToBaseline: boolean; /** * Lists all graphics contained by the TextStyleRange. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the TextStyleRange. */ readonly allPageItems: PageItem[]; /** * If true, words unassociated with a hyphenation dictionary can break to the * next line on any character. */ allowArbitraryHyphenation: boolean; /** * The character style applied to the text. Can also accept: String. */ appliedCharacterStyle: CharacterStyle | string; /** * The applied conditions. */ appliedConditions: Condition[]; /** * The font applied to the TextStyleRange, specified as either a font object or * the name of font family. Can return: Font or String. */ appliedFont: Font | string; /** * The language of the text. Can return: LanguageWithVendors or Language. Can * also accept: String. */ appliedLanguage: LanguageWithVendors | string | Language; /** * The applied character styles dictated by nested styles. */ readonly appliedNestedStyles: CharacterStyle[]; /** * The list to be part of. Can return: NumberingList or String. */ appliedNumberingList: NumberingList | string; /** * The paragraph style applied to the text. Can also accept: String. */ appliedParagraphStyle: ParagraphStyle | string; /** * The maximum ascent of any character in the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly ascent: number | string; /** * The XML elements associated with the TextStyleRange. */ readonly associatedXMLElements: XMLItem[]; /** * The percent of the type size to use for auto leading. (Range: 0 to 500). * @remarks Range: 0 to 500 */ autoLeading: number; /** * The number of half-width characters at or below which the characters * automatically run horizontally in vertical text. */ autoTcy: number; /** * If true, auto tcy includes Roman characters. */ autoTcyIncludeRoman: boolean; /** * If true or set to an enumeration value, balances ragged lines. Note: Not * valid with a single-line text composer. Can return: Boolean or * BalanceLinesStyle enumerator. */ balanceRaggedLines: boolean | BalanceLinesStyle; /** * The vertical offset of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly baseline: number | string; /** * The baseline shift applied to the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ baselineShift: number | string; /** * Bullet character. */ readonly bulletChar: Bullet; /** * The alignment of the bullet character. */ bulletsAlignment: ListAlignment; /** * List type for bullets and numbering. */ bulletsAndNumberingListType: ListType; /** * The character style to be used for the text after string. Can return: * CharacterStyle or String. */ bulletsCharacterStyle: CharacterStyle | string; /** * The text after string expression for bullets. */ bulletsTextAfter: string; /** * If true, adds the double period (..), ellipse (...), and double hyphen (--) * to the selected kinsoku set. Note: Valid only when a kinsoku set is in * effect. */ bunriKinshi: boolean; /** * A collection of buttons. */ readonly buttons: Buttons; /** * The capitalization scheme. */ capitalization: Capitalization; /** * The alignment of small characters to the largest character in the line. */ characterAlignment: CharacterAlignment; /** * The direction of the character. */ characterDirection: CharacterDirectionOptions; /** * The rotation angle (in degrees) of individual characters. Note: The rotation * is counterclockwise. */ characterRotation: number; /** * A collection of characters. */ readonly characters: Characters; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * If true, uses grid tracking to track non-Roman characters in CJK grids. */ cjkGridTracking: boolean; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * The text composer to use to compose the text. */ composer: string; /** * The contents of the text. Can return: String or SpecialCharacters * enumerator. */ contents: string | SpecialCharacters; /** * The maximum descent of any character in the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly descent: number | string; /** * Value of Design Axes */ designAxes: number[]; /** * The desired width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ desiredGlyphScaling: number; /** * The desired letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) */ desiredLetterSpacing: number; /** * The desired word spacing, specified as a percentage of the font word space * value. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ desiredWordSpacing: number; /** * Position of diacriticical characters. */ diacriticPosition: DiacriticPositionOptions; /** * The digits type. */ digitsType: DigitsTypeOptions; /** * The number of characters to drop cap. * @remarks Range: 0 to 150 */ dropCapCharacters: number; /** * The number of lines to drop cap. * @remarks Range: 0 to 25 */ dropCapLines: number; /** * The character style to apply to the drop cap. Can also accept: String. */ dropCapStyle: CharacterStyle | string; /** * Details about the drop cap based on the glyph outlines. 1 = left side * bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid. */ dropcapDetail: number; /** * Vertical offset of the end of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly endBaseline: number | string; /** * Horizontal offset of the end of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly endHorizontalOffset: number | string; /** * The stroke join type applied to the characters of the text. */ endJoin: OutlineJoin; /** * A collection of endnote text ranges. */ readonly endnoteRanges: EndnoteRanges; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * TextStyleRange. . Can also accept: String. */ fillColor: Swatch | string; /** * The tint (as a percentage) of the fill color of the TextStyleRange. (To * specify a tint percentage, use a number in the range of 0 to 100; to use the * inherited or overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * The amount to indent the first line. * @remarks Measurement unit — also accepts a string such as "12mm". */ firstLineIndent: number | string; /** * The name of the font style. */ fontStyle: string; /** * A collection of footnotes. */ readonly footnotes: Footnotes; /** * A collection of form fields. */ readonly formFields: FormFields; /** * The glyph variant to substitute for standard glyphs. */ glyphForm: AlternateGlyphForms; /** * The angle of a linear gradient applied to the fill of the text. (Range: -180 * to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the text. */ gradientFillLength: number; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the text. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the text. */ gradientStrokeLength: number; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * If true, aligns only the first line to the frame grid or baseline grid. If * false, aligns all lines to the grid. */ gridAlignFirstLineOnly: boolean; /** * The alignment to the frame grid or baseline grid. */ gridAlignment: GridAlignment; /** * The manual gyoudori setting. */ gridGyoudori: number; /** * A collection of groups. */ readonly groups: Groups; /** * A collection of hidden text objects. */ readonly hiddenTexts: HiddenTexts; /** * The horizontal offset of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly horizontalOffset: number | string; /** * The horizontal scaling applied to the TextStyleRange. */ horizontalScale: number; /** * The relative desirability of better spacing vs. fewer hyphens. A lower value * results in greater use of hyphens. (Range: 0 to 100) * @remarks Range: 0 to 10 */ hyphenWeight: number; /** * If true, allows the last word in a text column to be hyphenated. */ hyphenateAcrossColumns: boolean; /** * The mininum number of letters at the beginning of a word that can be broken * by a hyphen. * @remarks Range: 1 to 15 */ hyphenateAfterFirst: number; /** * The minimum number of letters at the end of a word that can be broken by a * hyphen. * @remarks Range: 1 to 15 */ hyphenateBeforeLast: number; /** * If true, allows hyphenation of capitalized words. */ hyphenateCapitalizedWords: boolean; /** * The maximum number of hyphens that can appear on consecutive lines. To * specify unlimited consecutive lines, use zero. * @remarks Range: 0 to 25 */ hyphenateLadderLimit: number; /** * If true, allows hyphenation in the last word in a paragraph. Note: Valid * only when hyphenation is true. */ hyphenateLastWord: boolean; /** * The minimum number of letters a word must have in order to qualify for * hyphenation. * @remarks Range: 3 to 25 */ hyphenateWordsLongerThan: number; /** * If true, allows hyphenation. */ hyphenation: boolean; /** * The amount of white space allowed at the end of a line of non-justified text * before hypenation begins. Note: Valid when composer is single-line composer. * @remarks Measurement unit — also accepts a string such as "12mm". */ hyphenationZone: number | string; /** * If true, ignores optical edge alignment for the paragraph. */ ignoreEdgeAlignment: boolean; /** * The index of the text in the collection or parent object. */ readonly index: number; /** * A collection of insertion points. */ readonly insertionPoints: InsertionPoints; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The number of grid squares in which to arrange the text. */ jidori: number; /** * The paragraph alignment. */ justification: Justification; /** * Use of Kashidas for justification */ kashidas: KashidasOptions; /** * If true, keeps all lines of the paragraph together. If false, allows * paragraphs to break across pages or columns. */ keepAllLinesTogether: boolean; /** * The minimum number of lines to keep together in a paragraph before allowing * a page break. * @remarks Range: 1 to 50 */ keepFirstLines: number; /** * The minimum number of lines to keep together in a paragraph after a page * break. * @remarks Range: 1 to 50 */ keepLastLines: number; /** * If true, keeps a specified number of lines together when the paragraph * breaks across columns or text frames. */ keepLinesTogether: boolean; /** * If true, forces the rule above the paragraph to remain in the frame bounds. * Note: Valid only when rule above is true. */ keepRuleAboveInFrame: boolean; /** * The minimum number of lines to keep with the next paragraph. * @remarks Range: 0 to 5 */ keepWithNext: number; /** * If the first line in the paragraph should be kept with the last line of * previous paragraph. */ keepWithPrevious: boolean; /** * The alignment of kenten characters relative to the parent characters. */ kentenAlignment: KentenAlignment; /** * The character set used for the custom kenten character. Note: Valid only * when kenten kind is custom. */ kentenCharacterSet: KentenCharacterSet; /** * The character used for kenten. Note: Valid only when kenten kind is custom. */ kentenCustomCharacter: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of * kenten characters. Can return: Swatch or String. */ kentenFillColor: Swatch | string; /** * The font to use for kenten characters. Can return: Font or String. */ kentenFont: Font | string; /** * The size (in points) of kenten characters. */ kentenFontSize: number; /** * The font style of kenten characters. Can return: String or NothingEnum * enumerator. */ kentenFontStyle: string | NothingEnum; /** * The style of kenten characters. */ kentenKind: KentenCharacter; /** * The method of overprinting the kenten fill. */ kentenOverprintFill: AdornmentOverprint; /** * The method of overprinting the kenten stroke. */ kentenOverprintStroke: AdornmentOverprint; /** * The distance between kenten characters and their parent characters. */ kentenPlacement: number; /** * The kenten position relative to the parent character. */ kentenPosition: RubyKentenPosition; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * kenten characters. Can return: Swatch or String. */ kentenStrokeColor: Swatch | string; /** * The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenStrokeTint: number; /** * The fill tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenTint: number; /** * The stroke weight (in points) of kenten characters. */ kentenWeight: number; /** * The horizontal size of kenten characters as a percent of the original size. */ kentenXScale: number; /** * The vertical size of kenten charachers as a percent of the original size. */ kentenYScale: number; /** * The type of pair kerning. */ kerningMethod: string; /** * The amount of space to add or remove between characters, specified in * thousands of an em. */ kerningValue: number; /** * The keyboard direction of the character. */ keyboardDirection: CharacterDirectionOptions; /** * The type of hanging punctuation to allow. Note: Valid only when a kinsoku * set is in effect. */ kinsokuHangType: KinsokuHangTypes; /** * The kinsoku set that determines legitimate line breaks. Can return: * KinsokuTable, KinsokuSet enumerator or String. */ kinsokuSet: KinsokuSet | KinsokuTable | string; /** * The type of kinsoku processing for preventing kinsoku characters from * beginning or ending a line. Note: Valid only when a kinsoku set is defined. */ kinsokuType: KinsokuType; /** * The amount to indent the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ lastLineIndent: number | string; /** * The leading applied to the text. Can return: Unit or Leading enumerator. */ leading: number | Leading; /** * The amount of space before each character. */ leadingAki: number; /** * The point from which leading is measured from line to line. */ leadingModel: LeadingModel; /** * The width of the left indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ leftIndent: number | string; /** * The number of objects in the collection. */ readonly length: number; /** * If true, replaces specific character combinations (e.g., fl, fi) with * ligature characters. */ ligatures: boolean; /** * A collection of lines. */ readonly lines: Lines; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * The maximum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ maximumGlyphScaling: number; /** * The maximum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ maximumLetterSpacing: number; /** * The maximum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ maximumWordSpacing: number; /** * If true, consecutive para borders with completely similar properties are * merged. */ mergeConsecutiveParaBorders: boolean; /** * The minimum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ minimumGlyphScaling: number; /** * The minimum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ minimumLetterSpacing: number; /** * The minimum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ minimumWordSpacing: number; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 0 to 1000 */ miterLimit: number; /** * The mojikumi table. For information, see mojikumi table defaults. Can * return: MojikumiTable, String or MojikumiTableDefaults enumerator. */ mojikumi: MojikumiTable | string | MojikumiTableDefaults; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * A collection of nested GREP styles. */ readonly nestedGrepStyles: NestedGrepStyles; /** * A collection of nested line styles. */ readonly nestedLineStyles: NestedLineStyles; /** * A collection of nested styles. */ readonly nestedStyles: NestedStyles; /** * If true, keeps the text on the same line. */ noBreak: boolean; /** * A collection of notes. */ readonly notes: Notes; /** * The alignment of the number. */ numberingAlignment: ListAlignment; /** * If true, apply the numbering restart policy. */ numberingApplyRestartPolicy: boolean; /** * The character style to be used for the number string. Can return: * CharacterStyle or String. */ numberingCharacterStyle: CharacterStyle | string; /** * Continue the numbering at this level. */ numberingContinue: boolean; /** * The number string expression for numbering. */ numberingExpression: string; /** * Numbering format options. Can return: NumberingStyle enumerator or String. */ numberingFormat: NumberingStyle | string; /** * The level of the paragraph. */ numberingLevel: number; /** * Numbering restart policies. */ readonly numberingRestartPolicies: NumberingRestartPolicy; /** * Determines starting number in a numbered list. */ numberingStartAt: number; /** * OpenType features. Can return: Array of Array of 2 Strings or Long Integers. */ opentypeFeatures: (string[][] | number[])[]; /** * If true, uses contextual alternate forms in OpenType fonts. */ otfContextualAlternate: boolean; /** * If true, uses discretionary ligatures in OpenType fonts. */ otfDiscretionaryLigature: boolean; /** * The figure style in OpenType fonts. */ otfFigureStyle: OTFFigureStyle; /** * If true, uses fractions in OpenType fonts. */ otfFraction: boolean; /** * If true, switches hiragana fonts, which have different glyphs for horizontal * and vertical. */ otfHVKana: boolean; /** * If true, use historical forms in OpenType fonts. */ otfHistorical: boolean; /** * If true, use alternate justification forms in OpenType fonts */ otfJustificationAlternate: boolean; /** * If true, uses localized forms in OpenType fonts. */ otfLocale: boolean; /** * If true, uses mark positioning in OpenType fonts. */ otfMark: boolean; /** * If true, uses ordinals in OpenType fonts. */ otfOrdinal: boolean; /** * If true, use overlapping swash forms in OpenType fonts */ otfOverlapSwash: boolean; /** * If true, kerns according to proportional CJK metrics in OpenType fonts. */ otfProportionalMetrics: boolean; /** * If true, applies italics to half-width alphanumerics. */ otfRomanItalics: boolean; /** * If true, use a slashed zeroes in OpenType fonts. */ otfSlashedZero: boolean; /** * If true, use stretched alternate forms in OpenType fonts */ otfStretchedAlternate: boolean; /** * If true, use stylistic alternate forms in OpenType fonts */ otfStylisticAlternate: boolean; /** * The stylistic sets to use in OpenType fonts. */ otfStylisticSets: number; /** * If true, uses swash forms in OpenType fonts. */ otfSwash: boolean; /** * If true, uses titling forms in OpenType fonts. */ otfTitling: boolean; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the fill color of the characters will overprint. */ overprintFill: boolean; /** * If true, the stroke of the characters will overprint. */ overprintStroke: boolean; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphBorderBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLeftCornerRadius: number | string; /** * The bottom line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLineWeight: number | string; /** * The distance to offset the bottom edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph border. */ paragraphBorderBottomOrigin: ParagraphBorderBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphBorderBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomRightCornerRadius: number | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * stroke. Can return: Swatch or String. */ paragraphBorderColor: Swatch | string; /** * If true, then paragraph border is also displayed at the points where the * paragraph splits across frames or columns. */ paragraphBorderDisplayIfSplits: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * border gap. Note: Valid only when the border type is not solid. Can return: * Swatch or String. */ paragraphBorderGapColor: Swatch | string; /** * If true, the paragraph border gap will overprint. Note: Valid only when * border type is not solid. */ paragraphBorderGapOverprint: boolean; /** * The tint (as a percentage) of the paragraph border gap. Note: Valid only * when the border type is not solid. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderGapTint: number; /** * The left line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftLineWeight: number | string; /** * The distance to offset the left edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftOffset: number | string; /** * If true, the paragraph border is on. */ paragraphBorderOn: boolean; /** * If true, the paragraph border will overprint. */ paragraphBorderOverprint: boolean; /** * The right line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightLineWeight: number | string; /** * The distance to offset the right edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightOffset: number | string; /** * The end shape of an open path. */ paragraphBorderStrokeEndCap: EndCap; /** * The corner join applied to the TextStyleRange. */ paragraphBorderStrokeEndJoin: EndJoin; /** * The tint (as a percentage) of the paragraph stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphBorderTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLeftCornerRadius: number | string; /** * The top line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLineWeight: number | string; /** * The distance to offset the top edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph border. */ paragraphBorderTopOrigin: ParagraphBorderTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphBorderTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopRightCornerRadius: number | string; /** * The type of the border for the paragraph. Can return: StrokeStyle or String. */ paragraphBorderType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph border. */ paragraphBorderWidth: ParagraphBorderEnum; /** * Paragraph direction. */ paragraphDirection: ParagraphDirectionOptions; /** * If true, the gyoudori mode applies to the entire paragraph. If false, the * gyoudori mode applies to each line in the paragraph. */ paragraphGyoudori: boolean; /** * Paragraph justification. */ paragraphJustification: ParagraphJustificationOptions; /** * Paragraph kashida width. 0 is none, 1 is short, 2 is medium, 3 is long */ paragraphKashidaWidth: number; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphShadingBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomLeftCornerRadius: number | string; /** * The distance to offset the bottom edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph shading. */ paragraphShadingBottomOrigin: ParagraphShadingBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphShadingBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomRightCornerRadius: number | string; /** * If true, forces the shading of the paragraph to be clipped with respect to * frame shape. */ paragraphShadingClipToFrame: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * shading. Can return: Swatch or String. */ paragraphShadingColor: Swatch | string; /** * The distance to offset the left edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingLeftOffset: number | string; /** * If true, the paragraph shading is On. */ paragraphShadingOn: boolean; /** * If true, the paragraph shading will overprint. */ paragraphShadingOverprint: boolean; /** * The distance to offset the right edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingRightOffset: number | string; /** * If true, suppress printing of the shading of the paragraph. */ paragraphShadingSuppressPrinting: boolean; /** * The tint (as a percentage) of the paragraph shading. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphShadingTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphShadingTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopLeftCornerRadius: number | string; /** * The distance to offset the top edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph shading. */ paragraphShadingTopOrigin: ParagraphShadingTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphShadingTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopRightCornerRadius: number | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph shading. */ paragraphShadingWidth: ParagraphShadingWidthEnum; /** * A collection of paragraphs. */ readonly paragraphs: Paragraphs; /** * The parent of the TextStyleRange (a XmlStory, TextPath, TextFrame, * EndnoteTextFrame, Text, InsertionPoint, TextStyleRange, Paragraph, * TextColumn, Line, Word, Character, Story, Cell, XMLElement, Endnote, * Footnote, Note, Change or HiddenText). */ readonly parent: Cell | Change | Character | Endnote | EndnoteTextFrame | Footnote | InsertionPoint | Line | Note | Paragraph | Story | Text | TextColumn | TextFrame | TextPath | TextStyleRange | Word | XMLElement | HiddenText | XmlStory; /** * The story that contains the text. */ readonly parentStory: Story; /** * An array of the text frames that contain the text. Can return: Array of * TextFrames or TextPaths. */ readonly parentTextFrames: (TextFrames | TextPaths)[]; /** * The text size. * @remarks Measurement unit — also accepts a string such as "12mm". */ pointSize: number | string; /** * A collection of polygons. */ readonly polygons: Polygons; /** * The text position relative to the baseline. */ position: Position; /** * The OpenType positional form. */ positionalForm: PositionalForms; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The hyphenation style chosen for the provider. */ providerHyphenationStyle: HyphenationStyleEnum; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * If true, disallows line breaks in numbers. If false, lines can break between * digits in multi-digit numbers. */ rensuuji: boolean; /** * The width of the right indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ rightIndent: number | string; /** * If true, rotates Roman characters in vertical text. */ rotateSingleByteCharacters: boolean; /** * The ruby alignment. */ rubyAlignment: RubyAlignments; /** * If true, auto aligns ruby. */ rubyAutoAlign: boolean; /** * If true, automatically scales ruby to the specified percent of parent text * size. For information on specifying a percent, see ruby parent scaling * percent. */ rubyAutoScaling: boolean; /** * If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to * fit one em. */ rubyAutoTcyAutoScale: boolean; /** * The number of digits included in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyDigits: number; /** * If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyIncludeRoman: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby * characters. Can return: Swatch or String. */ rubyFill: Swatch | string; /** * If true, ruby is on. */ rubyFlag: boolean; /** * The font applied to ruby characters. Can return: Font or String. */ rubyFont: Font | string; /** * The size (in points) of ruby characters. */ rubyFontSize: number; /** * The font style of ruby characters. Can return: String or NothingEnum * enumerator. */ rubyFontStyle: string | NothingEnum; /** * If true, uses OpenType Pro fonts for ruby. */ rubyOpenTypePro: boolean; /** * If true, constrains ruby overhang to the specified amount. For information * on specifying an amount, see ruby parent overhang amount. */ rubyOverhang: boolean; /** * The method of overprinting the ruby fill. */ rubyOverprintFill: AdornmentOverprint; /** * The method of overprinting the ruby stroke. */ rubyOverprintStroke: AdornmentOverprint; /** * The amount by which ruby characters can overhang the parent text. */ rubyParentOverhangAmount: RubyOverhang; /** * The amount (as a percentage) to scale the parent text size to determine the * ruby text size. */ rubyParentScalingPercent: number; /** * The ruby spacing relative to the parent text. */ rubyParentSpacing: RubyParentSpacing; /** * The position of ruby characters relative to the parent text. */ rubyPosition: RubyKentenPosition; /** * The ruby string contents. */ rubyString: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * ruby characters. Can return: Swatch or String. */ rubyStroke: Swatch | string; /** * The stroke tint (as a percentage) of ruby characters. */ rubyStrokeTint: number; /** * The tint (as a percentage) of the ruby fill color. (Range: 0 to 100) * @remarks Range: 0 to 100 */ rubyTint: number; /** * The ruby type. */ rubyType: RubyTypes; /** * The stroke weight (in points) of ruby characters. */ rubyWeight: number; /** * The amount of horizontal space between ruby and parent characters. */ rubyXOffset: number; /** * The horizontal size of ruby characters, specified as a percent of the * original size. */ rubyXScale: number; /** * The amount of vertical space between ruby and parent characters. */ rubyYOffset: number; /** * The vertical size of ruby characters, specified as a percent of the original * size. */ rubyYScale: number; /** * If true, places a rule above the paragraph. */ ruleAbove: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule above. Can return: Swatch or String. */ ruleAboveColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule above. Note: Valid only when the paragraph rule above * type is not solid. Can return: Swatch or String. */ ruleAboveGapColor: Swatch | string; /** * If true, the stroke gap of the paragraph rule above will overprint. Note: * Valid only the rule above type is not solid. */ ruleAboveGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule. * (Range: 0 to 100) Note: Valid only when the rule above type is not solid. * @remarks Range: 0 to 100 */ ruleAboveGapTint: number; /** * The distance to indent the left edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLeftIndent: number | string; /** * The line weight of the rule above. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLineWeight: number | string; /** * The amount to offset the paragraph rule above from the baseline of the first * line the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveOffset: number | string; /** * If true, the paragraph rule above will overprint. */ ruleAboveOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleAboveTint: number; /** * The stroke type of the rule above the paragraph. Can return: StrokeStyle or * String. */ ruleAboveType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule above. */ ruleAboveWidth: RuleWidth; /** * If true, applies a paragraph rule below. */ ruleBelow: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule below. Can return: Swatch or String. */ ruleBelowColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule below. Note: Valid only when the paragraph rule below * type is not solid. Can return: Swatch or String. */ ruleBelowGapColor: Swatch | string; /** * If true, the gap color of the rule below will overprint. */ ruleBelowGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule * below. (Range: 0 to 100) Note: Valid only when the paragraph rule below type * is not solid. * @remarks Range: 0 to 100 */ ruleBelowGapTint: number; /** * The distance to indent the left edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLeftIndent: number | string; /** * The line weight of the rule below. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLineWeight: number | string; /** * The amount to offset the the paragraph rule below from the baseline of the * last line of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowOffset: number | string; /** * If true, the rule below will overprint. */ ruleBelowOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleBelowTint: number; /** * The stroke type of the rule below the paragraph. Can return: StrokeStyle or * String. */ ruleBelowType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule below. */ ruleBelowWidth: RuleWidth; /** * The space between paragraphs using same style. Can return: Unit or Spacing * enumerator. */ sameParaStyleSpacing: number | Spacing; /** * If true, the line changes size when characters are scaled. */ scaleAffectsLineHeight: boolean; /** * If true, applies shatai rotation. */ shataiAdjustRotation: boolean; /** * If true, adjusts shatai tsume. */ shataiAdjustTsume: boolean; /** * The shatai lens angle (in degrees). */ shataiDegreeAngle: number; /** * The amount (as a percentage) of shatai obliquing to apply. */ shataiMagnification: number; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * The alignment to use for lines that contain a single word. */ singleWordJustification: SingleWordJustification; /** * The skew angle of the TextStyleRange. */ skew: number; /** * The height of the paragraph space below. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceAfter: number | string; /** * The height of the paragraph space above. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceBefore: number | string; /** * The minimum space after a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceAfter: number | string; /** * The minimum space before a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceBefore: number | string; /** * Whether a paragraph should be a single column, span columns or split columns */ spanColumnType: SpanColumnTypeOptions; /** * The number of columns a paragraph spans or the number of split columns. Can * return: Short Integer (1 - 40) or SpanColumnCountOptions enumerator. */ spanSplitColumnCount: number | SpanColumnCountOptions; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The inside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnInsideGutter: number | string; /** * The outside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnOutsideGutter: number | string; /** * The location at which to start the paragraph. */ startParagraph: StartParagraph; /** * The swatch (color, gradient, tint, or mixed ink) applied to the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughGapColor: Swatch | string; /** * If true, the gap color of the strikethrough stroke will overprint. Note: * Valid when strike through type is not solid. */ strikeThroughGapOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 * to 100) Note: Valid when strike through type is not solid. * @remarks Range: 0 to 100 */ strikeThroughGapTint: number; /** * The amount by which to offset the strikethrough stroke from the text * baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughOffset: number | string; /** * If true, the strikethrough stroke will overprint. */ strikeThroughOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ strikeThroughTint: number; /** * The stroke type of the strikethrough stroke. Can return: StrokeStyle or * String. */ strikeThroughType: StrokeStyle | string; /** * The stroke weight of the strikethrough stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughWeight: number | string; /** * If true, draws a strikethrough line through the text. */ strikeThru: boolean; /** * The stroke alignment applied to the text. */ strokeAlignment: TextStrokeAlign; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the TextStyleRange. Can also accept: String. */ strokeColor: Swatch | string; /** * The tint (as a percentage) of the stroke color of the TextStyleRange. (To * specify a tint percentage, use a number in the range of 0 to 100; to use the * inherited or overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * The stroke weight applied to the characters of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * If true, the applied style has been overridden with additional attributes. */ readonly styleOverridden: boolean; /** * A list of the tab stops in the paragraph. Can return: Array of Arrays of * Property Name/Value Pairs. */ tabList: any[][][]; /** * A collection of tab stops. */ readonly tabStops: TabStops; /** * A collection of tables. */ readonly tables: Tables; /** * If true, makes the character horizontal in vertical text. */ tatechuyoko: boolean; /** * The horizontal offset for horizontal characters in vertical text. */ tatechuyokoXOffset: number; /** * The vertical offset for horizontal characters in vertical text. */ tatechuyokoYOffset: number; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text columns. */ readonly textColumns: TextColumns; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * A collection of text style ranges. */ readonly textStyleRanges: TextStyleRanges; /** * A collection of text variable instances. */ readonly textVariableInstances: TextVariableInstances; /** * A collection of text objects. */ readonly texts: Texts; /** * The amount by which to loosen or tighten a block of text, specified in * thousands of an em. */ tracking: number; /** * The amount of space after each character. */ trailingAki: number; /** * If true, ideographic spaces will not wrap to the next line like text * characters. */ treatIdeographicSpaceAsSpace: boolean; /** * The amount of horizontal character compression. */ tsume: number; /** * If true, underlines the text. */ underline: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the underline * stroke. . Can return: Swatch or String. */ underlineColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * underline stroke. Note: Valid when underline type is not solid. Can return: * Swatch or String. */ underlineGapColor: Swatch | string; /** * If true, the gap color of the underline stroke will overprint. */ underlineGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of the underline stroke. (Range: * 0 to 100) Note: Valid when underline type is not solid. * @remarks Range: 0 to 100 */ underlineGapTint: number; /** * The amount by which to offset the underline from the text baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineOffset: number | string; /** * If true, the underline stroke color will overprint. */ underlineOverprint: boolean; /** * The underline stroke tint (as a percentage). (Range: 0 to 100) * @remarks Range: 0 to 100 */ underlineTint: number; /** * The stroke type of the underline stroke. Can return: StrokeStyle or String. */ underlineType: StrokeStyle | string; /** * The stroke weight of the underline stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineWeight: number | string; /** * The vertical scaling applied to the TextStyleRange. */ verticalScale: number; /** * If true, turns on warichu. */ warichu: boolean; /** * The warichu alignment. */ warichuAlignment: WarichuAlignment; /** * The minimum number of characters allowed after a line break. */ warichuCharsAfterBreak: number; /** * The minimum number of characters allowed before a line break. */ warichuCharsBeforeBreak: number; /** * The gap between lines of warichu characters. */ warichuLineSpacing: number; /** * The number of lines of warichu within a single normal line. */ warichuLines: number; /** * The amount (as a percentage) to scale parent text size to determine warichu * size. */ warichuSize: number; /** * A collection of words. */ readonly words: Words; /** * The x (horizontal) offset for diacritic adjustment. */ xOffsetDiacritic: number; /** * The y (vertical) offset for diacritic adjustment. */ yOffsetDiacritic: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Apply a character style. * @param using The character style to apply. */ applyCharacterStyle(using: CharacterStyle): void; /** * Apply one or more conditions. * @param using The condition(s) to apply * @param removeExisting If true, remove existing conditions. (Optional) */ applyConditions(using: Condition[], removeExisting?: boolean): void; /** * Apply a paragraph style. * @param using The paragraph style to apply. * @param clearingOverrides If true, clear any text attributes before applying the style. (Optional) */ applyParagraphStyle(using: ParagraphStyle, clearingOverrides?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds glyphs that match the find what value and replaces the glyphs with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value and replaces the text * with the change character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeTransliterate(reverseOrder?: boolean): Text[]; /** * Sets the case of the text. * @param using The text case option. */ changecase(using: ChangecaseMode): void; /** * Clears the specified types of override. * @param overridesToClear The types of override to clear. (Optional) */ clearOverrides(overridesToClear?: OverrideType): void; /** * Convert bullets and numbering to text. */ convertBulletsAndNumberingToText(): void; /** * Converts the text to a note. */ convertToNote(): Note; /** * Converts the text to a table. * @param columnSeparator The character that starts a new column in the new table. (Optional) * @param rowSeparator The character starts a new row in the new table. (Optional) * @param numberOfColumns The number of columns in the table. Note: Valid only when the column and row separator characters are the same. (Optional) */ convertToTable(columnSeparator?: string, rowSeparator?: string, numberOfColumns?: number): Table; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new TextStyleRange. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new TextStyleRange. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Converts text to outlines. Each line of text becomes a polygon object. When * the converted text is a single letter that has no internal spaces or * detached parts, the polygon contains only a single path. Note: To determine * whether a font allows the creation of outlines, see allow outlines. * @param deleteOriginal If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) */ createOutlines(deleteOriginal?: boolean): PageItem[]; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new TextStyleRange. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create thumbnail for selected text using the applied style and overrides * with the given properties. * @param previewText Text to use as sample * @param pointSize Text font size (in points) * @param space Color space RGB, CMYK or LAB * @param colorValue Color values * @param to The path to the export file. * @param charOrParaStyle The applied style type to use. */ createStyleThumbnailWithProperties(previewText: string, pointSize: number, space: ColorSpace, colorValue: number[], to: File, charOrParaStyle: StyleType): boolean; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new TextStyleRange. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create thumbnail for selected text with the given properties. * @param previewText Text to use as sample * @param pointSize Text font size (in points) * @param space Color space RGB, CMYK or LAB * @param colorValue Color values * @param to The path to the export file. */ createThumbnailWithProperties(previewText: string, pointSize: number, space: ColorSpace, colorValue: number[], to: File): boolean; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new TextStyleRange. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Duplicates the text in the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional) */ duplicate(to: LocationOptions, reference?: Cell | Column | Row | Story | Table | Text | PageItem): Text; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Finds glyphs that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGrep(reverseOrder?: boolean): Text[]; /** * Finds hyperlink sources that intersecting with specified text range. * @param sortOrder The sort order of found ranges. (Optional) */ findHyperlinks(sortOrder?: RangeSortOrder): HyperlinkTextSource[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findTransliterate(reverseOrder?: boolean): Text[]; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TextStyleRange[]; /** * If true, Nth design axis of variable font is hidden. * @param nthAxisIndex Index of design axis. */ isNthDesignAxisHidden(nthAxisIndex: number): boolean; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the text to the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional) */ move(to: LocationOptions, reference?: Cell | Column | Row | Story | Table | Text | PageItem): Text; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Recomposes the text in the TextStyleRange. */ recompose(): void; /** * Deletes the TextStyleRange. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Selects the object. * @param existingSelection The selection status of the TextStyleRange in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Set Nth design axis of a variable font. * @param nthAxisIndex Index of design axis. * @param nthAxisValue Value of nth design axis. */ setNthDesignAxis(nthAxisIndex: number, nthAxisValue: number): void; /** * Jump to the text range. */ showText(): void; /** * If true, text has local overrides * @param charOrParaStyle Style type to look at. * @param charStyleAsOverride Whether to consider character styles as overrides or not (Optional) */ textHasOverrides(charOrParaStyle: StyleType, charStyleAsOverride?: boolean): boolean; /** * Generates a string which, if executed, will return the TextStyleRange. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of text style ranges. */ declare class TextStyleRanges { /** Returns the TextStyleRange with the specified index or name. */ [index: number]: TextStyleRange; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any TextStyleRange in the collection. */ anyItem(): TextStyleRange; /** * Displays the number of elements in the TextStyleRange. */ count(): number; /** * Returns every TextStyleRange in the collection. */ everyItem(): TextStyleRange; /** * Returns the first TextStyleRange in the collection. */ firstItem(): TextStyleRange; /** * Returns the TextStyleRange with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): TextStyleRange; /** * Returns the TextStyleRanges within the specified range. * @param from The TextStyleRange, index, or name at the beginning of the range. Can accept: TextStyleRange, Long Integer or String. * @param to The TextStyleRange, index, or name at the end of the range. Can accept: TextStyleRange, Long Integer or String. */ itemByRange(from: number | TextStyleRange | string, to: number | TextStyleRange | string): TextStyleRange[]; /** * Returns the last TextStyleRange in the collection. */ lastItem(): TextStyleRange; /** * Returns the middle TextStyleRange in the collection. */ middleItem(): TextStyleRange; /** * Returns the TextStyleRange whose index follows the specified TextStyleRange * in the collection. * @param obj The TextStyleRange whose index comes before the desired TextStyleRange. */ nextItem(obj: TextStyleRange): TextStyleRange; /** * Returns the TextStyleRange with the index previous to the specified index. * @param obj The index of the TextStyleRange that follows the desired TextStyleRange. */ previousItem(obj: TextStyleRange): TextStyleRange; /** * Generates a string which, if executed, will return the TextStyleRange. */ toSource(): string; } /** * The text alignment relative to the path. */ declare enum TextTypeAlignments { /** * The top-edge or right-edge baseline of the em box is aligned to the path. */ ABOVE_RIGHT_EM_BOX_TEXT_ALIGNMENT = 1952543333, /** * The ideographic character face box top-edge or right-edge baseline is * aligned to the path. */ ABOVE_RIGHT_ICF_BOX_TEXT_ALIGNMENT = 1952543337, /** * Aligns the ascender to the path (not the path's stroke). */ ASCENDER_TEXT_ALIGNMENT = 1952538995, /** * The text baseline is aligned to the path (not the path's stroke). */ BASELINE_TEXT_ALIGNMENT = 1952539244, /** * The bottom-edge or left-edge baseline of the em box is aligned to the path. */ BELOW_LEFT_EM_BOX_TEXT_ALIGNMENT = 1952607333, /** * The ideographic character face box bottom-edge or left-edge baseline is * aligned to the path. */ BELOW_LEFT_ICF_BOX_TEXT_ALIGNMENT = 1952607337, /** * Aligns the midpoint between the ascender and the descender to the path (not * the path's stroke). */ CENTER_TEXT_ALIGNMENT = 1952539508, /** * Aligns descender to the path (not the path's stroke). */ DESCENDER_TEXT_ALIGNMENT = 1952539763, } /** * A text variable definition in a document. */ declare class TextVariable { /** * Variable instances associated with the text variable. */ readonly associatedInstances: TextVariableInstance[]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the TextVariable within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the TextVariable. */ name: string; /** * The parent of the TextVariable (a Application or Document). */ readonly parent: Application | Document; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The preferences associated with the text variable. Can return: * PageNumberVariablePreference, ChapterNumberVariablePreference, * DateVariablePreference, FileNameVariablePreference, * MatchCharacterStylePreference, MatchParagraphStylePreference, * CustomTextVariablePreference or CaptionMetadataVariablePreference. */ readonly variableOptions: ChapterNumberVariablePreference | CustomTextVariablePreference | DateVariablePreference | FileNameVariablePreference | MatchCharacterStylePreference | MatchParagraphStylePreference | PageNumberVariablePreference | CaptionMetadataVariablePreference; /** * The variable type. */ variableType: VariableTypes; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Convert all of this variable's instances to text. */ convertToText(): Text[]; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TextVariable[]; /** * Deletes the TextVariable. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TextVariable. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A text variable instance in the text. */ declare class TextVariableInstance { /** * The associated text variable. */ associatedTextVariable: TextVariable; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the TextVariableInstance. */ readonly id: number; /** * The index of the TextVariableInstance within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the TextVariableInstance. */ readonly name: string; /** * The parent of the TextVariableInstance (a XmlStory, TextFrame, * EndnoteTextFrame, Story, Note, Cell, Footnote or Change). */ readonly parent: Cell | EndnoteTextFrame | Footnote | Note | Story | TextFrame | Change | XmlStory; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The text that replaces the variable marker. Note: This property cannot be * set; it can be used only to update variables. . */ readonly resultText: string; /** * The insertion point before the table in the story containing the table. */ readonly storyOffset: InsertionPoint; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Converts the footnote to part of the story text and places the converted * text at the former location of the footnote marker in the text. */ convertToText(): Text; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TextVariableInstance[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the TextVariableInstance. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TextVariableInstance. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of text variable instances. */ declare class TextVariableInstances { /** Returns the TextVariableInstance with the specified index or name. */ [index: number]: TextVariableInstance; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a text variable instance at the specified location. * @param to The location relative to the reference object or within the containing object. (Optional) * @param reference The reference object. Note: Required only when the to parameter specifies before or after. Can accept: TextVariableInstance, XmlStory, TextFrame, EndnoteTextFrame, Story, Note, Cell, Footnote, Table, TextColumn, TextStyleRange, Text, InsertionPoint, Paragraph, Line, Word, Character or Change. (Optional) * @param withProperties Initial values for properties of the new TextVariableInstance (Optional) */ add(to?: LocationOptions, reference?: Cell | Character | EndnoteTextFrame | Footnote | InsertionPoint | Line | Note | Paragraph | Story | Table | Text | TextColumn | TextFrame | TextStyleRange | TextVariableInstance | Word | XmlStory | Change, withProperties?: Object): TextVariableInstance; /** * Returns any TextVariableInstance in the collection. */ anyItem(): TextVariableInstance; /** * Displays the number of elements in the TextVariableInstance. */ count(): number; /** * Returns every TextVariableInstance in the collection. */ everyItem(): TextVariableInstance; /** * Returns the first TextVariableInstance in the collection. */ firstItem(): TextVariableInstance; /** * Returns the TextVariableInstance with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): TextVariableInstance; /** * Returns the TextVariableInstance with the specified ID. * @param id The ID. */ itemByID(id: number): TextVariableInstance; /** * Returns the TextVariableInstance with the specified name. * @param name The name. */ itemByName(name: string): TextVariableInstance; /** * Returns the TextVariableInstances within the specified range. * @param from The TextVariableInstance, index, or name at the beginning of the range. Can accept: TextVariableInstance, Long Integer or String. * @param to The TextVariableInstance, index, or name at the end of the range. Can accept: TextVariableInstance, Long Integer or String. */ itemByRange(from: number | TextVariableInstance | string, to: number | TextVariableInstance | string): TextVariableInstance[]; /** * Returns the last TextVariableInstance in the collection. */ lastItem(): TextVariableInstance; /** * Returns the middle TextVariableInstance in the collection. */ middleItem(): TextVariableInstance; /** * Returns the TextVariableInstance whose index follows the specified * TextVariableInstance in the collection. * @param obj The TextVariableInstance whose index comes before the desired TextVariableInstance. */ nextItem(obj: TextVariableInstance): TextVariableInstance; /** * Returns the TextVariableInstance with the index previous to the specified * index. * @param obj The index of the TextVariableInstance that follows the desired TextVariableInstance. */ previousItem(obj: TextVariableInstance): TextVariableInstance; /** * Generates a string which, if executed, will return the TextVariableInstance. */ toSource(): string; } /** * A collection of text variables. */ declare class TextVariables { /** Returns the TextVariable with the specified index or name. */ [index: number]: TextVariable; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new TextVariable. * @param withProperties Initial values for properties of the new TextVariable (Optional) */ add(withProperties?: Object): TextVariable; /** * Returns any TextVariable in the collection. */ anyItem(): TextVariable; /** * Displays the number of elements in the TextVariable. */ count(): number; /** * Returns every TextVariable in the collection. */ everyItem(): TextVariable; /** * Returns the first TextVariable in the collection. */ firstItem(): TextVariable; /** * Returns the TextVariable with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): TextVariable; /** * Returns the TextVariable with the specified name. * @param name The name. */ itemByName(name: string): TextVariable; /** * Returns the TextVariables within the specified range. * @param from The TextVariable, index, or name at the beginning of the range. Can accept: TextVariable, Long Integer or String. * @param to The TextVariable, index, or name at the end of the range. Can accept: TextVariable, Long Integer or String. */ itemByRange(from: number | TextVariable | string, to: number | TextVariable | string): TextVariable[]; /** * Returns the last TextVariable in the collection. */ lastItem(): TextVariable; /** * Returns the middle TextVariable in the collection. */ middleItem(): TextVariable; /** * Returns the TextVariable whose index follows the specified TextVariable in * the collection. * @param obj The TextVariable whose index comes before the desired TextVariable. */ nextItem(obj: TextVariable): TextVariable; /** * Returns the TextVariable with the index previous to the specified index. * @param obj The index of the TextVariable that follows the desired TextVariable. */ previousItem(obj: TextVariable): TextVariable; /** * Generates a string which, if executed, will return the TextVariable. */ toSource(): string; } /** * Options for wrapping text around an object. */ declare enum TextWrapModes { /** * Wraps text around the object's bounding box. */ BOUNDING_BOX_TEXT_WRAP = 1651729523, /** * Wraps text around the object following the specified contour options. */ CONTOUR = 1835233134, /** * Forces text to jump above or below the object, so that no text appears on * the object's right or left. */ JUMP_OBJECT_TEXT_WRAP = 1650552420, /** * Forces text to jump to the next available column. */ NEXT_COLUMN_TEXT_WRAP = 1853384306, /** * No text wrap. */ NONE = 1852796517, } /** * Text wrap preferences. */ declare class TextWrapPreference extends Preference { /** * If true, text wraps on the master spread apply to that spread only, and not * to any pages the master spread has been applied to. */ applyToMasterPageOnly: boolean; /** * The contour of the text wrap. Valid only when when text wrap type is * contour. */ readonly contourOptions: ContourOption; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, inverts the text wrap. */ inverse: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the TextWrapPreference (a PageItem, HtmlItem, FlexObject, * FormField, SignatureField, TextBox, RadioButton, ListBox, ComboBox, * CheckBox, MultiStateObject, Button, MediaItem, Sound, Movie, EPSText, * SplineItem, Polygon, GraphicLine, Rectangle, Oval, Graphic, SVG, * ImportedPage, PICT, WMF, PDF, EPS, Image, Group, TextFrame, * EndnoteTextFrame, Application, Document or ObjectStyle). */ readonly parent: Application | Button | CheckBox | ComboBox | Document | EPS | EPSText | EndnoteTextFrame | FlexObject | FormField | Graphic | GraphicLine | Group | HtmlItem | Image | ImportedPage | ListBox | MediaItem | Movie | MultiStateObject | Oval | PDF | PICT | Polygon | RadioButton | Rectangle | SVG | SignatureField | Sound | SplineItem | TextBox | TextFrame | WMF | ObjectStyle | PageItem; /** * A collection of paths. */ readonly paths: Paths; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The text wrap mode. */ textWrapMode: TextWrapModes; /** * The minimum space between text and the edges of the wrapped object. The * format for defining text wrap offset values depends on the text wrap type. * If text wrap type is jump object text wrap, specify 2 values in the format * [top, bottom]. If text wrap type is next column text wrap or contour, * specify a single value. For bounding box text wrap, specify 4 values in the * format in the format [top, left, bottom, right]. . Can return: Unit, Array * of Units or NothingEnum enumerator. */ textWrapOffset: (number[] | number | NothingEnum)[]; /** * Text wrap side options. */ textWrapSide: TextWrapSideOptions; /** * If true, the text wrap path has been explicitly modified by the user. */ readonly userModifiedWrap: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TextWrapPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TextWrapPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Text wrap side options. */ declare enum TextWrapSideOptions { /** * Both sides text wrap. */ BOTH_SIDES = 1953981043, /** * Largest side text wrap. */ LARGEST_AREA = 1953975411, /** * Left side text wrap. */ LEFT_SIDE = 1953983603, /** * Right side text wrap. */ RIGHT_SIDE = 1953985139, /** * Away from binding side text wrap. */ SIDE_AWAY_FROM_SPINE = 1953980787, /** * Binding side text wrap. */ SIDE_TOWARDS_SPINE = 1953985651, } /** * A collection of text objects. */ declare class Texts { /** Returns the Text with the specified index or name. */ [index: number]: Text; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Text in the collection. */ anyItem(): Text; /** * Displays the number of elements in the Text. */ count(): number; /** * Returns every Text in the collection. */ everyItem(): Text; /** * Returns the first Text in the collection. */ firstItem(): Text; /** * Returns the Text with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Text; /** * Returns the Texts within the specified range. * @param from The Text, index, or name at the beginning of the range. Can accept: Text, Long Integer or String. * @param to The Text, index, or name at the end of the range. Can accept: Text, Long Integer or String. */ itemByRange(from: number | Text | string, to: number | Text | string): Text[]; /** * Returns the last Text in the collection. */ lastItem(): Text; /** * Returns the middle Text in the collection. */ middleItem(): Text; /** * Returns the Text whose index follows the specified Text in the collection. * @param obj The Text whose index comes before the desired Text. */ nextItem(obj: Text): Text; /** * Returns the Text with the index previous to the specified index. * @param obj The index of the Text that follows the desired Text. */ previousItem(obj: Text): Text; /** * Generates a string which, if executed, will return the Text. */ toSource(): string; } /** * Text to consider in case of threaded text frames. */ declare enum ThreadedTextFrameTextOptions { /** * Text for the complete story */ TEXT_FOR_COMPLETE_STORY = 1698911092, /** * Text within current text frame */ TEXT_WITHIN_TEXTFRAME = 1700021844, } /** * Options for the number of thumbnails per page. */ declare enum ThumbsPerPage { /** * Fits one row on the page; the row contains two thumbnails. */ K1X2 = 1949399090, /** * Fits two rows of two. */ K2X2 = 1949464626, /** * Fits three rows of three. */ K3X3 = 1949530163, /** * Fits four rows of four. */ K4X4 = 1949595700, /** * Fits five rows of five. */ K5X5 = 1949661237, /** * Fits six rows of six. */ K6X6 = 1949726774, /** * Fits seven rows of seven. */ K7X7 = 1949792311, } /** * Tiling type options. */ declare enum TilingTypes { /** * Automatically calculates the number of tiles required, including the * overlap. For information, see tiling overlap. */ AUTO = 1635019116, /** * Increases the amount of overlap as necessary so that the right sides of the * right-most tiles are aligned at the right edge of the document page, and the * bottom sides of the bottom-most tiles are aligned at the bottom edge of the * document page. For information, see tiling overlap. */ AUTO_JUSTIFIED = 1634366324, /** * Prints a single tile whose upper left corner is at the zero point of the * rulers. */ MANUAL = 1835955308, } /** * a timing group. */ declare class TimingGroup { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the TimingGroup within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the TimingGroup (a TimingList). */ readonly parent: TimingList; /** * The placement of the timing group in the timing list. */ placement: number; /** * The number of times this timing group plays. * @remarks Range: 1 to 100 */ plays: number; /** * Set to true if timing group loops. */ playsLoop: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of timing target. */ readonly timingTargets: TimingTargets; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TimingGroup[]; /** * Moves the timing group or target to the specified location. * @param to The location in relation to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. . Can accept: TimingGroup, TimingTarget or TimingList. (Optional) */ move(to: LocationOptions, reference?: TimingGroup | TimingTarget | TimingList): TimingGroup; /** * Deletes the TimingGroup. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TimingGroup. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Unlink all targets in the group into separate groups in this timing list. */ unlink(): void; } /** * A collection of timing data objects. */ declare class TimingGroups { /** Returns the TimingGroup with the specified index or name. */ [index: number]: TimingGroup; /** * The number of objects in the collection. */ readonly length: number; /** * Adds a new timing group. * @param dynamicTarget A page item target that is an animation, media, or mso. Can accept: PageItem, Graphic, Behavior or MediaItem. * @param delaySeconds The time delay in seconds for a target. (Optional) * @param withProperties Initial values for properties of the new TimingGroup (Optional) */ add(dynamicTarget: Behavior | Graphic | PageItem | MediaItem, delaySeconds?: number, withProperties?: Object): TimingGroup; /** * Returns any TimingGroup in the collection. */ anyItem(): TimingGroup; /** * Displays the number of elements in the TimingGroup. */ count(): number; /** * Returns every TimingGroup in the collection. */ everyItem(): TimingGroup; /** * Returns the first TimingGroup in the collection. */ firstItem(): TimingGroup; /** * Returns the TimingGroup with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): TimingGroup; /** * Returns the TimingGroups within the specified range. * @param from The TimingGroup, index, or name at the beginning of the range. Can accept: TimingGroup, Long Integer or String. * @param to The TimingGroup, index, or name at the end of the range. Can accept: TimingGroup, Long Integer or String. */ itemByRange(from: number | TimingGroup | string, to: number | TimingGroup | string): TimingGroup[]; /** * Returns the last TimingGroup in the collection. */ lastItem(): TimingGroup; /** * Returns the middle TimingGroup in the collection. */ middleItem(): TimingGroup; /** * Returns the TimingGroup whose index follows the specified TimingGroup in the * collection. * @param obj The TimingGroup whose index comes before the desired TimingGroup. */ nextItem(obj: TimingGroup): TimingGroup; /** * Returns the TimingGroup with the index previous to the specified index. * @param obj The index of the TimingGroup that follows the desired TimingGroup. */ previousItem(obj: TimingGroup): TimingGroup; /** * Generates a string which, if executed, will return the TimingGroup. */ toSource(): string; } /** * a timing list. */ declare class TimingList { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the TimingList within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the TimingList (a TimingSetting). */ readonly parent: TimingSetting; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of timing data objects. */ readonly timingGroups: TimingGroups; /** * trigger event. */ readonly triggerEvent: DynamicTriggerEvents; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TimingList[]; /** * Deletes the TimingList. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TimingList. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of timing lists. */ declare class TimingLists { /** Returns the TimingList with the specified index or name. */ [index: number]: TimingList; /** * The number of objects in the collection. */ readonly length: number; /** * Adds a new event-triggered timing list object. * @param triggerEvent Trigger Event * @param withProperties Initial values for properties of the new TimingList (Optional) */ add(triggerEvent: DynamicTriggerEvents, withProperties?: Object): TimingList; /** * Returns any TimingList in the collection. */ anyItem(): TimingList; /** * Displays the number of elements in the TimingList. */ count(): number; /** * Returns every TimingList in the collection. */ everyItem(): TimingList; /** * Returns the first TimingList in the collection. */ firstItem(): TimingList; /** * Returns the TimingList with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): TimingList; /** * Returns the TimingLists within the specified range. * @param from The TimingList, index, or name at the beginning of the range. Can accept: TimingList, Long Integer or String. * @param to The TimingList, index, or name at the end of the range. Can accept: TimingList, Long Integer or String. */ itemByRange(from: number | TimingList | string, to: number | TimingList | string): TimingList[]; /** * Returns the last TimingList in the collection. */ lastItem(): TimingList; /** * Returns the middle TimingList in the collection. */ middleItem(): TimingList; /** * Returns the TimingList whose index follows the specified TimingList in the * collection. * @param obj The TimingList whose index comes before the desired TimingList. */ nextItem(obj: TimingList): TimingList; /** * Returns the TimingList with the index previous to the specified index. * @param obj The index of the TimingList that follows the desired TimingList. */ previousItem(obj: TimingList): TimingList; /** * Generates a string which, if executed, will return the TimingList. */ toSource(): string; } /** * Timing settings. */ declare class TimingSetting extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the TimingSetting (a PageItem, HtmlItem, FlexObject, * FormField, SignatureField, TextBox, RadioButton, ListBox, ComboBox, * CheckBox, MultiStateObject, Button, MediaItem, Sound, Movie, EPSText, * SplineItem, Polygon, GraphicLine, Rectangle, Oval, Graphic, SVG, * ImportedPage, PICT, WMF, PDF, EPS, Image, Group, TextFrame, * EndnoteTextFrame, MasterSpread or Spread). */ readonly parent: Button | CheckBox | ComboBox | EPS | EPSText | EndnoteTextFrame | FlexObject | FormField | Graphic | GraphicLine | Group | HtmlItem | Image | ImportedPage | ListBox | MasterSpread | MediaItem | Movie | MultiStateObject | Oval | PDF | PICT | Polygon | RadioButton | Rectangle | SVG | SignatureField | Sound | SplineItem | TextBox | TextFrame | WMF | PageItem | Spread; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of timing lists. */ readonly timingLists: TimingLists; /** * Dynamic targets on the spread that are not assigned. */ readonly unassignedDynamicTargets: Object[]; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TimingSetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TimingSetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * a timing target. */ declare class TimingTarget { /** * The time delay in seconds for a single target or a group of targets after * the previoius group has finished. * @remarks Range: 0 to 60 */ delaySeconds: number; /** * A page item target that is an animation, media, or mso. Can return: * PageItem, Graphic, Behavior or MediaItem. */ dynamicTarget: Behavior | Graphic | PageItem | MediaItem; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the TimingTarget within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the TimingTarget (a TimingGroup). */ readonly parent: TimingGroup; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Set to true if reversing animation on rolloff. Valid only for self rolloff * trigger event. */ reverseAnimation: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TimingTarget[]; /** * Moves the timing group or target to the specified location. * @param to The location in relation to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. . Can accept: TimingGroup, TimingTarget or TimingList. (Optional) */ move(to: LocationOptions, reference?: TimingGroup | TimingTarget | TimingList): TimingTarget; /** * Deletes the TimingTarget. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TimingTarget. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Unlink target from this group and append to the end of this timing list. */ unlink(): void; } /** * A collection of timing target. */ declare class TimingTargets { /** Returns the TimingTarget with the specified index or name. */ [index: number]: TimingTarget; /** * The number of objects in the collection. */ readonly length: number; /** * Adds a new target item. * @param dynamicTarget A page item target that is an animation, media, or mso. Can accept: PageItem, Graphic, Behavior or MediaItem. * @param delaySeconds The time delay in seconds for a target. (Optional) * @param withProperties Initial values for properties of the new TimingTarget (Optional) */ add(dynamicTarget: Behavior | Graphic | PageItem | MediaItem, delaySeconds?: number, withProperties?: Object): TimingTarget; /** * Returns any TimingTarget in the collection. */ anyItem(): TimingTarget; /** * Displays the number of elements in the TimingTarget. */ count(): number; /** * Returns every TimingTarget in the collection. */ everyItem(): TimingTarget; /** * Returns the first TimingTarget in the collection. */ firstItem(): TimingTarget; /** * Returns the TimingTarget with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): TimingTarget; /** * Returns the TimingTargets within the specified range. * @param from The TimingTarget, index, or name at the beginning of the range. Can accept: TimingTarget, Long Integer or String. * @param to The TimingTarget, index, or name at the end of the range. Can accept: TimingTarget, Long Integer or String. */ itemByRange(from: number | TimingTarget | string, to: number | TimingTarget | string): TimingTarget[]; /** * Returns the last TimingTarget in the collection. */ lastItem(): TimingTarget; /** * Returns the middle TimingTarget in the collection. */ middleItem(): TimingTarget; /** * Returns the TimingTarget whose index follows the specified TimingTarget in * the collection. * @param obj The TimingTarget whose index comes before the desired TimingTarget. */ nextItem(obj: TimingTarget): TimingTarget; /** * Returns the TimingTarget with the index previous to the specified index. * @param obj The index of the TimingTarget that follows the desired TimingTarget. */ previousItem(obj: TimingTarget): TimingTarget; /** * Generates a string which, if executed, will return the TimingTarget. */ toSource(): string; } /** * A tint swatch. */ declare class Tint extends Color { /** * The color that the tint is based on. */ readonly baseColor: Color; /** * The ink values that create the color, specified as a percentage for each * ink. Note: The number of values required and the range depends on the color * space. For RGB, specify three values, with each value in the range 0 to 255; * for CMYK, specify four values representing C, M, Y, and K, with each value * in the range 0 to 100; for LAB, specify three values representing L (Range: * 0 to 100), A (Range: -128 to 127), and B (Range: -128 to 127); for mixed * ink, specify values for each ink in the ink list, with each value in the * range 0 to 100. * @remarks Range: 0 to 100 */ readonly colorValue: number[]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the Tint. */ readonly id: number; /** * The index of the Tint within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The color model. */ readonly model: ColorModel; /** * The name of the Tint. */ readonly name: string; /** * The parent of the Tint (a Application or Document). */ readonly parent: Application | Document; /** * The color group that a swatch belongs to */ readonly parentColorGroup: ColorGroup; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The color space. */ readonly space: ColorSpace; /** * The percent of the base color. (Range: 0 to 100) * @remarks Range: 0 to 100 */ tintValue: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the Tint. */ duplicate(): Tint; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Tint[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Merges the specified swatches with the swatch. * @param with_ The swatches to merge. Can accept: Array of Swatches, Swatch or String. */ merge(with_: (Swatches | Swatch | string)[]): Swatch; /** * Deletes the swatch. * @param replacingWith The swatch to apply in place of the deleted swatch. (Optional) */ remove(replacingWith?: Swatch): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Tint. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of tints. */ declare class Tints { /** Returns the Tint with the specified index or name. */ [index: number]: Tint; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new tint swatch. * @param baseColor The color that the tint is based upon. * @param withProperties Initial values for properties of the new Tint (Optional) */ add(baseColor: Color, withProperties?: Object): Tint; /** * Returns any Tint in the collection. */ anyItem(): Tint; /** * Displays the number of elements in the Tint. */ count(): number; /** * Returns every Tint in the collection. */ everyItem(): Tint; /** * Returns the first Tint in the collection. */ firstItem(): Tint; /** * Returns the Tint with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Tint; /** * Returns the Tint with the specified ID. * @param id The ID. */ itemByID(id: number): Tint; /** * Returns the Tint with the specified name. * @param name The name. */ itemByName(name: string): Tint; /** * Returns the Tints within the specified range. * @param from The Tint, index, or name at the beginning of the range. Can accept: Tint, Long Integer or String. * @param to The Tint, index, or name at the end of the range. Can accept: Tint, Long Integer or String. */ itemByRange(from: number | Tint | string, to: number | Tint | string): Tint[]; /** * Returns the last Tint in the collection. */ lastItem(): Tint; /** * Returns the middle Tint in the collection. */ middleItem(): Tint; /** * Returns the Tint whose index follows the specified Tint in the collection. * @param obj The Tint whose index comes before the desired Tint. */ nextItem(obj: Tint): Tint; /** * Returns the Tint with the index previous to the specified index. * @param obj The index of the Tint that follows the desired Tint. */ previousItem(obj: Tint): Tint; /** * Generates a string which, if executed, will return the Tint. */ toSource(): string; } /** * Tool box tools */ declare class ToolBox extends Preference { /** * The currently active tool. */ currentTool: UITools; /** * The currently active tool's hint. */ readonly currentToolHint: string; /** * The currently active tool's icon resource file. */ readonly currentToolIconFile: File; /** * The currently active tool's name. */ readonly currentToolName: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the ToolBox (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Dispatched when the value of a property changes on this ToolBox. This event * bubbles. This event is not cancelable. */ static readonly AFTER_ATTRIBUTE_CHANGED: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ToolBox[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ToolBox. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Tool tip behavior options. */ declare enum ToolTipOptions { /** * Displays tool tips more quickly than normal. */ FAST = 1180791668, /** * Turns off tool tips. */ NONE = 1852796517, /** * Displays tool tips. */ NORMAL = 1852797549, } /** * Options for Tools panel. */ declare enum ToolsPanelOptions { /** * Double column */ DOUBLE_COLUMN = 1162109804, /** * Single column */ SINGLE_COLUMN = 1163092844, /** * Single row */ SINGLE_ROW = 1163096695, } /** * An index topic. */ declare class Topic { /** * A collection of index cross references. (For cross references in text, use * the 'cross reference source' and 'hyperlink' objects.) */ readonly crossReferences: CrossReferences; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the Topic within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the Topic. */ name: string; /** * A collection of index page references. */ readonly pageReferences: PageReferences; /** * The parent of the Topic (a IndexSection, Topic or Index). */ readonly parent: Topic | Index_ | IndexSection; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The string by which the topic is sorted instead of the topic name is not * used. Note: The actual topic text, rather than the sort order text, appears * in the index. */ sortOrder: string; /** * A collection of index topics. */ readonly topics: Topics; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Makes the initial letter for the specified index topic or group of index * topics upper case. * @param capitalizationOption The entry or entries to capitalize. (Optional) */ capitalize(capitalizationOption?: IndexCapitalizationOptions): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Topic[]; /** * Deletes the Topic. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Topic. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of index topics. */ declare class Topics { /** Returns the Topic with the specified index or name. */ [index: number]: Topic; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new index topic. * @param name The name of the topic. Note: This is the text that appears in the index. * @param sortBy The string to sort this topic by instead of the topic name. Note: The actual topic text, rather than the sort order text, appears in the index. (Optional) * @param withProperties Initial values for properties of the new Topic (Optional) */ add(name: string, sortBy?: string, withProperties?: Object): Topic; /** * Returns any Topic in the collection. */ anyItem(): Topic; /** * Displays the number of elements in the Topic. */ count(): number; /** * Returns every Topic in the collection. */ everyItem(): Topic; /** * Returns the first Topic in the collection. */ firstItem(): Topic; /** * Returns the Topic with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Topic; /** * Returns the Topic with the specified name. * @param name The name. */ itemByName(name: string): Topic; /** * Returns the Topics within the specified range. * @param from The Topic, index, or name at the beginning of the range. Can accept: Topic, Long Integer or String. * @param to The Topic, index, or name at the end of the range. Can accept: Topic, Long Integer or String. */ itemByRange(from: number | Topic | string, to: number | Topic | string): Topic[]; /** * Returns the last Topic in the collection. */ lastItem(): Topic; /** * Returns the middle Topic in the collection. */ middleItem(): Topic; /** * Returns the Topic whose index follows the specified Topic in the collection. * @param obj The Topic whose index comes before the desired Topic. */ nextItem(obj: Topic): Topic; /** * Returns the Topic with the index previous to the specified index. * @param obj The index of the Topic that follows the desired Topic. */ previousItem(obj: Topic): Topic; /** * Generates a string which, if executed, will return the Topic. */ toSource(): string; } /** * Track changes preferences. */ declare class TrackChangesPreference extends Preference { /** * The background color option for added text. */ addedBackgroundColorChoice: ChangeBackgroundColorChoices; /** * The color option for added text. */ addedTextColorChoice: ChangeTextColorChoices; /** * The background color for added text, specified as an InCopy UI color. Note: * Valid only when added background color choice is change background uses * change pref color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors * enumerator. */ backgroundColorForAddedText: (number[][] | InCopyUIColors)[]; /** * The background color for deleted text, specified as an InCopy UI color. * Note: Valid only when deleted background color choice is change background * uses change pref color. Can return: Array of 3 Reals (0 - 255) or * InCopyUIColors enumerator. */ backgroundColorForDeletedText: (number[][] | InCopyUIColors)[]; /** * The background color for moved text, specified as an InCopy UI color. Note: * Valid only when moved background color choice is change background uses * change pref color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors * enumerator. */ backgroundColorForMovedText: (number[][] | InCopyUIColors)[]; /** * The change bar color, specified as an InCopy UI color. Can return: Array of * 3 Reals (0 - 255) or InCopyUIColors enumerator. */ changeBarColor: (number[][] | InCopyUIColors)[]; /** * The background color option for deleted text. */ deletedBackgroundColorChoice: ChangeBackgroundColorChoices; /** * The color option for deleted text. */ deletedTextColorChoice: ChangeTextColorChoices; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The change bar location. */ locationForChangeBar: ChangebarLocations; /** * The marking that identifies added text. */ markingForAddedText: ChangeMarkings; /** * The marking that identifies deleted text. */ markingForDeletedText: ChangeMarkings; /** * The marking that identifies moved text. */ markingForMovedText: ChangeMarkings; /** * The background color option for moved text. */ movedBackgroundColorChoice: ChangeBackgroundColorChoices; /** * The color option for moved text. */ movedTextColorChoice: ChangeTextColorChoices; /** * The parent of the TrackChangesPreference (a Application). */ readonly parent: Application; /** * If true, prevent duplicate user color for tracked changes background color. */ preventDuplicateColor: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, displays added text. */ showAddedText: boolean; /** * If true, displays change bars, */ showChangeBars: boolean; /** * If true, displays deleted text. */ showDeletedText: boolean; /** * If true, displays moved text. */ showMovedText: boolean; /** * If true, includes deleted text when using the Spell Check command. */ spellCheckDeletedText: boolean; /** * The color for added text, specified as an InCopy UI color. Note: Valid only * when added text color choice is change uses change pref color. Can return: * Array of 3 Reals (0 - 255) or InCopyUIColors enumerator. */ textColorForAddedText: (number[][] | InCopyUIColors)[]; /** * The color for deleted text, specified as an InCopy UI color. Note: Valid * only when deleted text color choice is change uses change pref color. Can * return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator. */ textColorForDeletedText: (number[][] | InCopyUIColors)[]; /** * The color for moved text, specified as an InCopy UI color. Note: Valid only * when moved text color choice is change uses change pref color. Can return: * Array of 3 Reals (0 - 255) or InCopyUIColors enumerator. */ textColorForMovedText: (number[][] | InCopyUIColors)[]; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TrackChangesPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * TrackChangesPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for applying layout attributes to any page item. */ declare class TransformAttributeOption extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the TransformAttributeOption (a ObjectStyle). */ readonly parent: ObjectStyle; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The height of the object, defined by the object style. * @remarks Measurement unit — also accepts a string such as "12mm". */ transformAttrHeight: number | string; /** * The reference point to be used while setting the X attribute of object * style. */ transformAttrLeftReference: TransformPositionReference; /** * Option to specify the achor point to be used by the style for anchoring the * object while applying the position. */ transformAttrRefAnchorPoint: AnchorPoint; /** * The reference point to be used while setting the Y attribute of object * style. */ transformAttrTopReference: TransformPositionReference; /** * The width of the object, defined by the object style. * @remarks Measurement unit — also accepts a string such as "12mm". */ transformAttrWidth: number | string; /** * The left position of the object, defined by the object style. * @remarks Measurement unit — also accepts a string such as "12mm". */ transformAttrX: number | string; /** * The top position of the object, defined by the object style. * @remarks Measurement unit — also accepts a string such as "12mm". */ transformAttrY: number | string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TransformAttributeOption[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * TransformAttributeOption. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for specifying the reference position for X and Y attributes of * style. If set none, it will disable the attribute. */ declare enum TransformPositionReference { /** * Corresponding edge of the page. Left edge for X attribute, Top edge for Y * attribute. */ PAGE_EDGE_REFERENCE = 1348945255, /** * Corresponding page margin of the page. Left margin for X attribute, Top * margin for Y attribute. */ PAGE_MARGIN_REFERENCE = 1883721063, } /** * Transform preferences. */ declare class TransformPreference extends Preference { /** * If true, transparency effects are scaled when objects are scaled. */ adjustEffectsWhenScaling: boolean; /** * If true, strokes are scaled when objects are scaled. */ adjustStrokeWeightWhenScaling: boolean; /** * If true, includes the stroke weight when displaying object dimensions. If * false, measures objects from the path or frame. */ dimensionsIncludeStrokeWeight: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the TransformPreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, measures the x and y values of the object relative to the * containing frame. If false, measures the x and y values relative to the * rulers. */ showContentOffset: boolean; /** * If true, transformation values are relative to the parent object. If false, * the transformation values are absolute values. */ transformationsAreTotals: boolean; /** * The method used to scale a page item. */ whenScaling: WhenScalingOptions; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TransformPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TransformPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of transformation matrices. */ declare class TransformationMatrices { /** Returns the TransformationMatrix with the specified index or name. */ [index: number]: TransformationMatrix; /** * The number of objects in the collection. */ readonly length: number; /** * Create a new TransformationMatrix. * @param horizontalScaleFactor The horizontal scale factor of the transformation matrix (Optional) * @param verticalScaleFactor The vertical scale factor of the transformation matrix (Optional) * @param clockwiseShearAngle The shear angle of the transformation matrix (Optional) * @param counterclockwiseRotationAngle The rotation angle of the transformation matrix (Optional) * @param horizontalTranslation The horizontal translation of the transformation matrix (Optional) * @param verticalTranslation The vertical translation of the transformation matrix (Optional) * @param matrixValues The values of the transformation matrix (Optional) * @param matrixMapping The mapping the transformation matrix performs on the unit triangle. Can accept: Array of Array of 2 Arrays of 2 Reals. (Optional) * @param withProperties Initial values for properties of the new TransformationMatrix (Optional) */ add(horizontalScaleFactor?: number, verticalScaleFactor?: number, clockwiseShearAngle?: number, counterclockwiseRotationAngle?: number, horizontalTranslation?: number, verticalTranslation?: number, matrixValues?: number[], matrixMapping?: number[][][][], withProperties?: Object): TransformationMatrix; /** * Returns any TransformationMatrix in the collection. */ anyItem(): TransformationMatrix; /** * Displays the number of elements in the TransformationMatrix. */ count(): number; /** * Returns every TransformationMatrix in the collection. */ everyItem(): TransformationMatrix; /** * Returns the first TransformationMatrix in the collection. */ firstItem(): TransformationMatrix; /** * Returns the TransformationMatrix with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): TransformationMatrix; /** * Returns the TransformationMatrix with the specified name. * @param name The name. */ itemByName(name: string): TransformationMatrix; /** * Returns the TransformationMatrices within the specified range. * @param from The TransformationMatrix, index, or name at the beginning of the range. Can accept: TransformationMatrix, Long Integer or String. * @param to The TransformationMatrix, index, or name at the end of the range. Can accept: TransformationMatrix, Long Integer or String. */ itemByRange(from: number | TransformationMatrix | string, to: number | TransformationMatrix | string): TransformationMatrix[]; /** * Returns the last TransformationMatrix in the collection. */ lastItem(): TransformationMatrix; /** * Returns the middle TransformationMatrix in the collection. */ middleItem(): TransformationMatrix; /** * Returns the TransformationMatrix whose index follows the specified * TransformationMatrix in the collection. * @param obj The TransformationMatrix whose index comes before the desired TransformationMatrix. */ nextItem(obj: TransformationMatrix): TransformationMatrix; /** * Returns the TransformationMatrix with the index previous to the specified * index. * @param obj The index of the TransformationMatrix that follows the desired TransformationMatrix. */ previousItem(obj: TransformationMatrix): TransformationMatrix; /** * Generates a string which, if executed, will return the TransformationMatrix. */ toSource(): string; } /** * A transformation matrix. */ declare class TransformationMatrix { /** * The shear angle of the transformation matrix. */ readonly clockwiseShearAngle: number; /** * The rotation angle of the transformation matrix. */ readonly counterclockwiseRotationAngle: number; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The horizontal scale factor of the transformation matrix. */ readonly horizontalScaleFactor: number; /** * The horizontal translation of the transformation matrix. */ readonly horizontalTranslation: number; /** * The index of the TransformationMatrix within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The mapping the transformation matrix performs on the unit triangle. Can * return: Array of Array of 2 Arrays of 2 Reals. */ readonly matrixMapping: number[][][][]; /** * The values of the transformation matrix. */ readonly matrixValues: number[]; /** * The name of the TransformationMatrix. */ readonly name: string; /** * The parent of the TransformationMatrix (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The vertical scale factor of the transformation matrix. */ readonly verticalScaleFactor: number; /** * The vertical translation of the transformation matrix. */ readonly verticalTranslation: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Multiply the transformation matrix by another. * @param withMatrix The right hand matrix factor */ catenateMatrix(withMatrix: TransformationMatrix): TransformationMatrix; /** * Multiply the point by the matrix. * @param point The point to transform */ changeCoordinates(point: number[]): number[]; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TransformationMatrix[]; /** * Invert the transformation matrix. */ invertMatrix(): TransformationMatrix; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Rotate the transformation matrix. * @param byAngle The counterclockwise rotation angle (Optional) * @param byCosine The cosine of the desired rotation (Optional) * @param bySine The sine of the desired rotation (Optional) */ rotateMatrix(byAngle?: number, byCosine?: number, bySine?: number): TransformationMatrix; /** * Scale the transformation matrix. * @param horizontallyBy The horizontal scale factor (Optional) * @param verticallyBy The vertical scale factor (Optional) */ scaleMatrix(horizontallyBy?: number, verticallyBy?: number): TransformationMatrix; /** * Shear the transformation matrix. * @param byAngle The horizontal shear angle (Optional) * @param bySlope The horizontal shear slope (Optional) */ shearMatrix(byAngle?: number, bySlope?: number): TransformationMatrix; /** * Generates a string which, if executed, will return the TransformationMatrix. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Translate the transformation matrix. * @param horizontallyBy The horizontal translation distance (Optional) * @param verticallyBy The vertical translation distance (Optional) */ translateMatrix(horizontallyBy?: number, verticallyBy?: number): TransformationMatrix; } /** * Transparency preferences. */ declare class TransparencyPreference extends Preference { /** * The color space used for blending the colors of transparent objects. */ blendingSpace: BlendingSpace; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The altitude of the global light. (Range: 0 to 90) * @remarks Range: 0 to 100 */ globalLightAltitude: number; /** * The angle of the global light. (Range: -360 to 360) * @remarks Range: -180 to 180 */ globalLightAngle: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the TransparencyPreference (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TransparencyPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * TransparencyPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Transparency settings. */ declare class TransparencySetting extends Preference { /** * Settings related to the bevel and emboss effect. */ readonly bevelAndEmbossSettings: BevelAndEmbossSetting; /** * Blending mode settings. */ readonly blendingSettings: BlendingSetting; /** * Settings related to the directional feather effect. */ readonly directionalFeatherSettings: DirectionalFeatherSetting; /** * Settings related to the drop shadow effect. */ readonly dropShadowSettings: DropShadowSetting; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Settings related to the feather effect. */ readonly featherSettings: FeatherSetting; /** * Settings related to the gradient feather effect. */ readonly gradientFeatherSettings: GradientFeatherSetting; /** * Settings related to the inner glow effect. */ readonly innerGlowSettings: InnerGlowSetting; /** * Settings related to the inner shadow effect. */ readonly innerShadowSettings: InnerShadowSetting; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * Settings related to the outer glow effect. */ readonly outerGlowSettings: OuterGlowSetting; /** * The parent of the TransparencySetting (a PageItem, HtmlItem, FlexObject, * FormField, SignatureField, TextBox, RadioButton, ListBox, ComboBox, * CheckBox, MultiStateObject, Button, MediaItem, Sound, Movie, EPSText, * SplineItem, Polygon, GraphicLine, Rectangle, Oval, Graphic, SVG, * ImportedPage, PICT, WMF, PDF, EPS, Image, Group, TextFrame, * EndnoteTextFrame, PageItemDefault or ObjectStyle). */ readonly parent: Button | CheckBox | ComboBox | EPS | EPSText | EndnoteTextFrame | FlexObject | FormField | Graphic | GraphicLine | Group | HtmlItem | Image | ImportedPage | ListBox | MediaItem | Movie | MultiStateObject | Oval | PDF | PICT | PageItemDefault | Polygon | RadioButton | Rectangle | SVG | SignatureField | Sound | SplineItem | TextBox | TextFrame | WMF | ObjectStyle | PageItem; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Settings related to the satin effect */ readonly satinSettings: SatinSetting; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TransparencySetting[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TransparencySetting. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Shape options for the intersection of three-way traps. */ declare enum TrapEndTypes { /** * Shapes the end of the trap to keep it away from the intersecting object. */ MITER_TRAP_ENDS = 1953525093, /** * Reshapes the trap generated by the lightest neutral density object so that * it wraps around the point where the three objects intersect. */ OVERLAP_TRAP_ENDS = 1953525612, } /** * Options for trap placement between vector objects and bitmap images. */ declare enum TrapImagePlacementTypes { /** * Creates a trap that straddles the edge between vector objects and bitmap * images. */ CENTER_EDGES = 1953522542, /** * Causes vector objects to overlap abutting images. */ CHOKE = 1953522536, /** * Causes bitmap images to overlap the abutting objects. */ IMAGES_OVER_SPREAD = 1953526640, /** * Applies the same trapping rules as used elsewhere in the document. Note: * When used to trap an object to a photograph, can result in noticeably uneven * edges as the trap moves from one side of the edge to another. */ IMAGE_NEUTRAL_DENSITY = 1953525348, } /** * A trap preset. */ declare class TrapPreset { /** * The minimum amount (as a percentage) of black ink required before the black * width setting is applied. (Range: 0 to 100) * @remarks Range: 0 to 100 */ blackColorThreshold: number; /** * The neutral density value at or above which an ink is considered black. * (Range: .001 to 10) * @remarks Range: 0 to 10 */ blackDensity: number; /** * The black width. (Range depends on unit. For points: 0.0 to 8.0; picas: 0p0 * to 0p8; inches: 0 to 0.1111; mm: 0 to 2.822; cm: 0 to .2822; ciceros: 0c0 to * 0c7.507) * @remarks Measurement unit — also accepts a string such as "12mm". */ blackWidth: number | string; /** * The degree (as a percentage) to which components from abutting colors are * used to reduce the trap color. (Range: 0 to 100) Note: 0% makes a trap whose * neutral density is equal to the neutral density of the darker color. * @remarks Range: 0 to 100 */ colorReduction: number; /** * The default width for trapping all colors except those involving solid * black. (Range depends on unit. For points: 0.0 to 8.0; picas: 0p0 to 0p8; * inches: 0 to 0.1111; mm: 0 to 2.822; cm: 0 to .2822; ciceros: 0c0 to * 0c7.507) * @remarks Measurement unit — also accepts a string such as "12mm". */ defaultTrapWidth: number | string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the TrapPreset. */ readonly id: number; /** * The trap placement between vector objects and bitmap images. */ imagePlacement: TrapImagePlacementTypes; /** * If true, turns on trapping along the boundary of overlapping or abutting * bitmap images. */ imagesToImages: boolean; /** * The index of the TrapPreset within its containing object. */ readonly index: number; /** * If true, turns on trapping among colors within individual bitmap images. */ internalImages: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the TrapPreset. */ name: string; /** * If true, ensures that vector objects overlap bitmap images. */ objectsToImages: boolean; /** * If true, ensures that one-bit images trap to abutting objects. */ oneBitImages: boolean; /** * The parent of the TrapPreset (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The difference (as a percentage) between the neutral densities of abutting * colors at which the trap is moved from the darker side of a color edge * toward the centerline. (Range: 0 to 100) * @remarks Range: 0 to 100 */ slidingTrapThreshold: number; /** * The amount (as a percentage) that components of abutting colors must vary * before a trap is created. (Range: 1 to 100) * @remarks Range: 1 to 100 */ stepThreshold: number; /** * The shape to use at the intersection of three-way traps. */ trapEnd: TrapEndTypes; /** * The join type of the trap preset. */ trapJoin: EndJoin; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the TrapPreset. */ duplicate(): TrapPreset; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TrapPreset[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the trap preset. * @param replacingWith The trap preset to apply in place of the deleted preset. */ remove(replacingWith: TrapPreset): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the TrapPreset. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of trap presets. */ declare class TrapPresets { /** Returns the TrapPreset with the specified index or name. */ [index: number]: TrapPreset; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new TrapPreset. * @param withProperties Initial values for properties of the new TrapPreset (Optional) */ add(withProperties?: Object): TrapPreset; /** * Returns any TrapPreset in the collection. */ anyItem(): TrapPreset; /** * Displays the number of elements in the TrapPreset. */ count(): number; /** * Returns every TrapPreset in the collection. */ everyItem(): TrapPreset; /** * Returns the first TrapPreset in the collection. */ firstItem(): TrapPreset; /** * Returns the TrapPreset with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): TrapPreset; /** * Returns the TrapPreset with the specified ID. * @param id The ID. */ itemByID(id: number): TrapPreset; /** * Returns the TrapPreset with the specified name. * @param name The name. */ itemByName(name: string): TrapPreset; /** * Returns the TrapPresets within the specified range. * @param from The TrapPreset, index, or name at the beginning of the range. Can accept: TrapPreset, Long Integer or String. * @param to The TrapPreset, index, or name at the end of the range. Can accept: TrapPreset, Long Integer or String. */ itemByRange(from: number | TrapPreset | string, to: number | TrapPreset | string): TrapPreset[]; /** * Returns the last TrapPreset in the collection. */ lastItem(): TrapPreset; /** * Returns the middle TrapPreset in the collection. */ middleItem(): TrapPreset; /** * Returns the TrapPreset whose index follows the specified TrapPreset in the * collection. * @param obj The TrapPreset whose index comes before the desired TrapPreset. */ nextItem(obj: TrapPreset): TrapPreset; /** * Returns the TrapPreset with the index previous to the specified index. * @param obj The index of the TrapPreset that follows the desired TrapPreset. */ previousItem(obj: TrapPreset): TrapPreset; /** * Generates a string which, if executed, will return the TrapPreset. */ toSource(): string; } /** * Trapping options. */ declare enum Trapping { /** * Adobe in-RIP. */ ADOBE_INRIP = 1919512660, /** * Application built-in. */ APPLICATION_BUILTIN = 1114199152, /** * No trapping. */ OFF = 1330005536, } /** * Type Contextual UI Preference. */ declare class TypeContextualUiPreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the TypeContextualUiPreference (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Preference for showing contextual ui for alternates. */ showAlternatesUi: boolean; /** * Preference for showing contextual ui for fractions. */ showFractionsUi: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): TypeContextualUiPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * TypeContextualUiPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Standard UI colors. */ declare enum UIColors { /** * Black. */ BLACK = 1765960811, /** * Blue. */ BLUE = 1765960821, /** * Brick red. */ BRICK_RED = 1765962340, /** * Brown. */ BROWN = 1765962350, /** * Burgundy. */ BURGUNDY = 1765962343, /** * Charcoal. */ CHARCOAL = 1766025324, /** * Cute teal. */ CUTE_TEAL = 1766028396, /** * Cyan. */ CYAN = 1766029678, /** * Dark blue. */ DARK_BLUE = 1766089324, /** * Dark green. */ DARK_GREEN = 1766090610, /** * Fiesta. */ FIESTA = 1766222181, /** * Gold. */ GOLD = 1766288484, /** * Grass green. */ GRASS_GREEN = 1766287218, /** * Gray. */ GRAY = 1766290041, /** * Green. */ GREEN = 1766290030, /** * Grid blue. */ GRID_BLUE = 1766285932, /** * Grid green. */ GRID_GREEN = 1766286439, /** * Grid orange. */ GRID_ORANGE = 1766289266, /** * Lavender. */ LAVENDER = 1766618734, /** * Light blue. */ LIGHT_BLUE = 1766613612, /** * Light gray. */ LIGHT_GRAY = 1766614898, /** * Light olive. */ LIGHT_OLIVE = 1766616940, /** * Lipstick. */ LIPSTICK = 1766615408, /** * Magenta. */ MAGENTA = 1766680430, /** * Ochre. */ OCHRE = 1766810482, /** * Olive green. */ OLIVE_GREEN = 1766812790, /** * Orange. */ ORANGE = 1766814318, /** * Peach. */ PEACH = 1766876008, /** * Pink. */ PINK = 1766878827, /** * Purple. */ PURPLE = 1766879856, /** * Red. */ RED = 1767007588, /** * Sulphur. */ SULPHUR = 1767077228, /** * Tan. */ TAN = 1767137646, /** * Teal. */ TEAL = 1767138668, /** * Violet. */ VIOLET = 1767271540, /** * White. */ WHITE = 1767336052, /** * Yellow. */ YELLOW = 1767468151, } /** * The enumeration of tool box tools. */ declare enum UITools { /** * The add anchor point tool */ ADD_ANCHOR_POINT = 1633767540, /** * The convert direction point tool */ CONVERT_DIRECTION_POINT = 1667518580, /** * The delete anchor point tool */ DELETE_ANCHOR_POINT = 1684099188, /** * The direct selection tool */ DIRECT_SELECTION_TOOL = 1685277812, /** * The ellipse frame tool */ ELLIPSE_FRAME_TOOL = 1701205100, /** * The ellipse tool */ ELLIPSE_TOOL = 1701598316, /** * The erase tool */ ERASE_TOOL = 1701991269, /** * The eye dropper tool */ EYE_DROPPER_TOOL = 1701074028, /** * The free transform tool */ FREE_TRANSFORM_TOOL = 1718899820, /** * The gap tool */ GAP_TOOL = 1734430836, /** * The gradient feather tool */ GRADIENT_FEATHER_TOOL = 1734759532, /** * The gradient swatch tool */ GRADIENT_SWATCH_TOOL = 1735611500, /** * The hand tool */ HAND_TOOL = 1751209068, /** * The line tool */ LINE_TOOL = 1819169900, /** * The measure tool */ MEASURE_TOOL = 1835357292, /** * The motion path tool */ MOTION_PATH_TOOL = 1836078188, /** * No selection */ NONE = 1852796517, /** * The note tool */ NOTE_TOOL = 1852789868, /** * The page tool */ PAGE_TOOL = 1936741484, /** * The pencil tool */ PENCIL_TOOL = 1886274412, /** * The pen tool */ PEN_TOOL = 1885687412, /** * The place cursor tool which gets set after an import via the Place command */ PLACE_CURSOR_TOOL = 1885557868, /** * The polygon frame tool */ POLYGON_FRAME_TOOL = 1885754476, /** * The polygon tool */ POLYGON_TOOL = 1886147692, /** * The rectangle frame tool */ RECTANGLE_FRAME_TOOL = 1919308908, /** * The rectangle tool */ RECTANGLE_TOOL = 1919243372, /** * The rotate tool */ ROTATE_TOOL = 1919898732, /** * The scale tool */ SCALE_TOOL = 1935889516, /** * The scissors tool */ SCISSORS_TOOL = 1935891060, /** * The selection tool */ SELECTION_TOOL = 1936018548, /** * The shear tool */ SHEAR_TOOL = 1936217196, /** * The smooth tool */ SMOOTH_TOOL = 1936544872, /** * The table creation tool */ TABLE_TOOL = 1952601196, /** * The type on a path tool */ TYPE_ON_PATH_TOOL = 1953452148, /** * The type tool */ TYPE_TOOL = 1954107508, /** * The zoom tool */ ZOOM_TOOL = 2053985388, } /** * Undo options for executing a script. */ declare enum UndoModes { /** * Automatically undo the entire script as part of the previous step. */ AUTO_UNDO = 1699963221, /** * Undo the entire script as a single step. */ ENTIRE_SCRIPT = 1699963733, /** * Fast undo the entire script as a single step. */ FAST_ENTIRE_SCRIPT = 1699964501, /** * Undo each script request as a separate step. */ SCRIPT_REQUEST = 1699967573, } /** * Represents a measurement as a combination of values and unit. */ declare class UnitValue { /** * The base unit for all conversions. */ static baseUnit: UnitValue; /** * The base unit. */ baseUnit: UnitValue; /** * The unit name. */ readonly type: string; /** * The numeric value. */ value: number; /** * Returns this instance as a different unit. * @param unitName The unit name. */ as(unitName: string): UnitValue; /** * Converts this instance to a different unit. * @param unitName The unit name. */ convert(unitName: string): any; } /** * Link updating options. */ declare enum UpdateLinkOptions { /** * Changes the visiblity settings to match the modified file. */ APPLICATION_SETTINGS = 1819243873, /** * Ignores the modified settings and maintains those specified in the current * document. */ KEEP_OVERRIDES = 1819241327, /** * Unspecified update option. */ UNKNOWN = 1433299822, } /** * Use SVG As Enum */ declare enum UseSVGAsEnum { /** * SVG will be exported as embed code */ EMBED_CODE = 1701667427, /** * SVG will be exported as image tags */ IMAGE_TAGS = 1768780903, /** * SVG will be exported as object tags */ OBJECT_TAGS = 1868720756, } /** * A collection of user dictionaries. */ declare class UserDictionaries { /** Returns the UserDictionary with the specified index or name. */ [index: number]: UserDictionary; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any UserDictionary in the collection. */ anyItem(): UserDictionary; /** * Displays the number of elements in the UserDictionary. */ count(): number; /** * Returns every UserDictionary in the collection. */ everyItem(): UserDictionary; /** * Returns the first UserDictionary in the collection. */ firstItem(): UserDictionary; /** * Returns the UserDictionary with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): UserDictionary; /** * Returns the UserDictionary with the specified name. * @param name The name. */ itemByName(name: string): UserDictionary; /** * Returns the UserDictionaries within the specified range. * @param from The UserDictionary, index, or name at the beginning of the range. Can accept: UserDictionary, Long Integer or String. * @param to The UserDictionary, index, or name at the end of the range. Can accept: UserDictionary, Long Integer or String. */ itemByRange(from: number | UserDictionary | string, to: number | UserDictionary | string): UserDictionary[]; /** * Returns the last UserDictionary in the collection. */ lastItem(): UserDictionary; /** * Returns the middle UserDictionary in the collection. */ middleItem(): UserDictionary; /** * Returns the UserDictionary whose index follows the specified UserDictionary * in the collection. * @param obj The UserDictionary whose index comes before the desired UserDictionary. */ nextItem(obj: UserDictionary): UserDictionary; /** * Returns the UserDictionary with the index previous to the specified index. * @param obj The index of the UserDictionary that follows the desired UserDictionary. */ previousItem(obj: UserDictionary): UserDictionary; /** * Generates a string which, if executed, will return the UserDictionary. */ toSource(): string; } /** * A user dictionary. */ declare class UserDictionary { /** * A list of words added to the user dictionary. */ addedWords: string[]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the UserDictionary within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the UserDictionary. */ readonly name: string; /** * The parent of the UserDictionary (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A list of words removed from the user dictionary. */ removedWords: string[]; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Adds the specified words to the specified list in the dictionary. * @param addedWords The words to add. * @param removedList If true, adds the words to the removed words list. If false or unspecified, adds the words to the added words list. (Optional) */ addWord(addedWords: string[], removedList?: boolean): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): UserDictionary[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the specified words from the specified list in the dictionary. * @param removedWords The words to remove. * @param removedList If true, removes the words from the removed words list. If false or unspecified, removes the words from the added words list. (Optional) */ removeWord(removedWords: string[], removedList?: boolean): void; /** * Generates a string which, if executed, will return the UserDictionary. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * User interaction level options. */ declare enum UserInteractionLevels { /** * Displays alerts but not dialogs. */ INTERACT_WITH_ALERTS = 1699311170, /** * The script displays all dialogs and alerts. */ INTERACT_WITH_ALL = 1699311169, /** * The script does not display any dialogs or alerts. */ NEVER_INTERACT = 1699640946, } /** * An XML validation error. */ declare class ValidationError { /** * The attribute name if the validation error refers to an attribute. */ readonly attributeName: string; /** * The element that caused the validation error. */ readonly element: XMLElement; /** * The validation error message. */ readonly errorMessage: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the ValidationError within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the ValidationError (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ValidationError[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ValidationError. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of XML validation errors. */ declare class ValidationErrors { /** Returns the ValidationError with the specified index or name. */ [index: number]: ValidationError; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any ValidationError in the collection. */ anyItem(): ValidationError; /** * Displays the number of elements in the ValidationError. */ count(): number; /** * Returns every ValidationError in the collection. */ everyItem(): ValidationError; /** * Returns the first ValidationError in the collection. */ firstItem(): ValidationError; /** * Returns the ValidationError with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): ValidationError; /** * Returns the ValidationErrors within the specified range. * @param from The ValidationError, index, or name at the beginning of the range. Can accept: ValidationError, Long Integer or String. * @param to The ValidationError, index, or name at the end of the range. Can accept: ValidationError, Long Integer or String. */ itemByRange(from: number | ValidationError | string, to: number | ValidationError | string): ValidationError[]; /** * Returns the last ValidationError in the collection. */ lastItem(): ValidationError; /** * Returns the middle ValidationError in the collection. */ middleItem(): ValidationError; /** * Returns the ValidationError whose index follows the specified * ValidationError in the collection. * @param obj The ValidationError whose index comes before the desired ValidationError. */ nextItem(obj: ValidationError): ValidationError; /** * Returns the ValidationError with the index previous to the specified index. * @param obj The index of the ValidationError that follows the desired ValidationError. */ previousItem(obj: ValidationError): ValidationError; /** * Generates a string which, if executed, will return the ValidationError. */ toSource(): string; } /** * Number variable numbering styles. */ declare enum VariableNumberingStyles { /** * Arabic numerals. */ ARABIC = 1298231906, /** * Current */ CURRENT = 1298363762, /** * Double leading zeros. */ DOUBLE_LEADING_ZEROS = 1296329850, /** * Full-width Arabic numerals. */ FULL_WIDTH_ARABIC = 1296455521, /** * Kanji. */ KANJI = 1296788073, /** * Lowercase letters. */ LOWER_LETTERS = 1296855660, /** * Lowercase Roman numerals. */ LOWER_ROMAN = 1297247596, /** * Single leading zero. */ SINGLE_LEADING_ZEROS = 1297312890, /** * Uppercase letters. */ UPPER_LETTERS = 1296855669, /** * Uppercase Roman numerals. */ UPPER_ROMAN = 1297247605, } /** * Scopes for page number variable. */ declare enum VariableScopes { /** * The scope is limited to the current document. */ DOCUMENT_SCOPE = 1129538671, /** * The scope is limited to the current section. */ SECTION_SCOPE = 1129542501, } /** * Text variable types. */ declare enum VariableTypes { /** * Chapter number variable. */ CHAPTER_NUMBER_TYPE = 1668183152, /** * Creation date variable. */ CREATION_DATE_TYPE = 1414947684, /** * Custom text variable. */ CUSTOM_TEXT_TYPE = 1414947700, /** * File name variable. */ FILE_NAME_TYPE = 1414948462, /** * Last page number variable. */ LAST_PAGE_NUMBER_TYPE = 1414952048, /** * Live Caption variable. */ LIVE_CAPTION_TYPE = 1414947693, /** * Running header (character style) variable. */ MATCH_CHARACTER_STYLE_TYPE = 1414947667, /** * Running header (paragraph style) variable. */ MATCH_PARAGRAPH_STYLE_TYPE = 1414950995, /** * Modification date variable. */ MODIFICATION_DATE_TYPE = 1414950244, /** * Output date variable. */ OUTPUT_DATE_TYPE = 1414950756, /** * Private cross reference chapter number variable. */ XREF_CHAPTER_NUMBER_TYPE = 1414947694, /** * Private cross reference page number variable. */ XREF_PAGE_NUMBER_TYPE = 1414953074, } /** * The synchronization status of the file in Version Cue. */ declare enum VersionCueSyncStatus { /** * The project version of the file was downloaded to the local workspace. */ FILE_DOWNLOADED = 1986220868, /** * The synchronization resulted in no change because the local and project * versions were identical. */ FILE_NO_CHANGE = 1986220878, /** * The file was not synchronized. */ FILE_SKIPPED = 1986220875, /** * The file was unlocked locally. */ FILE_UNLOCKED = 1986220876, /** * The local version of the file was uploaded to the project. */ FILE_UPLOADED = 1986220885, } /** * The version state of the file in Version Cue. */ declare enum VersionState { /** * The version has modifications that make it newer than the project. */ LOCAL_NEWER = 1986221644, /** * The version is identical to the project. */ LOCAL_PROJECT_MATCH = 1986221645, /** * No resource and no local file. */ NO_RESOURCE = 1986221646, /** * The project has a newer file. */ PROJECT_FILE_NEWER = 1986221648, /** * The version contains local edits but the project file is newer. */ VERSION_CONFLICT = 1986221635, /** * The version is not known. */ VERSION_UNKNOWN = 1986221653, } /** * The vertical alignment of an anchored object. */ declare enum VerticalAlignment { /** * Place the anchored object at the bottom of the vertical reference point. */ BOTTOM_ALIGN = 1651471469, /** * Place the anchored object at the vertical center of the vertical reference * point. */ CENTER_ALIGN = 1667591796, /** * Place the anchored object at the top of the vertical reference point. */ TOP_ALIGN = 1953460256, } /** * Vertical alignment options for text. */ declare enum VerticalJustification { /** * Text is aligned at the bottom of the object. */ BOTTOM_ALIGN = 1651471469, /** * Text is center aligned vertically in the object. */ CENTER_ALIGN = 1667591796, /** * Lines of text are evenly distributed vertically between the top and bottom * of the object. */ JUSTIFY_ALIGN = 1785951334, /** * Text is aligned at the top of the object. */ TOP_ALIGN = 1953460256, } /** * The vertical alignment point of an anchored object. */ declare enum VerticallyRelativeTo { /** * Align the anchored object to the top of capital letters. */ CAPHEIGHT = 1096185955, /** * Align the anchored object to the edge of the text or table column. */ COLUMN_EDGE = 1095787375, /** * Align the anchored object to the bottom of the embox. */ EMBOX_BOTTOM = 1096183106, /** * Align the anchored object to the middle of the embox. */ EMBOX_MIDDLE = 1096183117, /** * Align the anchored object to the top of the embox. */ EMBOX_TOP = 1096181101, /** * Align the anchored object to the top of the tallest letters in the text. */ LINE_ASCENT = 1096180083, /** * Align the anchored object to the baseline of the line of text. */ LINE_BASELINE = 1096180321, /** * Align the anchored object to the top of lower case letters with no ascent, * such as x. */ LINE_XHEIGHT = 1096185960, /** * Align the anchored object to the edge of the page. */ PAGE_EDGE = 1095790695, /** * Align the anchored object to the page margin. */ PAGE_MARGINS = 1095789927, /** * Align the anchored object to the edge of the text frame. */ TEXT_FRAME = 1954051174, /** * Align the anchored object to the top of the text leading. */ TOP_OF_LEADING = 1096180332, } /** * Options for display performance settings, which influence the speed and * quality with which an object draws and redraws. */ declare enum ViewDisplaySettings { /** * Slower performance; displays high-resolution graphics and high-quality * transparencies and turns on anti-aliasing. */ HIGH_QUALITY = 1346922866, /** * Best performance; grays out graphics and turns off transparency and * anti-aliasing. */ OPTIMIZED = 1349480564, /** * Moderate performance speed; displays proxy graphics and low-quality * transparencies and turns on anti-aliasing. */ TYPICAL = 1349810544, } /** * View preferences. */ declare class ViewPreference extends Preference { /** * The distance to move a specified object when an arrow key is pressed. (Range * depends on the measurement unit. For points: 0.001 to 100; picas: 0p0.001 to * 8p4; mm: 0 to 35.278; cm: 0 to 3.5278; inches: 0 to 1.3889; ciceros: 0c0.001 * to 7c9.839) * @remarks Measurement unit — also accepts a string such as "12mm". */ cursorKeyIncrement: number | string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The range (in pixels) within which an object snaps to guides. (Range: 1 to * 36) Note: Snapping occurs only when guides are shown. * @remarks Range: 1 to 36 */ guideSnaptoZone: number; /** * The distance (in points) between major tick marks on the horizontal ruler. * (Range: 4 to 256) Valid only when horizontal measurement units is custom. * @remarks Range: 4 to 256 */ horizontalCustomPoints: number; /** * The measurement unit for the horizontal ruler and other * horizontally-measured spaces such as grid columns, horizontal offsets, * column gutters, or others. */ horizontalMeasurementUnits: MeasurementUnits; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the ViewPreference (a Application or Document). */ readonly parent: Application | Document; /** * The number of points per inch, typically 72. (Range: 60 to 80) * @remarks Range: 60 to 80 */ pointsPerInch: number; /** * The measurement unit for the print dialog. */ printDialogMeasurementUnits: MeasurementUnits; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The default zero point at the intersection of the vertical and horizontal * rulers and the scope of the horizontal ruler. */ rulerOrigin: RulerOrigin; /** * If true, displays borders of unselected frames and the diagonal lines in * empty unselected frames. */ showFrameEdges: boolean; /** * If true, notes are displayed. */ showNotes: boolean; /** * If true, displays the horizontal and vertical rulers. */ showRulers: boolean; /** * If true, displays text threads. */ showTextThreads: boolean; /** * The measurement unit for stroke measurements. */ strokeMeasurementUnits: MeasurementUnits; /** * The measurement unit for text size measurements. */ textSizeMeasurementUnits: MeasurementUnits; /** * The measurement units for typography. */ typographicMeasurementUnits: MeasurementUnits; /** * The distance (in points) between major tick marks on the vertical ruler. * (Range: 4 to 256) Valid only when vertical measurement units is custom. * @remarks Range: 4 to 256 */ verticalCustomPoints: number; /** * The measurement unit for the vertical ruler and other vertically-measured * spaces such as grid rows, vertical offsets, row heights, or others. */ verticalMeasurementUnits: MeasurementUnits; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ViewPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ViewPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A view zoom behavior object. */ declare class ViewZoomBehavior extends Behavior { /** * The event which triggers the behavior. */ behaviorEvent: BehaviorEvents; /** * If true, the behavior is enabled. */ enableBehavior: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the ViewZoomBehavior. */ readonly id: number; /** * The index of the ViewZoomBehavior within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the ViewZoomBehavior. */ readonly name: string; /** * The parent of the ViewZoomBehavior (a Button, CheckBox, ComboBox, ListBox, * RadioButton, TextBox or SignatureField). */ readonly parent: CheckBox | ComboBox | ListBox | RadioButton | TextBox | Button | SignatureField; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The view zoom style. */ viewZoomStyle: ViewZoomStyle; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): ViewZoomBehavior[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the ViewZoomBehavior. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the ViewZoomBehavior. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of view zoom behavior objects. */ declare class ViewZoomBehaviors { /** Returns the ViewZoomBehavior with the specified index or name. */ [index: number]: ViewZoomBehavior; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new ViewZoomBehavior. * @param withProperties Initial values for properties of the new ViewZoomBehavior (Optional) */ add(withProperties?: Object): ViewZoomBehavior; /** * Returns any ViewZoomBehavior in the collection. */ anyItem(): ViewZoomBehavior; /** * Displays the number of elements in the ViewZoomBehavior. */ count(): number; /** * Returns every ViewZoomBehavior in the collection. */ everyItem(): ViewZoomBehavior; /** * Returns the first ViewZoomBehavior in the collection. */ firstItem(): ViewZoomBehavior; /** * Returns the ViewZoomBehavior with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): ViewZoomBehavior; /** * Returns the ViewZoomBehavior with the specified ID. * @param id The ID. */ itemByID(id: number): ViewZoomBehavior; /** * Returns the ViewZoomBehavior with the specified name. * @param name The name. */ itemByName(name: string): ViewZoomBehavior; /** * Returns the ViewZoomBehaviors within the specified range. * @param from The ViewZoomBehavior, index, or name at the beginning of the range. Can accept: ViewZoomBehavior, Long Integer or String. * @param to The ViewZoomBehavior, index, or name at the end of the range. Can accept: ViewZoomBehavior, Long Integer or String. */ itemByRange(from: number | ViewZoomBehavior | string, to: number | ViewZoomBehavior | string): ViewZoomBehavior[]; /** * Returns the last ViewZoomBehavior in the collection. */ lastItem(): ViewZoomBehavior; /** * Returns the middle ViewZoomBehavior in the collection. */ middleItem(): ViewZoomBehavior; /** * Returns the ViewZoomBehavior whose index follows the specified * ViewZoomBehavior in the collection. * @param obj The ViewZoomBehavior whose index comes before the desired ViewZoomBehavior. */ nextItem(obj: ViewZoomBehavior): ViewZoomBehavior; /** * Returns the ViewZoomBehavior with the index previous to the specified index. * @param obj The index of the ViewZoomBehavior that follows the desired ViewZoomBehavior. */ previousItem(obj: ViewZoomBehavior): ViewZoomBehavior; /** * Generates a string which, if executed, will return the ViewZoomBehavior. */ toSource(): string; } /** * View zoom style options. */ declare enum ViewZoomStyle { /** * Displays the page at 100% magnification. */ ACTUAL_SIZE = 2053206906, /** * Fits the entire page in the window. */ FIT_PAGE = 2053534832, /** * Fits the the text area of the page to the window width; obscures page * margins and may obscure the lower portion of the page. */ FIT_VISIBLE = 1212437334, /** * Fits the page to the width of the window; may obscure the lower portion of * the page. */ FIT_WIDTH = 1212437335, /** * Fills the screen with the page; hides the toolbar, command bar, menu bar, * and window controls. */ FULL_SCREEN = 1987733107, /** * Arranges the pages in a continuous vertical column that is one page wide. */ ONE_COLUMN = 1987735395, /** * Displays one page in the document pane at a time. */ SINGLE_PAGE = 1987736432, /** * Arranges the pages side by side in a continuous vertical column that is two * pages wide. */ TWO_COLUMN = 1987736675, /** * Magnifies the view to the next preset percentage. */ ZOOM_IN = 2053990766, /** * Reduces the view to the previous preset percentage. */ ZOOM_OUT = 2054124916, } /** * A placed WMF graphic. */ declare class WMF extends Graphic { /** * Indicates whether the WMF has been flipped independently of its parent * object and, if yes, the direction in which the WMF was flipped. */ absoluteFlip: Flip; /** * The horizontal scale of the WMF relative to its containing object. */ absoluteHorizontalScale: number; /** * The rotation angle of the WMF relative to its containing object. (Range: * -360 to 360) */ absoluteRotationAngle: number; /** * The skewing angle of the WMF relative to its containing object. (Range: -360 * to 360) */ absoluteShearAngle: number; /** * The vertical scale of the WMF relative to its containing object. */ absoluteVerticalScale: number; /** * The list of all articles this page item is part of */ readonly allArticles: Article[]; /** * Lists all graphics contained by the WMF. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the WMF. */ readonly allPageItems: PageItem[]; /** * If true, the master page item can be overridden. */ allowOverrides: boolean; /** * The page item animation settings. */ readonly animationSettings: AnimationSetting; /** * The object style applied to the WMF. */ appliedObjectStyle: ObjectStyle; /** * The arrowhead alignment applied to the WMF. */ arrowHeadAlignment: ArrowHeadAlignmentEnum; /** * The XML element associated with the WMF. */ readonly associatedXMLElement: XMLItem; /** * The shape to apply to the bottom left corner of rectangular shapes. */ bottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomLeftCornerRadius: number | string; /** * The shape to apply to the bottom right corner of rectangular shapes. */ bottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ bottomRightCornerRadius: number | string; /** * Clipping path settings. */ readonly clippingPath: ClippingPathSettings; /** * Transparency settings for the content of the WMF. */ readonly contentTransparencySettings: ContentTransparencySetting; /** * The end shape of an open path. */ endCap: EndCap; /** * The corner join applied to the WMF. */ endJoin: EndJoin; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * WMF. . Can also accept: String. */ fillColor: Swatch | string; /** * The percent of tint to use in the WMF's fill color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * Transparency settings for the fill applied to the WMF. */ readonly fillTransparencySettings: FillTransparencySetting; /** * Controls the flex item's height behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemHeightMode: FlexWidthHeightMode | FlexEnum; /** * Controls the flex item's width behavior (fixed, auto, fill). Can return: * FlexWidthHeightMode enumerator or FlexEnum enumerator. */ flexItemWidthMode: FlexWidthHeightMode | FlexEnum; /** * A collection of flex objects. */ readonly flexObjects: FlexObjects; /** * The direction in which to flip the printed image. */ flip: Flip; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of a * dashed, dotted, or striped stroke. For information, see stroke type. */ gapColor: Swatch; /** * The tint as a percentage of the gap color. (To specify a tint percent, use a * number in the range of 0 to 100; to use the inherited or overridden value, * use -1.) * @remarks Range: 0 to 100 */ gapTint: number; /** * The bounds of the WMF excluding the stroke width, in the format [y1, x1, y2, * x2], which give the coordinates of the top-left and bottom-right corners of * the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ geometricBounds: (number | string)[]; /** * The angle of a linear gradient applied to the fill of the WMF. (Range: -180 * to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the WMF. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the WMF, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the WMF. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the WMF. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeLength: number | string; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the WMF, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * The left margin, width, and right margin constraints this item is subject to * when using the object-based layout rule. */ horizontalLayoutConstraints: DimensionsConstraints[]; /** * The horizontal scaling applied to the WMF. */ horizontalScale: number; /** * The unique ID of the WMF. */ readonly id: number; /** * The type of the image. */ readonly imageTypeName: string; /** * The index of the WMF within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The layer that the WMF is on. */ itemLayer: Layer; /** * The source file of the link. */ readonly itemLink: Link; /** * A property that can be set to any string. */ label: string; /** * The scaling applied to the arrowhead at the start of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ leftArrowHeadScale: number; /** * The arrowhead applied to the start of the path. */ leftLineEnd: ArrowHead; /** * Linked Page Item options */ readonly linkedPageItemOptions: LinkedPageItemOption; /** * Display performance options for the WMF. */ localDisplaySetting: DisplaySettingOptions; /** * If true, the WMF is locked. */ locked: boolean; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 1 to 500 */ miterLimit: number; /** * The name of the WMF. */ name: string; /** * If true, the WMF does not print. */ nonprinting: boolean; /** * If true, the WMF's fill color overprints any underlying objects. If false, * the fill color knocks out the underlying colors. */ overprintFill: boolean; /** * If true, the gap color overprints any underlying colors. If false, the gap * color knocks out the underlying colors. */ overprintGap: boolean; /** * If true, the WMF's stroke color overprints any underlying objects. If false, * the stroke color knocks out the underlying colors. */ overprintStroke: boolean; /** * If true, the object originated on a master spread and was overridden. If * false, the object either originated on a master spread and was not * overridden, or the object did not originate on a master page. */ readonly overridden: boolean; /** * An object that originated on a master page and has been overridden. Can * return: PageItem, Guide, Graphic, Movie or Sound. */ readonly overriddenMasterPageItem: Graphic | Guide | Movie | PageItem | Sound; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The parent of the WMF (a Snippet, XMLElement, PlaceGun, TextBox, * SignatureField, ComboBox, ListBox, SplineItem, Polygon, GraphicLine, * Rectangle, Oval or State). */ readonly parent: ComboBox | GraphicLine | ListBox | Oval | PlaceGun | Polygon | Rectangle | SignatureField | SplineItem | TextBox | XMLElement | Snippet | State; /** * The page on which this page item appears. */ readonly parentPage: Page; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The scaling applied to the arrowhead at the end of the path. (Range: 1 to * 1000) * @remarks Range: 1 to 1000 */ rightArrowHeadScale: number; /** * The arrowhead applied to the end of the path. */ rightLineEnd: ArrowHead; /** * The rotatation angle of the WMF. (Range: -360 to 360) */ rotationAngle: number; /** * The skewing angle applied to the WMF. (Range: -360 to 360) */ shearAngle: number; /** * The stroke alignment applied to the WMF. */ strokeAlignment: StrokeAlignment; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the WMF. Can also accept: String. */ strokeColor: Swatch | string; /** * The corner adjustment applied to the WMF. */ strokeCornerAdjustment: StrokeCornerAdjustment; /** * The dash and gap measurements that define the pattern of a custom dashed * line. Define up to six values (in points) in the format [dash1, gap1, dash2, * gap2, dash3, gap3]. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeDashAndGap: (number | string)[]; /** * The percent of tint to use in object's stroke color. (To specify a tint * percent, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * Transparency settings for the stroke. */ readonly strokeTransparencySettings: StrokeTransparencySetting; /** * The name of the stroke style to apply. Can also accept: String. */ strokeType: StrokeStyle | string; /** * The weight (in points) to apply to the WMF's stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * The text wrap preference properties that define the default formatting for * wrapping text around objects. */ readonly textWrapPreferences: TextWrapPreference; /** * The object timing settings. */ readonly timingSettings: TimingSetting; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ topLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topLeftCornerRadius: number | string; /** * The shape to apply to the top right corner of rectangular shapes */ topRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ topRightCornerRadius: number | string; /** * Transparency settings. */ readonly transparencySettings: TransparencySetting; /** * The top margin, height, and bottom margin constraints this item is subject * to when using the object-based layout rule. */ verticalLayoutConstraints: DimensionsConstraints[]; /** * The vertical scaling applied to the WMF. */ verticalScale: number; /** * If true, the WMF is visible. */ visible: boolean; /** * The bounds of the WMF including the stroke width, in the format [y1, x1, y2, * x2], which give the coordinates of the top-left and bottom-right corners of * the bounding box. * @remarks Measurement unit — also accepts a string such as "12mm". */ visibleBounds: (number | string)[]; /** * Dispatched after a WMF is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a WMF is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies the specified object style. * @param using The object style to apply. * @param clearingOverrides If true, clears the WMF's existing attributes before applying the style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears attributes and formatting applied to the WMF that are not defined in the object style. (Optional) */ applyObjectStyle(using: ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds objects that match the find what value and replace the objects with * the change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeObject(reverseOrder?: boolean): PageItem[]; /** * Clear overrides for object style */ clearObjectStyleOverrides(): void; /** * Clears transformations from the WMF. Transformations include rotation, * scaling, flipping, fitting, and shearing. */ clearTransformations(): void; /** * Duplicate an object and place it into the target page item. * @param pageItems One or more page items to place or load * @param linkPageItems Whether to link pageItems in content placer (if true it will override link stories value) (Optional) * @param linkStories Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) * @param mapStyles Whether to map styles in content placer (Optional) * @param showingOptions Whether to display the link options dialog (Optional) */ contentPlace(pageItems: PageItem[], linkPageItems?: boolean, linkStories?: boolean, mapStyles?: boolean, showingOptions?: boolean): any[]; /** * Converts the WMF to a different shape. * @param given The WMF's new shape. * @param numberOfSides The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) * @param insetPercentage The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) * @param cornerRadius The corner radius of the resulting rectangle. (Optional) */ convertShape(given: ConvertShapeOptions, numberOfSides?: number, insetPercentage?: number, cornerRadius?: number | string): void; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new WMF. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new WMF. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new WMF. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new WMF. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new WMF. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Detaches an overridden master page item from the master page. */ detach(): void; /** * Duplicates the WMF at the specified location or offset. * @param to The location of the new WMF, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by Amount by which to offset the new WMF from the original WMF's position. (Optional) */ duplicate(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): PageItem; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Exports the WMF for the web. * @param to The full path name of the exported file. */ exportForWeb(to: File): string[]; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds objects that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findObject(reverseOrder?: boolean): PageItem[]; /** * Applies the specified fit option to content in a frame. * @param given The fit option to use. */ fit(given: FitOptions): void; /** * Flips the WMF. * @param given The axis around which to flip the WMF. * @param around The point around which to flip the WMF. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional) */ flipItem(given: Flip, around?: (number[][] | AnchorPoint)[]): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): WMF[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the WMF to a new location. Note: Either the 'to' or 'by' parameter is * required; if both parameters are defined, only the to value is used. * @param to The new location of the WMF,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional) * @param by The amount (in measurement units) to move the WMF relative to its current position, in the format (x, y). (Optional) */ move(to?: (number[][] | Page | Spread | Layer)[], by?: (number | string)[]): void; /** * Overrides a master page item and places the item on the document page as a * new object. * @param destinationPage The document page that contains the master page item to override. */ override(destinationPage: Page): any; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Places XML content into the specified object. Note: Replaces any existing * content. * @param using The XML element whose content you want to place. */ placeXML(using: XMLElement): void; /** * Apply an item's scaling to its content if possible. * @param to The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) */ redefineScaling(to?: number[]): void; /** * Move the bounding box of the page item * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param opposingCorners Opposing corners of new bounding box in the given coordinate space */ reframe(in_: CoordinateSpaces | BoundingBoxLimits | any[], opposingCorners: any[]): void; /** * Deletes the WMF. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Removes the override from a previously overridden master page item. */ removeOverride(): void; /** * Resize the page item. * @param in_ The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. * @param from The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param by How the current dimensions are affected by the given values * @param values The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. * @param resizeIndividually If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resize(in_: BoundingBoxLimits | CoordinateSpaces | any[], from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], by: ResizeMethods, values: (number[] | ResizeConstraints[] | CoordinateSpaces[])[], resizeIndividually?: boolean, consideringRulerUnits?: boolean): void; /** * Get the coordinates of the given location in the specified coordinate * system. * @param location The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param in_ The coordinate space to use. * @param consideringRulerUnits If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ resolve(location: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], in_: CoordinateSpaces, consideringRulerUnits?: boolean): any; /** * Selects the object. * @param existingSelection The selection status of the WMF in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new WMF (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the WMF. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Transform the page item. * @param in_ The coordinate space to use * @param from The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. * @param withMatrix Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. * @param replacingCurrent Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) * @param consideringRulerUnits If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) */ transform(in_: CoordinateSpaces, from: (AnchorPoint | AnchorPoint[] | number[][] | BoundingBoxLimits[] | CoordinateSpaces[] | number[][][] | number[])[], withMatrix: (number[][] | TransformationMatrix)[], replacingCurrent?: (MatrixContent | number)[], consideringRulerUnits?: boolean): void; /** * Transforms the WMF using the last transformation performed on any object. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformAgain(): string[]; /** * Transforms the WMF using the last transformation performed on any WMF. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformAgainIndividually(): string[]; /** * Transforms the WMF using the last sequence of transform operations performed * on any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgain(): string[]; /** * Transforms the WMF using the last sequence of transformations performed on * any single object or performed at the same time on any group of objects. * Transformations include moving, rotating, shearing, scaling, and flipping. */ transformSequenceAgainIndividually(): string[]; /** * Get the transformation values of the page item. * @param in_ The coordinate space to use */ transformValuesOf(in_: CoordinateSpaces): TransformationMatrix[]; } /** * A collection of WMF graphics. */ declare class WMFs { /** Returns the WMF with the specified index or name. */ [index: number]: WMF; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any WMF in the collection. */ anyItem(): WMF; /** * Displays the number of elements in the WMF. */ count(): number; /** * Returns every WMF in the collection. */ everyItem(): WMF; /** * Returns the first WMF in the collection. */ firstItem(): WMF; /** * Returns the WMF with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): WMF; /** * Returns the WMF with the specified ID. * @param id The ID. */ itemByID(id: number): WMF; /** * Returns the WMF with the specified name. * @param name The name. */ itemByName(name: string): WMF; /** * Returns the WMFs within the specified range. * @param from The WMF, index, or name at the beginning of the range. Can accept: WMF, Long Integer or String. * @param to The WMF, index, or name at the end of the range. Can accept: WMF, Long Integer or String. */ itemByRange(from: number | WMF | string, to: number | WMF | string): WMF[]; /** * Returns the last WMF in the collection. */ lastItem(): WMF; /** * Returns the middle WMF in the collection. */ middleItem(): WMF; /** * Returns the WMF whose index follows the specified WMF in the collection. * @param obj The WMF whose index comes before the desired WMF. */ nextItem(obj: WMF): WMF; /** * Returns the WMF with the index previous to the specified index. * @param obj The index of the WMF that follows the desired WMF. */ previousItem(obj: WMF): WMF; /** * Generates a string which, if executed, will return the WMF. */ toSource(): string; } /** * Warichu text alignment options. */ declare enum WarichuAlignment { /** * Automatically aligns warichu characters. */ AUTO = 1635019116, /** * Aligns warichu in the center of the text frame. */ CENTER_ALIGN = 1667591796, /** * Justifies warichu lines and center aligns the last line. */ CENTER_JUSTIFIED = 1667920756, /** * Justifies warichu lines and makes all lines of equal length. */ FULLY_JUSTIFIED = 1718971500, /** * Aligns warichu on the left side of the text frame. */ LEFT_ALIGN = 1818584692, /** * Justifies warichu lines and left aligns the last line. */ LEFT_JUSTIFIED = 1818915700, /** * Warichu on the rigt side of the text frame. */ RIGHT_ALIGN = 1919379572, /** * Justifies warichu lines and right aligns the last line. */ RIGHT_JUSTIFIED = 1919578996, } /** * Watermark horizontal position enum type. */ declare enum WatermarkHorizontalPositionEnum { /** * Place watermark horizontal center. */ WATERMARK_H_CENTER = 1883787363, /** * Place watermark horizontal left. */ WATERMARK_H_LEFT = 1883787372, /** * Place watermark horizontal right. */ WATERMARK_H_RIGHT = 1883787378, } /** * Watermark preference */ declare class WatermarkPreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the WatermarkPreference (a Document or Application). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Watermark do print for a document */ watermarkDoPrint: boolean; /** * Watermark draw in back for a document */ watermarkDrawInBack: boolean; /** * Watermark font color for a document. Can return: Array of 3 Reals (0 - 255) * or UIColors enumerator. */ watermarkFontColor: (number[][] | UIColors)[]; /** * Watermark font family display name */ watermarkFontFamily: string; /** * Watermark font point size for a document */ watermarkFontPointSize: number; /** * Watermark font style name */ watermarkFontStyle: string; /** * Watermark horizontal offset for a document * @remarks Measurement unit — also accepts a string such as "12mm". */ watermarkHorizontalOffset: number | string; /** * Watermark horizontal position enum for a document */ watermarkHorizontalPosition: WatermarkHorizontalPositionEnum; /** * Watermark opacity (as a percentage). (Range: 0 to 100) * @remarks Range: 0 to 100 */ watermarkOpacity: number; /** * Watermark rotation for a document */ watermarkRotation: number; /** * Watermark text for a document */ watermarkText: string; /** * Watermark vertical offset for a document * @remarks Measurement unit — also accepts a string such as "12mm". */ watermarkVerticalOffset: number | string; /** * Watermark vertical position enum for a document */ watermarkVerticalPosition: WatermarkVerticalPositionEnum; /** * Watermark visibility for a document */ watermarkVisibility: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): WatermarkPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the WatermarkPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Watermark vertical position enum type. */ declare enum WatermarkVerticalPositionEnum { /** * Place watermark vertical bottom. */ WATERMARK_V_BOTTOM = 1884704866, /** * Place watermark vertical center. */ WATERMARK_V_CENTER = 1884704867, /** * Place watermark vertical top. */ WATERMARK_V_TOP = 1884704884, } /** * Scaling options. */ declare enum WhenScalingOptions { /** * Adjust the scaling percentage of the item's transform */ ADJUST_SCALING_PERCENTAGE = 1934587252, /** * Apply scaling to the item's content */ APPLY_TO_CONTENT = 1934192243, } /** * Generic term for an object in a dialog column or dialog row, including * dialog controls such as radio button groups, checkboxes, editboxes, * dropdowns, and comboboxes; static text objects; enabling groups; border * panels; and nested dialog columns and dialog rows. For information, see * dialog column, dialog row, static text, border panel, enabling group, * radiobutton group, checkbox control, angle editbox, angle combobox, integer * editbox, integer combobox, measurement editbox, measurement combobox, * percent editbox, percent combobox, real editbox, real combobox, and text * editbox. */ declare class Widget { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the Widget. */ readonly id: number; /** * The index of the Widget within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The width of the control. For an editbox or combobox, specifies the minimum * width of the box. */ minWidth: number; /** * The parent of the Widget (a DialogColumn, DialogRow, EnablingGroup, * BorderPanel or RadiobuttonGroup). */ readonly parent: BorderPanel | DialogRow | EnablingGroup | DialogColumn | RadiobuttonGroup; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Widget[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the Widget. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of widgets. */ declare class Widgets { /** Returns the Widget with the specified index or name. */ [index: number]: Widget; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Widget in the collection. */ anyItem(): Widget; /** * Displays the number of elements in the Widget. */ count(): number; /** * Returns every Widget in the collection. */ everyItem(): Widget; /** * Returns the first Widget in the collection. */ firstItem(): Widget; /** * Returns the Widget with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Widget; /** * Returns the Widget with the specified ID. * @param id The ID. */ itemByID(id: number): Widget; /** * Returns the Widgets within the specified range. * @param from The Widget, index, or name at the beginning of the range. Can accept: Widget, Long Integer or String. * @param to The Widget, index, or name at the end of the range. Can accept: Widget, Long Integer or String. */ itemByRange(from: number | Widget | string, to: number | Widget | string): Widget[]; /** * Returns the last Widget in the collection. */ lastItem(): Widget; /** * Returns the middle Widget in the collection. */ middleItem(): Widget; /** * Returns the Widget whose index follows the specified Widget in the * collection. * @param obj The Widget whose index comes before the desired Widget. */ nextItem(obj: Widget): Widget; /** * Returns the Widget with the index previous to the specified index. * @param obj The index of the Widget that follows the desired Widget. */ previousItem(obj: Widget): Widget; /** * Generates a string which, if executed, will return the Widget. */ toSource(): string; } /** * A window. */ declare class Window { /** * The bounds of the window (specified in pixels) in the form [top, left, * bottom, right]. */ bounds: number[]; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the Window within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the Window. */ readonly name: string; /** * The parent of the Window (a Document). */ readonly parent: Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The selected object(s). Can also accept: Object or NothingEnum enumerator. */ selection: (Object | NothingEnum)[]; /** * The key object of the selection. Can also accept: NothingEnum enumerator. */ selectionKeyObject: PageItem | NothingEnum; /** * Dispatched after the Window becomes active. This event bubbles. This event * is not cancelable. */ static readonly AFTER_ACTIVATE: string; /** * Dispatched when the value of a property changes on this Window. This event * bubbles. This event is not cancelable. */ static readonly AFTER_ATTRIBUTE_CHANGED: string; /** * Dispatched when a Window is closing. Since the close has been committed, it * can no longer be canceled. This event bubbles. This event is not cancelable. */ static readonly AFTER_CLOSE: string; /** * Dispatched after a Window is opened. This event bubbles. This event is not * cancelable. */ static readonly AFTER_OPEN: string; /** * Dispatched after an attribute on the active selection changes. This event * bubbles. This event is not cancelable. */ static readonly AFTER_SELECTION_ATTRIBUTE_CHANGED: string; /** * Dispatched after the active selection changes. This event bubbles. This * event is not cancelable. */ static readonly AFTER_SELECTION_CHANGED: string; /** * Dispatched before a Window is closed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_CLOSE: string; /** * Dispatched before the Window becomes inactive. This event bubbles. This * event is not cancelable. */ static readonly BEFORE_DEACTIVATE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Brings the object to the front. */ bringToFront(): void; /** * Closes the Window. */ close(): void; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Window[]; /** * Maximizes the window. */ maximize(): void; /** * Minimizes the window. */ minimize(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Restores the window. */ restore(): void; /** * Selects the specified object(s). * @param selectableItems The objects to select. Can accept: Object, Array of Objects, NothingEnum enumerator or SelectAll enumerator. * @param existingSelection The selection status of the Window in relation to previously selected objects. (Optional) */ select(selectableItems: (any[] | NothingEnum | Object | SelectAll)[], existingSelection?: SelectionOptions): void; /** * Generates a string which, if executed, will return the Window. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of windows. */ declare class Windows { /** Returns the Window with the specified index or name. */ [index: number]: Window; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new Window. * @param withProperties Initial values for properties of the new Window (Optional) */ add(withProperties?: Object): Window; /** * Returns any Window in the collection. */ anyItem(): Window; /** * Displays the number of elements in the Window. */ count(): number; /** * Returns every Window in the collection. */ everyItem(): Window; /** * Returns the first Window in the collection. */ firstItem(): Window; /** * Returns the Window with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Window; /** * Returns the Window with the specified name. * @param name The name. */ itemByName(name: string): Window; /** * Returns the Windows within the specified range. * @param from The Window, index, or name at the beginning of the range. Can accept: Window, Long Integer or String. * @param to The Window, index, or name at the end of the range. Can accept: Window, Long Integer or String. */ itemByRange(from: number | Window | string, to: number | Window | string): Window[]; /** * Returns the last Window in the collection. */ lastItem(): Window; /** * Returns the middle Window in the collection. */ middleItem(): Window; /** * Returns the Window whose index follows the specified Window in the * collection. * @param obj The Window whose index comes before the desired Window. */ nextItem(obj: Window): Window; /** * Returns the Window with the index previous to the specified index. * @param obj The index of the Window that follows the desired Window. */ previousItem(obj: Window): Window; /** * Generates a string which, if executed, will return the Window. */ toSource(): string; } /** * A word. */ declare class Word extends Text { /** * If true, aligns the baseline of the text to the baseline grid. */ alignToBaseline: boolean; /** * Lists all graphics contained by the Word. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the Word. */ readonly allPageItems: PageItem[]; /** * If true, words unassociated with a hyphenation dictionary can break to the * next line on any character. */ allowArbitraryHyphenation: boolean; /** * The character style applied to the text. Can also accept: String. */ appliedCharacterStyle: CharacterStyle | string; /** * The applied conditions. */ appliedConditions: Condition[]; /** * The font applied to the Word, specified as either a font object or the name * of font family. Can return: Font or String. */ appliedFont: Font | string; /** * The language of the text. Can return: LanguageWithVendors or Language. Can * also accept: String. */ appliedLanguage: LanguageWithVendors | string | Language; /** * The applied character styles dictated by nested styles. */ readonly appliedNestedStyles: CharacterStyle[]; /** * The list to be part of. Can return: NumberingList or String. */ appliedNumberingList: NumberingList | string; /** * The paragraph style applied to the text. Can also accept: String. */ appliedParagraphStyle: ParagraphStyle | string; /** * The maximum ascent of any character in the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly ascent: number | string; /** * The XML elements associated with the Word. */ readonly associatedXMLElements: XMLItem[]; /** * The percent of the type size to use for auto leading. (Range: 0 to 500). * @remarks Range: 0 to 500 */ autoLeading: number; /** * The number of half-width characters at or below which the characters * automatically run horizontally in vertical text. */ autoTcy: number; /** * If true, auto tcy includes Roman characters. */ autoTcyIncludeRoman: boolean; /** * If true or set to an enumeration value, balances ragged lines. Note: Not * valid with a single-line text composer. Can return: Boolean or * BalanceLinesStyle enumerator. */ balanceRaggedLines: boolean | BalanceLinesStyle; /** * The vertical offset of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly baseline: number | string; /** * The baseline shift applied to the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ baselineShift: number | string; /** * Bullet character. */ readonly bulletChar: Bullet; /** * The alignment of the bullet character. */ bulletsAlignment: ListAlignment; /** * List type for bullets and numbering. */ bulletsAndNumberingListType: ListType; /** * The character style to be used for the text after string. Can return: * CharacterStyle or String. */ bulletsCharacterStyle: CharacterStyle | string; /** * The text after string expression for bullets. */ bulletsTextAfter: string; /** * If true, adds the double period (..), ellipse (...), and double hyphen (--) * to the selected kinsoku set. Note: Valid only when a kinsoku set is in * effect. */ bunriKinshi: boolean; /** * A collection of buttons. */ readonly buttons: Buttons; /** * The capitalization scheme. */ capitalization: Capitalization; /** * The alignment of small characters to the largest character in the line. */ characterAlignment: CharacterAlignment; /** * The direction of the character. */ characterDirection: CharacterDirectionOptions; /** * The rotation angle (in degrees) of individual characters. Note: The rotation * is counterclockwise. */ characterRotation: number; /** * A collection of characters. */ readonly characters: Characters; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * If true, uses grid tracking to track non-Roman characters in CJK grids. */ cjkGridTracking: boolean; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * The text composer to use to compose the text. */ composer: string; /** * The contents of the text. Can return: String or SpecialCharacters * enumerator. */ contents: string | SpecialCharacters; /** * The maximum descent of any character in the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly descent: number | string; /** * Value of Design Axes */ designAxes: number[]; /** * The desired width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ desiredGlyphScaling: number; /** * The desired letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) */ desiredLetterSpacing: number; /** * The desired word spacing, specified as a percentage of the font word space * value. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ desiredWordSpacing: number; /** * Position of diacriticical characters. */ diacriticPosition: DiacriticPositionOptions; /** * The digits type. */ digitsType: DigitsTypeOptions; /** * The number of characters to drop cap. * @remarks Range: 0 to 150 */ dropCapCharacters: number; /** * The number of lines to drop cap. * @remarks Range: 0 to 25 */ dropCapLines: number; /** * The character style to apply to the drop cap. Can also accept: String. */ dropCapStyle: CharacterStyle | string; /** * Details about the drop cap based on the glyph outlines. 1 = left side * bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid. */ dropcapDetail: number; /** * Vertical offset of the end of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly endBaseline: number | string; /** * Horizontal offset of the end of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly endHorizontalOffset: number | string; /** * The stroke join type applied to the characters of the text. */ endJoin: OutlineJoin; /** * A collection of endnote text ranges. */ readonly endnoteRanges: EndnoteRanges; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * Word. . Can also accept: String. */ fillColor: Swatch | string; /** * The tint (as a percentage) of the fill color of the Word. (To specify a tint * percentage, use a number in the range of 0 to 100; to use the inherited or * overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * The amount to indent the first line. * @remarks Measurement unit — also accepts a string such as "12mm". */ firstLineIndent: number | string; /** * The name of the font style. */ fontStyle: string; /** * A collection of footnotes. */ readonly footnotes: Footnotes; /** * A collection of form fields. */ readonly formFields: FormFields; /** * The glyph variant to substitute for standard glyphs. */ glyphForm: AlternateGlyphForms; /** * The angle of a linear gradient applied to the fill of the text. (Range: -180 * to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the text. */ gradientFillLength: number; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the text. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the text. */ gradientStrokeLength: number; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * If true, aligns only the first line to the frame grid or baseline grid. If * false, aligns all lines to the grid. */ gridAlignFirstLineOnly: boolean; /** * The alignment to the frame grid or baseline grid. */ gridAlignment: GridAlignment; /** * The manual gyoudori setting. */ gridGyoudori: number; /** * A collection of groups. */ readonly groups: Groups; /** * A collection of hidden text objects. */ readonly hiddenTexts: HiddenTexts; /** * The horizontal offset of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ readonly horizontalOffset: number | string; /** * The horizontal scaling applied to the Word. */ horizontalScale: number; /** * The relative desirability of better spacing vs. fewer hyphens. A lower value * results in greater use of hyphens. (Range: 0 to 100) * @remarks Range: 0 to 10 */ hyphenWeight: number; /** * If true, allows the last word in a text column to be hyphenated. */ hyphenateAcrossColumns: boolean; /** * The mininum number of letters at the beginning of a word that can be broken * by a hyphen. * @remarks Range: 1 to 15 */ hyphenateAfterFirst: number; /** * The minimum number of letters at the end of a word that can be broken by a * hyphen. * @remarks Range: 1 to 15 */ hyphenateBeforeLast: number; /** * If true, allows hyphenation of capitalized words. */ hyphenateCapitalizedWords: boolean; /** * The maximum number of hyphens that can appear on consecutive lines. To * specify unlimited consecutive lines, use zero. * @remarks Range: 0 to 25 */ hyphenateLadderLimit: number; /** * If true, allows hyphenation in the last word in a paragraph. Note: Valid * only when hyphenation is true. */ hyphenateLastWord: boolean; /** * The minimum number of letters a word must have in order to qualify for * hyphenation. * @remarks Range: 3 to 25 */ hyphenateWordsLongerThan: number; /** * If true, allows hyphenation. */ hyphenation: boolean; /** * The amount of white space allowed at the end of a line of non-justified text * before hypenation begins. Note: Valid when composer is single-line composer. * @remarks Measurement unit — also accepts a string such as "12mm". */ hyphenationZone: number | string; /** * If true, ignores optical edge alignment for the paragraph. */ ignoreEdgeAlignment: boolean; /** * The index of the text in the collection or parent object. */ readonly index: number; /** * A collection of insertion points. */ readonly insertionPoints: InsertionPoints; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The number of grid squares in which to arrange the text. */ jidori: number; /** * The paragraph alignment. */ justification: Justification; /** * Use of Kashidas for justification */ kashidas: KashidasOptions; /** * If true, keeps all lines of the paragraph together. If false, allows * paragraphs to break across pages or columns. */ keepAllLinesTogether: boolean; /** * The minimum number of lines to keep together in a paragraph before allowing * a page break. * @remarks Range: 1 to 50 */ keepFirstLines: number; /** * The minimum number of lines to keep together in a paragraph after a page * break. * @remarks Range: 1 to 50 */ keepLastLines: number; /** * If true, keeps a specified number of lines together when the paragraph * breaks across columns or text frames. */ keepLinesTogether: boolean; /** * If true, forces the rule above the paragraph to remain in the frame bounds. * Note: Valid only when rule above is true. */ keepRuleAboveInFrame: boolean; /** * The minimum number of lines to keep with the next paragraph. * @remarks Range: 0 to 5 */ keepWithNext: number; /** * If the first line in the paragraph should be kept with the last line of * previous paragraph. */ keepWithPrevious: boolean; /** * The alignment of kenten characters relative to the parent characters. */ kentenAlignment: KentenAlignment; /** * The character set used for the custom kenten character. Note: Valid only * when kenten kind is custom. */ kentenCharacterSet: KentenCharacterSet; /** * The character used for kenten. Note: Valid only when kenten kind is custom. */ kentenCustomCharacter: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of * kenten characters. Can return: Swatch or String. */ kentenFillColor: Swatch | string; /** * The font to use for kenten characters. Can return: Font or String. */ kentenFont: Font | string; /** * The size (in points) of kenten characters. */ kentenFontSize: number; /** * The font style of kenten characters. Can return: String or NothingEnum * enumerator. */ kentenFontStyle: string | NothingEnum; /** * The style of kenten characters. */ kentenKind: KentenCharacter; /** * The method of overprinting the kenten fill. */ kentenOverprintFill: AdornmentOverprint; /** * The method of overprinting the kenten stroke. */ kentenOverprintStroke: AdornmentOverprint; /** * The distance between kenten characters and their parent characters. */ kentenPlacement: number; /** * The kenten position relative to the parent character. */ kentenPosition: RubyKentenPosition; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * kenten characters. Can return: Swatch or String. */ kentenStrokeColor: Swatch | string; /** * The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenStrokeTint: number; /** * The fill tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenTint: number; /** * The stroke weight (in points) of kenten characters. */ kentenWeight: number; /** * The horizontal size of kenten characters as a percent of the original size. */ kentenXScale: number; /** * The vertical size of kenten charachers as a percent of the original size. */ kentenYScale: number; /** * The type of pair kerning. */ kerningMethod: string; /** * The amount of space to add or remove between characters, specified in * thousands of an em. */ kerningValue: number; /** * The keyboard direction of the character. */ keyboardDirection: CharacterDirectionOptions; /** * The type of hanging punctuation to allow. Note: Valid only when a kinsoku * set is in effect. */ kinsokuHangType: KinsokuHangTypes; /** * The kinsoku set that determines legitimate line breaks. Can return: * KinsokuTable, KinsokuSet enumerator or String. */ kinsokuSet: KinsokuSet | KinsokuTable | string; /** * The type of kinsoku processing for preventing kinsoku characters from * beginning or ending a line. Note: Valid only when a kinsoku set is defined. */ kinsokuType: KinsokuType; /** * The amount to indent the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ lastLineIndent: number | string; /** * The leading applied to the text. Can return: Unit or Leading enumerator. */ leading: number | Leading; /** * The amount of space before each character. */ leadingAki: number; /** * The point from which leading is measured from line to line. */ leadingModel: LeadingModel; /** * The width of the left indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ leftIndent: number | string; /** * The number of objects in the collection. */ readonly length: number; /** * If true, replaces specific character combinations (e.g., fl, fi) with * ligature characters. */ ligatures: boolean; /** * A collection of lines. */ readonly lines: Lines; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * The maximum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ maximumGlyphScaling: number; /** * The maximum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ maximumLetterSpacing: number; /** * The maximum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ maximumWordSpacing: number; /** * If true, consecutive para borders with completely similar properties are * merged. */ mergeConsecutiveParaBorders: boolean; /** * The minimum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ minimumGlyphScaling: number; /** * The minimum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ minimumLetterSpacing: number; /** * The minimum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ minimumWordSpacing: number; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 0 to 1000 */ miterLimit: number; /** * The mojikumi table. For information, see mojikumi table defaults. Can * return: MojikumiTable, String or MojikumiTableDefaults enumerator. */ mojikumi: MojikumiTable | string | MojikumiTableDefaults; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * A collection of nested GREP styles. */ readonly nestedGrepStyles: NestedGrepStyles; /** * A collection of nested line styles. */ readonly nestedLineStyles: NestedLineStyles; /** * A collection of nested styles. */ readonly nestedStyles: NestedStyles; /** * If true, keeps the text on the same line. */ noBreak: boolean; /** * A collection of notes. */ readonly notes: Notes; /** * The alignment of the number. */ numberingAlignment: ListAlignment; /** * If true, apply the numbering restart policy. */ numberingApplyRestartPolicy: boolean; /** * The character style to be used for the number string. Can return: * CharacterStyle or String. */ numberingCharacterStyle: CharacterStyle | string; /** * Continue the numbering at this level. */ numberingContinue: boolean; /** * The number string expression for numbering. */ numberingExpression: string; /** * Numbering format options. Can return: NumberingStyle enumerator or String. */ numberingFormat: NumberingStyle | string; /** * The level of the paragraph. */ numberingLevel: number; /** * Numbering restart policies. */ readonly numberingRestartPolicies: NumberingRestartPolicy; /** * Determines starting number in a numbered list. */ numberingStartAt: number; /** * OpenType features. Can return: Array of Array of 2 Strings or Long Integers. */ opentypeFeatures: (string[][] | number[])[]; /** * If true, uses contextual alternate forms in OpenType fonts. */ otfContextualAlternate: boolean; /** * If true, uses discretionary ligatures in OpenType fonts. */ otfDiscretionaryLigature: boolean; /** * The figure style in OpenType fonts. */ otfFigureStyle: OTFFigureStyle; /** * If true, uses fractions in OpenType fonts. */ otfFraction: boolean; /** * If true, switches hiragana fonts, which have different glyphs for horizontal * and vertical. */ otfHVKana: boolean; /** * If true, use historical forms in OpenType fonts. */ otfHistorical: boolean; /** * If true, use alternate justification forms in OpenType fonts */ otfJustificationAlternate: boolean; /** * If true, uses localized forms in OpenType fonts. */ otfLocale: boolean; /** * If true, uses mark positioning in OpenType fonts. */ otfMark: boolean; /** * If true, uses ordinals in OpenType fonts. */ otfOrdinal: boolean; /** * If true, use overlapping swash forms in OpenType fonts */ otfOverlapSwash: boolean; /** * If true, kerns according to proportional CJK metrics in OpenType fonts. */ otfProportionalMetrics: boolean; /** * If true, applies italics to half-width alphanumerics. */ otfRomanItalics: boolean; /** * If true, use a slashed zeroes in OpenType fonts. */ otfSlashedZero: boolean; /** * If true, use stretched alternate forms in OpenType fonts */ otfStretchedAlternate: boolean; /** * If true, use stylistic alternate forms in OpenType fonts */ otfStylisticAlternate: boolean; /** * The stylistic sets to use in OpenType fonts. */ otfStylisticSets: number; /** * If true, uses swash forms in OpenType fonts. */ otfSwash: boolean; /** * If true, uses titling forms in OpenType fonts. */ otfTitling: boolean; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the fill color of the characters will overprint. */ overprintFill: boolean; /** * If true, the stroke of the characters will overprint. */ overprintStroke: boolean; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphBorderBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLeftCornerRadius: number | string; /** * The bottom line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLineWeight: number | string; /** * The distance to offset the bottom edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph border. */ paragraphBorderBottomOrigin: ParagraphBorderBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphBorderBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomRightCornerRadius: number | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * stroke. Can return: Swatch or String. */ paragraphBorderColor: Swatch | string; /** * If true, then paragraph border is also displayed at the points where the * paragraph splits across frames or columns. */ paragraphBorderDisplayIfSplits: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * border gap. Note: Valid only when the border type is not solid. Can return: * Swatch or String. */ paragraphBorderGapColor: Swatch | string; /** * If true, the paragraph border gap will overprint. Note: Valid only when * border type is not solid. */ paragraphBorderGapOverprint: boolean; /** * The tint (as a percentage) of the paragraph border gap. Note: Valid only * when the border type is not solid. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderGapTint: number; /** * The left line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftLineWeight: number | string; /** * The distance to offset the left edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftOffset: number | string; /** * If true, the paragraph border is on. */ paragraphBorderOn: boolean; /** * If true, the paragraph border will overprint. */ paragraphBorderOverprint: boolean; /** * The right line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightLineWeight: number | string; /** * The distance to offset the right edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightOffset: number | string; /** * The end shape of an open path. */ paragraphBorderStrokeEndCap: EndCap; /** * The corner join applied to the Word. */ paragraphBorderStrokeEndJoin: EndJoin; /** * The tint (as a percentage) of the paragraph stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphBorderTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLeftCornerRadius: number | string; /** * The top line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLineWeight: number | string; /** * The distance to offset the top edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph border. */ paragraphBorderTopOrigin: ParagraphBorderTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphBorderTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopRightCornerRadius: number | string; /** * The type of the border for the paragraph. Can return: StrokeStyle or String. */ paragraphBorderType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph border. */ paragraphBorderWidth: ParagraphBorderEnum; /** * Paragraph direction. */ paragraphDirection: ParagraphDirectionOptions; /** * If true, the gyoudori mode applies to the entire paragraph. If false, the * gyoudori mode applies to each line in the paragraph. */ paragraphGyoudori: boolean; /** * Paragraph justification. */ paragraphJustification: ParagraphJustificationOptions; /** * Paragraph kashida width. 0 is none, 1 is short, 2 is medium, 3 is long */ paragraphKashidaWidth: number; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphShadingBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomLeftCornerRadius: number | string; /** * The distance to offset the bottom edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph shading. */ paragraphShadingBottomOrigin: ParagraphShadingBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphShadingBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomRightCornerRadius: number | string; /** * If true, forces the shading of the paragraph to be clipped with respect to * frame shape. */ paragraphShadingClipToFrame: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * shading. Can return: Swatch or String. */ paragraphShadingColor: Swatch | string; /** * The distance to offset the left edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingLeftOffset: number | string; /** * If true, the paragraph shading is On. */ paragraphShadingOn: boolean; /** * If true, the paragraph shading will overprint. */ paragraphShadingOverprint: boolean; /** * The distance to offset the right edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingRightOffset: number | string; /** * If true, suppress printing of the shading of the paragraph. */ paragraphShadingSuppressPrinting: boolean; /** * The tint (as a percentage) of the paragraph shading. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphShadingTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphShadingTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopLeftCornerRadius: number | string; /** * The distance to offset the top edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph shading. */ paragraphShadingTopOrigin: ParagraphShadingTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphShadingTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopRightCornerRadius: number | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph shading. */ paragraphShadingWidth: ParagraphShadingWidthEnum; /** * A collection of paragraphs. */ readonly paragraphs: Paragraphs; /** * The parent of the Word (a XmlStory, TextPath, TextFrame, EndnoteTextFrame, * Text, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, * Character, Story, Cell, XMLElement, Endnote, Footnote, Note, Change or * HiddenText). */ readonly parent: Cell | Change | Character | Endnote | EndnoteTextFrame | Footnote | InsertionPoint | Line | Note | Paragraph | Story | Text | TextColumn | TextFrame | TextPath | TextStyleRange | Word | XMLElement | HiddenText | XmlStory; /** * The story that contains the text. */ readonly parentStory: Story; /** * An array of the text frames that contain the text. Can return: Array of * TextFrames or TextPaths. */ readonly parentTextFrames: (TextFrames | TextPaths)[]; /** * The text size. * @remarks Measurement unit — also accepts a string such as "12mm". */ pointSize: number | string; /** * A collection of polygons. */ readonly polygons: Polygons; /** * The text position relative to the baseline. */ position: Position; /** * The OpenType positional form. */ positionalForm: PositionalForms; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The hyphenation style chosen for the provider. */ providerHyphenationStyle: HyphenationStyleEnum; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * If true, disallows line breaks in numbers. If false, lines can break between * digits in multi-digit numbers. */ rensuuji: boolean; /** * The width of the right indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ rightIndent: number | string; /** * If true, rotates Roman characters in vertical text. */ rotateSingleByteCharacters: boolean; /** * The ruby alignment. */ rubyAlignment: RubyAlignments; /** * If true, auto aligns ruby. */ rubyAutoAlign: boolean; /** * If true, automatically scales ruby to the specified percent of parent text * size. For information on specifying a percent, see ruby parent scaling * percent. */ rubyAutoScaling: boolean; /** * If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to * fit one em. */ rubyAutoTcyAutoScale: boolean; /** * The number of digits included in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyDigits: number; /** * If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyIncludeRoman: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby * characters. Can return: Swatch or String. */ rubyFill: Swatch | string; /** * If true, ruby is on. */ rubyFlag: boolean; /** * The font applied to ruby characters. Can return: Font or String. */ rubyFont: Font | string; /** * The size (in points) of ruby characters. */ rubyFontSize: number; /** * The font style of ruby characters. Can return: String or NothingEnum * enumerator. */ rubyFontStyle: string | NothingEnum; /** * If true, uses OpenType Pro fonts for ruby. */ rubyOpenTypePro: boolean; /** * If true, constrains ruby overhang to the specified amount. For information * on specifying an amount, see ruby parent overhang amount. */ rubyOverhang: boolean; /** * The method of overprinting the ruby fill. */ rubyOverprintFill: AdornmentOverprint; /** * The method of overprinting the ruby stroke. */ rubyOverprintStroke: AdornmentOverprint; /** * The amount by which ruby characters can overhang the parent text. */ rubyParentOverhangAmount: RubyOverhang; /** * The amount (as a percentage) to scale the parent text size to determine the * ruby text size. */ rubyParentScalingPercent: number; /** * The ruby spacing relative to the parent text. */ rubyParentSpacing: RubyParentSpacing; /** * The position of ruby characters relative to the parent text. */ rubyPosition: RubyKentenPosition; /** * The ruby string contents. */ rubyString: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * ruby characters. Can return: Swatch or String. */ rubyStroke: Swatch | string; /** * The stroke tint (as a percentage) of ruby characters. */ rubyStrokeTint: number; /** * The tint (as a percentage) of the ruby fill color. (Range: 0 to 100) * @remarks Range: 0 to 100 */ rubyTint: number; /** * The ruby type. */ rubyType: RubyTypes; /** * The stroke weight (in points) of ruby characters. */ rubyWeight: number; /** * The amount of horizontal space between ruby and parent characters. */ rubyXOffset: number; /** * The horizontal size of ruby characters, specified as a percent of the * original size. */ rubyXScale: number; /** * The amount of vertical space between ruby and parent characters. */ rubyYOffset: number; /** * The vertical size of ruby characters, specified as a percent of the original * size. */ rubyYScale: number; /** * If true, places a rule above the paragraph. */ ruleAbove: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule above. Can return: Swatch or String. */ ruleAboveColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule above. Note: Valid only when the paragraph rule above * type is not solid. Can return: Swatch or String. */ ruleAboveGapColor: Swatch | string; /** * If true, the stroke gap of the paragraph rule above will overprint. Note: * Valid only the rule above type is not solid. */ ruleAboveGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule. * (Range: 0 to 100) Note: Valid only when the rule above type is not solid. * @remarks Range: 0 to 100 */ ruleAboveGapTint: number; /** * The distance to indent the left edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLeftIndent: number | string; /** * The line weight of the rule above. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLineWeight: number | string; /** * The amount to offset the paragraph rule above from the baseline of the first * line the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveOffset: number | string; /** * If true, the paragraph rule above will overprint. */ ruleAboveOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleAboveTint: number; /** * The stroke type of the rule above the paragraph. Can return: StrokeStyle or * String. */ ruleAboveType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule above. */ ruleAboveWidth: RuleWidth; /** * If true, applies a paragraph rule below. */ ruleBelow: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule below. Can return: Swatch or String. */ ruleBelowColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule below. Note: Valid only when the paragraph rule below * type is not solid. Can return: Swatch or String. */ ruleBelowGapColor: Swatch | string; /** * If true, the gap color of the rule below will overprint. */ ruleBelowGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule * below. (Range: 0 to 100) Note: Valid only when the paragraph rule below type * is not solid. * @remarks Range: 0 to 100 */ ruleBelowGapTint: number; /** * The distance to indent the left edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLeftIndent: number | string; /** * The line weight of the rule below. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLineWeight: number | string; /** * The amount to offset the the paragraph rule below from the baseline of the * last line of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowOffset: number | string; /** * If true, the rule below will overprint. */ ruleBelowOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleBelowTint: number; /** * The stroke type of the rule below the paragraph. Can return: StrokeStyle or * String. */ ruleBelowType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule below. */ ruleBelowWidth: RuleWidth; /** * The space between paragraphs using same style. Can return: Unit or Spacing * enumerator. */ sameParaStyleSpacing: number | Spacing; /** * If true, the line changes size when characters are scaled. */ scaleAffectsLineHeight: boolean; /** * If true, applies shatai rotation. */ shataiAdjustRotation: boolean; /** * If true, adjusts shatai tsume. */ shataiAdjustTsume: boolean; /** * The shatai lens angle (in degrees). */ shataiDegreeAngle: number; /** * The amount (as a percentage) of shatai obliquing to apply. */ shataiMagnification: number; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * The alignment to use for lines that contain a single word. */ singleWordJustification: SingleWordJustification; /** * The skew angle of the Word. */ skew: number; /** * The height of the paragraph space below. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceAfter: number | string; /** * The height of the paragraph space above. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceBefore: number | string; /** * The minimum space after a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceAfter: number | string; /** * The minimum space before a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceBefore: number | string; /** * Whether a paragraph should be a single column, span columns or split columns */ spanColumnType: SpanColumnTypeOptions; /** * The number of columns a paragraph spans or the number of split columns. Can * return: Short Integer (1 - 40) or SpanColumnCountOptions enumerator. */ spanSplitColumnCount: number | SpanColumnCountOptions; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The inside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnInsideGutter: number | string; /** * The outside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnOutsideGutter: number | string; /** * The location at which to start the paragraph. */ startParagraph: StartParagraph; /** * The swatch (color, gradient, tint, or mixed ink) applied to the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughGapColor: Swatch | string; /** * If true, the gap color of the strikethrough stroke will overprint. Note: * Valid when strike through type is not solid. */ strikeThroughGapOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 * to 100) Note: Valid when strike through type is not solid. * @remarks Range: 0 to 100 */ strikeThroughGapTint: number; /** * The amount by which to offset the strikethrough stroke from the text * baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughOffset: number | string; /** * If true, the strikethrough stroke will overprint. */ strikeThroughOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ strikeThroughTint: number; /** * The stroke type of the strikethrough stroke. Can return: StrokeStyle or * String. */ strikeThroughType: StrokeStyle | string; /** * The stroke weight of the strikethrough stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughWeight: number | string; /** * If true, draws a strikethrough line through the text. */ strikeThru: boolean; /** * The stroke alignment applied to the text. */ strokeAlignment: TextStrokeAlign; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the Word. Can also accept: String. */ strokeColor: Swatch | string; /** * The tint (as a percentage) of the stroke color of the Word. (To specify a * tint percentage, use a number in the range of 0 to 100; to use the inherited * or overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * The stroke weight applied to the characters of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * If true, the applied style has been overridden with additional attributes. */ readonly styleOverridden: boolean; /** * A list of the tab stops in the paragraph. Can return: Array of Arrays of * Property Name/Value Pairs. */ tabList: any[][][]; /** * A collection of tab stops. */ readonly tabStops: TabStops; /** * A collection of tables. */ readonly tables: Tables; /** * If true, makes the character horizontal in vertical text. */ tatechuyoko: boolean; /** * The horizontal offset for horizontal characters in vertical text. */ tatechuyokoXOffset: number; /** * The vertical offset for horizontal characters in vertical text. */ tatechuyokoYOffset: number; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text columns. */ readonly textColumns: TextColumns; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * A collection of text style ranges. */ readonly textStyleRanges: TextStyleRanges; /** * A collection of text variable instances. */ readonly textVariableInstances: TextVariableInstances; /** * A collection of text objects. */ readonly texts: Texts; /** * The amount by which to loosen or tighten a block of text, specified in * thousands of an em. */ tracking: number; /** * The amount of space after each character. */ trailingAki: number; /** * If true, ideographic spaces will not wrap to the next line like text * characters. */ treatIdeographicSpaceAsSpace: boolean; /** * The amount of horizontal character compression. */ tsume: number; /** * If true, underlines the text. */ underline: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the underline * stroke. . Can return: Swatch or String. */ underlineColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * underline stroke. Note: Valid when underline type is not solid. Can return: * Swatch or String. */ underlineGapColor: Swatch | string; /** * If true, the gap color of the underline stroke will overprint. */ underlineGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of the underline stroke. (Range: * 0 to 100) Note: Valid when underline type is not solid. * @remarks Range: 0 to 100 */ underlineGapTint: number; /** * The amount by which to offset the underline from the text baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineOffset: number | string; /** * If true, the underline stroke color will overprint. */ underlineOverprint: boolean; /** * The underline stroke tint (as a percentage). (Range: 0 to 100) * @remarks Range: 0 to 100 */ underlineTint: number; /** * The stroke type of the underline stroke. Can return: StrokeStyle or String. */ underlineType: StrokeStyle | string; /** * The stroke weight of the underline stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineWeight: number | string; /** * The vertical scaling applied to the Word. */ verticalScale: number; /** * If true, turns on warichu. */ warichu: boolean; /** * The warichu alignment. */ warichuAlignment: WarichuAlignment; /** * The minimum number of characters allowed after a line break. */ warichuCharsAfterBreak: number; /** * The minimum number of characters allowed before a line break. */ warichuCharsBeforeBreak: number; /** * The gap between lines of warichu characters. */ warichuLineSpacing: number; /** * The number of lines of warichu within a single normal line. */ warichuLines: number; /** * The amount (as a percentage) to scale parent text size to determine warichu * size. */ warichuSize: number; /** * A collection of words. */ readonly words: Words; /** * The x (horizontal) offset for diacritic adjustment. */ xOffsetDiacritic: number; /** * The y (vertical) offset for diacritic adjustment. */ yOffsetDiacritic: number; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Apply a character style. * @param using The character style to apply. */ applyCharacterStyle(using: CharacterStyle): void; /** * Apply one or more conditions. * @param using The condition(s) to apply * @param removeExisting If true, remove existing conditions. (Optional) */ applyConditions(using: Condition[], removeExisting?: boolean): void; /** * Apply a paragraph style. * @param using The paragraph style to apply. * @param clearingOverrides If true, clear any text attributes before applying the style. (Optional) */ applyParagraphStyle(using: ParagraphStyle, clearingOverrides?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Tag the object or the parent story using default tags defined in XML * preference. */ autoTag(): void; /** * Finds glyphs that match the find what value and replaces the glyphs with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value and replaces the text * with the change character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeTransliterate(reverseOrder?: boolean): Text[]; /** * Sets the case of the text. * @param using The text case option. */ changecase(using: ChangecaseMode): void; /** * Clears the specified types of override. * @param overridesToClear The types of override to clear. (Optional) */ clearOverrides(overridesToClear?: OverrideType): void; /** * Convert bullets and numbering to text. */ convertBulletsAndNumberingToText(): void; /** * Converts the text to a note. */ convertToNote(): Note; /** * Converts the text to a table. * @param columnSeparator The character that starts a new column in the new table. (Optional) * @param rowSeparator The character starts a new row in the new table. (Optional) * @param numberOfColumns The number of columns in the table. Note: Valid only when the column and row separator characters are the same. (Optional) */ convertToTable(columnSeparator?: string, rowSeparator?: string, numberOfColumns?: number): Table; /** * Create Email QR Code on the page item or document * @param emailAddress QR code Email Address (Optional) * @param subject QR code Email Subject (Optional) * @param body QR code Email Body Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Word. Above parameters can also be passed as properties (Optional) */ createEmailQRCode(emailAddress?: string, subject?: string, body?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create Hyperlink QR Code on the page item or document * @param urlLink QR code Hyperlink URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Word. Above parameters can also be passed as properties (Optional) */ createHyperlinkQRCode(urlLink?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Converts text to outlines. Each line of text becomes a polygon object. When * the converted text is a single letter that has no internal spaces or * detached parts, the polygon contains only a single path. Note: To determine * whether a font allows the creation of outlines, see allow outlines. * @param deleteOriginal If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) */ createOutlines(deleteOriginal?: boolean): PageItem[]; /** * Create Plain Text QR Code on the page item * @param plainText QR code Plain Text (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Word. Above parameters can also be passed as properties (Optional) */ createPlainTextQRCode(plainText?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create thumbnail for selected text using the applied style and overrides * with the given properties. * @param previewText Text to use as sample * @param pointSize Text font size (in points) * @param space Color space RGB, CMYK or LAB * @param colorValue Color values * @param to The path to the export file. * @param charOrParaStyle The applied style type to use. */ createStyleThumbnailWithProperties(previewText: string, pointSize: number, space: ColorSpace, colorValue: number[], to: File, charOrParaStyle: StyleType): boolean; /** * Create Text Msg QR Code on the page item or document * @param cellNumber QR code Text Phone Number (Optional) * @param textMessage QR code Text Message (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Word. Above parameters can also be passed as properties (Optional) */ createTextMsgQRCode(cellNumber?: string, textMessage?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Create thumbnail for selected text with the given properties. * @param previewText Text to use as sample * @param pointSize Text font size (in points) * @param space Color space RGB, CMYK or LAB * @param colorValue Color values * @param to The path to the export file. */ createThumbnailWithProperties(previewText: string, pointSize: number, space: ColorSpace, colorValue: number[], to: File): boolean; /** * Create Business Card QR Code on the page item or load on document's placegun * @param firstName QR code Business Card First Name (Optional) * @param lastName QR code Business Card Last Name (Optional) * @param jobTitle QR code Business Card Title (Optional) * @param cellPhone QR code Business Card Cell Phone Number (Optional) * @param phone QR code Business Card Phone Number (Optional) * @param email QR code Business Card Email Address (Optional) * @param organisation QR code Business Card Organisation (Optional) * @param streetAddress QR code Business Card Street Address (Optional) * @param city QR code Business Card City (Optional) * @param adrState QR code Business Card State (Optional) * @param country QR code Business Card Country (Optional) * @param postalCode QR code Business Card Postal Code (Optional) * @param website QR code Business Card URL (Optional) * @param qrCodeSwatch Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String. (Optional) * @param withProperties Initial values for properties of the new Word. Above parameters can also be passed as properties (Optional) */ createVCardQRCode(firstName?: string, lastName?: string, jobTitle?: string, cellPhone?: string, phone?: string, email?: string, organisation?: string, streetAddress?: string, city?: string, adrState?: string, country?: string, postalCode?: string, website?: string, qrCodeSwatch?: Swatch | string, withProperties?: string[]): void; /** * Duplicates the text in the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional) */ duplicate(to: LocationOptions, reference?: Cell | Column | Row | Story | Table | Text | PageItem): Text; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Finds glyphs that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGrep(reverseOrder?: boolean): Text[]; /** * Finds hyperlink sources that intersecting with specified text range. * @param sortOrder The sort order of found ranges. (Optional) */ findHyperlinks(sortOrder?: RangeSortOrder): HyperlinkTextSource[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findTransliterate(reverseOrder?: boolean): Text[]; /** * Resolves the object specifier, creating an array of object references. */ getElements(): Word[]; /** * If true, Nth design axis of variable font is hidden. * @param nthAxisIndex Index of design axis. */ isNthDesignAxisHidden(nthAxisIndex: number): boolean; /** * Associates the page item with the specified XML element while preserving * existing content. * @param using The XML element. */ markup(using: XMLElement): void; /** * Moves the text to the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional) */ move(to: LocationOptions, reference?: Cell | Column | Row | Story | Table | Text | PageItem): Text; /** * Places the file. * @param fileName The file to place * @param showingOptions Whether to display the import options dialog (Optional) * @param withProperties Initial values for properties of the placed object(s) (Optional) */ place(fileName: File, showingOptions?: boolean, withProperties?: Object): any[]; /** * Recomposes the text in the Word. */ recompose(): void; /** * Deletes the Word. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Selects the object. * @param existingSelection The selection status of the Word in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Set Nth design axis of a variable font. * @param nthAxisIndex Index of design axis. * @param nthAxisValue Value of nth design axis. */ setNthDesignAxis(nthAxisIndex: number, nthAxisValue: number): void; /** * Jump to the text range. */ showText(): void; /** * If true, text has local overrides * @param charOrParaStyle Style type to look at. * @param charStyleAsOverride Whether to consider character styles as overrides or not (Optional) */ textHasOverrides(charOrParaStyle: StyleType, charStyleAsOverride?: boolean): boolean; /** * Generates a string which, if executed, will return the Word. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Word RTF import preferences. */ declare class WordRTFImportPreference extends Preference { /** * If true, bullets and numbers will be converted to embedded characters during * import. If false, bullets and numbers will be rendered by InDesign. */ convertBulletsAndNumbersToText: boolean; /** * The option for handling manual page breaks. */ convertPageBreaks: ConvertPageBreaks; /** * The policy for converting tables whose formatting has been removed. Note: * Valid when remove formatting is true. */ convertTablesTo: ConvertTablesOptions; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, imports endnotes as static text. Else live endnotes */ importAsStaticEndnotes: boolean; /** * If true, imports endnotes. */ importEndnotes: boolean; /** * If true, imports footnotes. */ importFootnotes: boolean; /** * If true, imports the index. */ importIndex: boolean; /** * If true, imports the table of contents. */ importTOC: boolean; /** * If true, imports unused styles. */ importUnusedStyles: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the WordRTFImportPreference (a Application). */ readonly parent: Application; /** * If true, preserves inline graphics. */ preserveGraphics: boolean; /** * If true, maintains character formatting in text whose formatting has been * removed. Note: Valid when remove formatting is true. */ preserveLocalOverrides: boolean; /** * If true, preserves comments and edits in the imported file. */ preserveTrackChanges: boolean; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, removes text and table formatting. */ removeFormatting: boolean; /** * The option for handling style name conflicts. */ resolveCharacterStyleClash: ResolveStyleClash; /** * The option for resolving conflicts that arise when paragraph styles have * matching names. */ resolveParagraphStyleClash: ResolveStyleClash; /** * If true, convert straight quotes and apostrophes in the imported text to * typographic quotation marks and apostrophes. */ useTypographersQuotes: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): WordRTFImportPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the * WordRTFImportPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of words. */ declare class Words { /** Returns the Word with the specified index or name. */ [index: number]: Word; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any Word in the collection. */ anyItem(): Word; /** * Displays the number of elements in the Word. */ count(): number; /** * Returns every Word in the collection. */ everyItem(): Word; /** * Returns the first Word in the collection. */ firstItem(): Word; /** * Returns the Word with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): Word; /** * Returns the Words within the specified range. * @param from The Word, index, or name at the beginning of the range. Can accept: Word, Long Integer or String. * @param to The Word, index, or name at the end of the range. Can accept: Word, Long Integer or String. */ itemByRange(from: number | Word | string, to: number | Word | string): Word[]; /** * Returns the last Word in the collection. */ lastItem(): Word; /** * Returns the middle Word in the collection. */ middleItem(): Word; /** * Returns the Word whose index follows the specified Word in the collection. * @param obj The Word whose index comes before the desired Word. */ nextItem(obj: Word): Word; /** * Returns the Word with the index previous to the specified index. * @param obj The index of the Word that follows the desired Word. */ previousItem(obj: Word): Word; /** * Generates a string which, if executed, will return the Word. */ toSource(): string; } /** * Wraps XML into an object. */ declare class XML { /** * Controls whether XML comments should be parsed (false) or ignored (true). */ static ignoreComments: boolean; /** * Controls whether XML preprocessing instructions should be parsed (false) or * ignored (true). */ static ignoreProcessingInstructions: boolean; /** * Controls whether whitespace should be parsed (false) or ignored (true). */ static ignoreWhitespace: boolean; /** * The number of spaces used to indent pretty-printed XML. */ static prettyIndent: number; /** * When true, XML is pretty-printed when converting to a string. */ static prettyPrinting: boolean; /** * Parses an XML string. Throws an error if the XML is incorrect. * @param text The text to parse. */ constructor(text: string); /** * Adds a namespace declaration to the node. Returns the XML object itself. * @param namespace The namespace to add. */ addNamespace(namespace: Namespace): XML; /** * Appends the given XML to this XML as a child. Returns the XML object itself. * @param child The child XML to add. */ appendChild(child: XML): XML; /** * Returns a list containing all attribute elements matching the given name. * @param name The attribute name to look for. */ attribute(name: string): XML; /** * Returns a list containing all attribute elements. */ attributes(): XML; /** * Returns a list containing all children of this XML matching the given * element name. * @param name The name or the index of the child element. */ child(name: string): XML; /** * Returns a number representing the ordinal position of this XML object within * the context of its parent. */ childIndex(): number; /** * Returns an XML object containing all the properties of this XML object in * order. */ children(): XML; /** * Returns an XML object containing the properties of this XML object that * represent XML comments. */ comments(): XML; /** * Checks if this XML object contains the given XML object. * @param xml The XML to search for. */ contains(xml: XML): boolean; /** * Creates a copy of this XML object. */ copy(): XML; /** * Returns an object containing the default parsing and print settings for XML. */ defaultSettings(): Object; /** * Returns all the XML-valued descendants of this XML object with the given * name. * @param name The name of the descendant to find. */ descendants(name?: string): XML; /** * Returns a list of XML children that are elements with a given name, or all * children that are XML elements. * @param name The element name. If not supplied, gets all children that are XML elements. */ elements(name?: string): XML; /** * Reports whether this XML object contains complex content. */ hasComplexContent(): boolean; /** * Reports whether this XML object contains simple content. */ hasSimpleContent(): boolean; /** * Returns an array of Namespace objects mirroring the current list of valid * namespaces at this element. */ inScopeNamespaces(): any[]; /** * Inserts the given child2 after the given child1 in this XML object and * returns this XML object. * @param child1 The child to insert the other child after. * @param child2 The XML to insert. */ insertChildAfter(child1: XML, child2: XML): void; /** * Inserts the given child2 before the given child1 in this XML object and * returns this XML object. * @param child1 The child to search for. * @param child2 The XML to insert. */ insertChildBefore(child1: XML, child2: XML): void; /** * Returns the number of elements contained in an XML list. If this XML object * is not a list, returns 1. */ length(): number; /** * Returns the local name of this XML object. */ localName(): string; /** * Returns a QName object containing the URI and the local name of the element. */ name(): QName; /** * Returns a Namespace object containing the namespace URI of the current * element. */ namespace(): Namespace; /** * Returns an array containing all namespace declarations of this XML object. */ namespaceDeclarations(): any[]; /** * Returns the type of this XML object as one of the strings "element", * "attribute", "comment", "processing-instruction", or "text". */ nodeKind(): string; /** * Puts all text nodes in this and all descendant XML objects into a normal * form by merging adjacent text nodes and eliminating empty text nodes. * Returns this XML object. */ normalize(): XML; /** * Returns the parent object of this XML object. */ parent(): XML; /** * Inserts a given child into this object before its existing XML properties, * and returns this XML object. * @param child The XML to insert. */ prependChild(child: XML): XML; /** * Returns a list of preprocessing instructions. * @param name The name of the preprocessing instruction to return. */ processingInstructions(name?: string): XML; /** * Removes the given namespace from this XML, and returns this XML. * @param namespace The namespace to remove. */ removeNamespace(namespace: Namespace): XML; /** * Replaces the value of specified XML properties of this XML object returns * this XML object. * @param name The property name. * @param value The XML with which to replace the value of the matching property. */ replace(name: string, value: XML): XML; /** * Replaces all of the XML-valued properties in this object with a new value, * and returns this XML object. * @param value The new value, which can be a single XML object or an XML list. */ setChildren(value: XML): XML; /** * Replaces the local name of this XML object with a string constructed from * the given name * @param name The name to set. */ setLocalName(name: string): void; /** * Replaces the name of this XML object with the given QName object. * @param name The fully qualified name. */ setName(name: QName): void; /** * Sets the namespace for this XML element. * @param namespace The namespace to set. */ setNamespace(namespace: Namespace): void; /** * Sets the parsing and print setting for XML using an object returned by the * settings() method. * @param obj The object containing the settings to set. */ setSettings(obj: Object): void; /** * Returns an object containing the current parsing and print settings for XML. */ settings(): Object; /** * Returns an XML list containing all XML properties of this XML object that * represent XML text nodes. */ text(): XML; /** * Returns the string representation of this object. */ toString(): string; /** * Returns an XML-encoded string representation of this XML object. */ toXMLString(): string; /** * Evaluates the given XPath expression in accordance with the W3C XPath * recommendation, using this XML object as the context node. * @param expr The XPath expression to use. */ xpath(expr: string): XML; } /** * An XML attribute. */ declare class XMLAttribute { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the XMLAttribute within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The name of the XMLAttribute. */ name: string; /** * The parent of the XMLAttribute (a XMLElement). */ readonly parent: XMLElement; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The value of the XMLAttribute. */ value: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Converts the XML attribute to a child element of its parent element. * @param located The location of the new XML element within the parent XML element of the XML attribute. (Optional) * @param markupTag The XML tag to apply to the new XML element. (Optional) */ convertToElement(located?: XMLElementLocation, markupTag?: XMLTag): XMLElement; /** * Resolves the object specifier, creating an array of object references. */ getElements(): XMLAttribute[]; /** * Deletes the XMLAttribute. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Selects the object. * @param existingSelection The selection status of the XMLAttribute in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Generates a string which, if executed, will return the XMLAttribute. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of XML attributes. */ declare class XMLAttributes { /** Returns the XMLAttribute with the specified index or name. */ [index: number]: XMLAttribute; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new XML attribute. * @param name The name of the attribute. * @param value The value of the attribute. * @param withProperties Initial values for properties of the new XMLAttribute (Optional) */ add(name: string, value: string, withProperties?: Object): XMLAttribute; /** * Returns any XMLAttribute in the collection. */ anyItem(): XMLAttribute; /** * Displays the number of elements in the XMLAttribute. */ count(): number; /** * Returns every XMLAttribute in the collection. */ everyItem(): XMLAttribute; /** * Returns the first XMLAttribute in the collection. */ firstItem(): XMLAttribute; /** * Returns the XMLAttribute with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): XMLAttribute; /** * Returns the XMLAttribute with the specified name. * @param name The name. */ itemByName(name: string): XMLAttribute; /** * Returns the XMLAttributes within the specified range. * @param from The XMLAttribute, index, or name at the beginning of the range. Can accept: XMLAttribute, Long Integer or String. * @param to The XMLAttribute, index, or name at the end of the range. Can accept: XMLAttribute, Long Integer or String. */ itemByRange(from: number | XMLAttribute | string, to: number | XMLAttribute | string): XMLAttribute[]; /** * Returns the last XMLAttribute in the collection. */ lastItem(): XMLAttribute; /** * Returns the middle XMLAttribute in the collection. */ middleItem(): XMLAttribute; /** * Returns the XMLAttribute whose index follows the specified XMLAttribute in * the collection. * @param obj The XMLAttribute whose index comes before the desired XMLAttribute. */ nextItem(obj: XMLAttribute): XMLAttribute; /** * Returns the XMLAttribute with the index previous to the specified index. * @param obj The index of the XMLAttribute that follows the desired XMLAttribute. */ previousItem(obj: XMLAttribute): XMLAttribute; /** * Generates a string which, if executed, will return the XMLAttribute. */ toSource(): string; } /** * An XML comment. */ declare class XMLComment extends XMLItem { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the XMLComment. */ readonly id: number; /** * The index of the XMLComment within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the XMLComment (a Document or XMLElement). */ readonly parent: Document | XMLElement; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The insertion point before the table in the story containing the table. */ readonly storyOffset: InsertionPoint; /** * The text of the XML comment. */ value: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the XMLComment. */ duplicate(): XMLComment; /** * Resolves the object specifier, creating an array of object references. */ getElements(): XMLComment[]; /** * Moves the element to the specified location. * @param to The location in relation to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. . Can accept: XMLItem or Text. (Optional) */ move(to: LocationOptions, reference?: XMLItem | Text): XMLComment; /** * Deletes the XMLComment. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Selects the object. * @param existingSelection The selection status of the XMLComment in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Generates a string which, if executed, will return the XMLComment. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of XML comments. */ declare class XMLComments { /** Returns the XMLComment with the specified index or name. */ [index: number]: XMLComment; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new XML comment. * @param value The value of the comment. (Optional) * @param storyOffset The location within the story, specified as an insertion point. Can accept: InsertionPoint or Long Integer. (Optional) * @param withProperties Initial values for properties of the new XMLComment (Optional) */ add(value?: string, storyOffset?: InsertionPoint | number, withProperties?: Object): XMLComment; /** * Returns any XMLComment in the collection. */ anyItem(): XMLComment; /** * Displays the number of elements in the XMLComment. */ count(): number; /** * Returns every XMLComment in the collection. */ everyItem(): XMLComment; /** * Returns the first XMLComment in the collection. */ firstItem(): XMLComment; /** * Returns the XMLComment with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): XMLComment; /** * Returns the XMLComment with the specified ID. * @param id The ID. */ itemByID(id: number): XMLComment; /** * Returns the XMLComments within the specified range. * @param from The XMLComment, index, or name at the beginning of the range. Can accept: XMLComment, Long Integer or String. * @param to The XMLComment, index, or name at the end of the range. Can accept: XMLComment, Long Integer or String. */ itemByRange(from: number | XMLComment | string, to: number | XMLComment | string): XMLComment[]; /** * Returns the last XMLComment in the collection. */ lastItem(): XMLComment; /** * Returns the middle XMLComment in the collection. */ middleItem(): XMLComment; /** * Returns the XMLComment whose index follows the specified XMLComment in the * collection. * @param obj The XMLComment whose index comes before the desired XMLComment. */ nextItem(obj: XMLComment): XMLComment; /** * Returns the XMLComment with the index previous to the specified index. * @param obj The index of the XMLComment that follows the desired XMLComment. */ previousItem(obj: XMLComment): XMLComment; /** * Generates a string which, if executed, will return the XMLComment. */ toSource(): string; } /** * An XML element. */ declare class XMLElement extends XMLItem { /** * A collection of table cells. */ readonly cells: Cells; /** * A collection of characters. */ readonly characters: Characters; /** * The contents of the text. Can return: String or SpecialCharacters * enumerator. */ contents: string | SpecialCharacters; /** * A collection of EPS files. */ readonly epss: EPSs; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * A collection of imported graphics in any graphic file format (vector, * metafile, or bitmap). */ readonly graphics: Graphics; /** * The unique ID of the XMLElement. */ readonly id: number; /** * A collection of bitmap images in any bitmap file format (including TIFF, * JPEG, or GIF). */ readonly images: Images; /** * The index of the XMLElement within its containing object. */ readonly index: number; /** * A collection of insertion points. */ readonly insertionPoints: InsertionPoints; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A collection of lines. */ readonly lines: Lines; /** * The XML tag applied to the element. Can also accept: String. */ markupTag: XMLTag | string; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * A collection of paragraphs. */ readonly paragraphs: Paragraphs; /** * The parent of the XMLElement (a Document or XMLElement). */ readonly parent: Document | XMLElement; /** * The story that contains the text. */ readonly parentStory: Story; /** * A collection of PDF files. */ readonly pdfs: PDFs; /** * A collection of PICT graphics. */ readonly picts: PICTs; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * A collection of stories. */ readonly stories: Stories; /** * The insertion point before the table in the story containing the table. */ readonly storyOffset: InsertionPoint; /** * A collection of SVG files. */ readonly svgs: SVGs; /** * A collection of tables. */ readonly tables: Tables; /** * A collection of text columns. */ readonly textColumns: TextColumns; /** * A collection of text style ranges. */ readonly textStyleRanges: TextStyleRanges; /** * A collection of text objects. */ readonly texts: Texts; /** * A collection of WMF graphics. */ readonly wmfs: WMFs; /** * A collection of words. */ readonly words: Words; /** * A collection of XML attributes. */ readonly xmlAttributes: XMLAttributes; /** * A collection of XML comments. */ readonly xmlComments: XMLComments; /** * The text content or page item referred to by the element. Can return: Text, * Story, PageItem, Movie, Sound, Graphic, Table or Cell. */ readonly xmlContent: Graphic | Movie | PageItem | Sound | Story | Table | Text | Cell; /** * A collection of XML elements. */ readonly xmlElements: XMLElements; /** * A collection of XML instructions. */ readonly xmlInstructions: XMLInstructions; /** * A collection of XML items. */ readonly xmlItems: XMLItems; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Applies a cell style to the table cells associated with the XMLElement. * @param using The cell style to apply. Can accept: String or CellStyle. * @param clearingOverrides If true, removes local formatting before applying the cell style. (Optional) */ applyCellStyle(using: string | CellStyle, clearingOverrides?: boolean): void; /** * Applies the specified character style to the text content of the XMLElement. * @param using The character style to apply. Can accept: String or CharacterStyle. */ applyCharacterStyle(using: string | CharacterStyle): void; /** * Applies an object style to the frame associated with the XMLElement. * @param using The object style to apply. Can accept: String or ObjectStyle. * @param clearingOverrides If true, removes local formatting before applying the object style. (Optional) * @param clearingOverridesThroughRootObjectStyle If true, clears unchecked category attributes through the root style. (Optional) */ applyObjectStyle(using: string | ObjectStyle, clearingOverrides?: boolean, clearingOverridesThroughRootObjectStyle?: boolean): void; /** * Applies the specified paragraph style to the text content of the XMLElement. * @param using The paragraph style to apply. Can accept: String or ParagraphStyle. * @param clearingOverrides If true, clears any attributes before applying the style. (Optional) */ applyParagraphStyle(using: string | ParagraphStyle, clearingOverrides?: boolean): void; /** * Applies a table style to the table associated with the XMLElement. * @param using The table style to apply. Can accept: String or TableStyle. * @param clearingOverrides If true, removes local formatting before applying the table style. (Optional) */ applyTableStyle(using: string | TableStyle, clearingOverrides?: boolean): void; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value and replaces the text * with the change character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeTransliterate(reverseOrder?: boolean): Text[]; /** * Converts the content of the XML element to a table. * @param rowTag The XML tag that indicates a table row. * @param cellTag The XML tag that indicates a table cell. */ convertElementToTable(rowTag: XMLTag, cellTag: XMLTag): Table; /** * Converts the XMLElement to an attribute of its parent element. * @param using The name to give to the new attribute. (Optional) */ convertToAttribute(using?: string): XMLAttribute; /** * Duplicates the XMLElement. */ duplicate(): XMLElement; /** * Evaluates an XPath expression starting at this XML element in the structure. * @param using The XPath expression. * @param prefixMappingTable The namespace mapping table. Can accept: Array of Arrays of 2 Strings. (Optional) */ evaluateXPathExpression(using: string, prefixMappingTable?: string[][][][]): XMLItem[]; /** * Exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ exportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): void; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findTransliterate(reverseOrder?: boolean): Text[]; /** * Resolves the object specifier, creating an array of object references. */ getElements(): XMLElement[]; /** * Imports the specified XML file into an InDesign document. * @param from The XML file. */ importXML(from: File): void; /** * Inserts the specified text as content before, in, or after the XML element. * @param using The text to be inserted. Can accept: String or SpecialCharacters enumerator. * @param position The position at which to insert the text. Note that text inserted before or after the element does not become part of the content of the element. Instead, it becomes content of the parent of the element. */ insertTextAsContent(using: string | SpecialCharacters, position: XMLElementPosition): Text; /** * Associates the object with the specified XML element while preserving * existing content. * @param using The object to mark up. Can accept: PageItem, Movie, Sound, Graphic, Story, Text or Table. */ markup(using: Graphic | Movie | PageItem | Sound | Story | Text | Table): void; /** * Moves the element to the specified location. * @param to The location in relation to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. . Can accept: XMLItem or Text. (Optional) */ move(to: LocationOptions, reference?: XMLItem | Text): XMLElement; /** * Associates the XML element with a copy of a page item. * @param on The page or spread on which to create the new page item. Can accept: Spread, Page or MasterSpread. * @param placePoint The page coordinates of the top left corner of the page item, in the format [y1, x1] * @param copyItem The page item to copy. * @param retainExistingFrame If true, associates the XML element with the existing page item and moves the page item (rather than a copy of the page item). (Optional) */ placeIntoCopy(on: Page | Spread | MasterSpread, placePoint: (number | string)[], copyItem: PageItem, retainExistingFrame?: boolean): PageItem; /** * Places the XML element into a new rectangular page item. If the XML element * was already associated with a page item, that page item is deleted. * @param on The page or spread on which to create the new page item. Can accept: Spread, Page or MasterSpread. * @param geometricBounds The bounds of the page item excluding the stroke width, in the format [y1, x1, y2, x2]. */ placeIntoFrame(on: Page | Spread | MasterSpread, geometricBounds: (number | string)[]): PageItem; /** * Associates an existing page item with the XML element and places it into an * inline frame. * @param copyItem The page item to copy. * @param retainExistingFrame If true, moves the existing page item. If false, moves a copy of the page item. (Optional) */ placeIntoInlineCopy(copyItem: PageItem, retainExistingFrame?: boolean): PageItem; /** * Places an XML element into an inline frame. * @param dimensions The dimensions of the inline frame in the format [width, height]. */ placeIntoInlineFrame(dimensions: (number | string)[]): PageItem; /** * Places XML content into the story, replacing the existing content. * @param using The object to place into. Can accept: Story, PageItem, Graphic, Movie or Sound. */ placeXML(using: Graphic | Movie | PageItem | Story | Sound): void; /** * Deletes the XMLElement. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Selects the object. * @param existingSelection The selection status of the XMLElement in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Replaces the content of XML element with content imported from a file. * @param using The file path to the import file. * @param relativeBasePath Base path used to resolve relative paths. (Optional) */ setContent(using: string, relativeBasePath?: string): PageItem; /** * Stores the object in the specified library. * @param using The library in which to store the object. * @param withProperties Initial values for properties of the new XMLElement (Optional) */ store(using: Library, withProperties?: Object): Asset; /** * Generates a string which, if executed, will return the XMLElement. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; /** * Untags an element. */ untag(): void; /** * Validates the element against a DTD. * @param maximumErrors The maximum number of validation errors to generate. (Optional) */ validate(maximumErrors?: number): ValidationError[]; } /** * Location options for XML elements. */ declare enum XMLElementLocation { /** * Locates the element at the end of the containing object. */ ELEMENT_END = 1483042404, /** * Locates the element at the beginning of the containing object. */ ELEMENT_START = 1482844014, } /** * Options for specifying position relative to the reference XML element or * withing the XML element. */ declare enum XMLElementPosition { /** * Specifies the position after the XML element. */ AFTER_ELEMENT = 1482778228, /** * Specifies the position before the XML element. */ BEFORE_ELEMENT = 1482843494, /** * Specifies the position at the end of the XML element. */ ELEMENT_END = 1483042404, /** * Specifies the position at the beginning of the XML element. */ ELEMENT_START = 1482844014, } /** * A collection of XML elements. */ declare class XMLElements { /** Returns the XMLElement with the specified index or name. */ [index: number]: XMLElement; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new XML element. * @param markupTag The XML tag used to identify the element. Can accept: String or XMLTag. * @param xmlContent The content to be marked up. Can accept: Text, Story, PageItem, Movie, Sound, Graphic, Table or Cell. (Optional) * @param withProperties Initial values for properties of the new XMLElement (Optional) */ add(markupTag: string | XMLTag, xmlContent?: Graphic | Movie | PageItem | Sound | Story | Table | Text | Cell, withProperties?: Object): XMLElement; /** * Returns any XMLElement in the collection. */ anyItem(): XMLElement; /** * Displays the number of elements in the XMLElement. */ count(): number; /** * Returns every XMLElement in the collection. */ everyItem(): XMLElement; /** * Returns the first XMLElement in the collection. */ firstItem(): XMLElement; /** * Returns the XMLElement with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): XMLElement; /** * Returns the XMLElement with the specified ID. * @param id The ID. */ itemByID(id: number): XMLElement; /** * Returns the XMLElement with the specified name. * @param name The name. */ itemByName(name: string): XMLElement; /** * Returns the XMLElements within the specified range. * @param from The XMLElement, index, or name at the beginning of the range. Can accept: XMLElement, Long Integer or String. * @param to The XMLElement, index, or name at the end of the range. Can accept: XMLElement, Long Integer or String. */ itemByRange(from: number | XMLElement | string, to: number | XMLElement | string): XMLElement[]; /** * Returns the last XMLElement in the collection. */ lastItem(): XMLElement; /** * Returns the middle XMLElement in the collection. */ middleItem(): XMLElement; /** * Returns the XMLElement whose index follows the specified XMLElement in the * collection. * @param obj The XMLElement whose index comes before the desired XMLElement. */ nextItem(obj: XMLElement): XMLElement; /** * Returns the XMLElement with the index previous to the specified index. * @param obj The index of the XMLElement that follows the desired XMLElement. */ previousItem(obj: XMLElement): XMLElement; /** * Generates a string which, if executed, will return the XMLElement. */ toSource(): string; } /** * A mapping object that maps a style (paragraph, character, table, or cell) to * an XML tag. */ declare class XMLExportMap { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, includes empty stories when mapping styles to tags. */ includeEmptyStories: boolean; /** * If true, includes stories on master spreads when mapping styles to tags. */ includeMasterPageStories: boolean; /** * If true, includes stories on the pasteboard when mapping styles to tags. */ includePasteboardStories: boolean; /** * The index of the XMLExportMap within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The style mapped to the XML tag. Can return: ParagraphStyle, CharacterStyle, * TableStyle or CellStyle. Can also accept: String. */ readonly mappedStyle: CharacterStyle | ParagraphStyle | string | TableStyle | CellStyle; /** * The XML tag applied to the element. Can also accept: String. */ markupTag: XMLTag | string; /** * The parent of the XMLExportMap (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): XMLExportMap[]; /** * Deletes the XMLExportMap. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the XMLExportMap. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of XML export maps. */ declare class XMLExportMaps { /** Returns the XMLExportMap with the specified index or name. */ [index: number]: XMLExportMap; /** * The number of objects in the collection. */ readonly length: number; /** * Create a new mapping * @param mappedStyle The mapped style. Can accept: ParagraphStyle, CharacterStyle, TableStyle, CellStyle or String. * @param markupTag The tag to map. Can accept: XMLTag or String. * @param withProperties Initial values for properties of the new XMLExportMap (Optional) */ add(mappedStyle: CellStyle | CharacterStyle | ParagraphStyle | TableStyle | string, markupTag: XMLTag | string, withProperties?: Object): XMLExportMap; /** * Returns any XMLExportMap in the collection. */ anyItem(): XMLExportMap; /** * Displays the number of elements in the XMLExportMap. */ count(): number; /** * Returns every XMLExportMap in the collection. */ everyItem(): XMLExportMap; /** * Returns the first XMLExportMap in the collection. */ firstItem(): XMLExportMap; /** * Returns the XMLExportMap with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): XMLExportMap; /** * Returns the XMLExportMaps within the specified range. * @param from The XMLExportMap, index, or name at the beginning of the range. Can accept: XMLExportMap, Long Integer or String. * @param to The XMLExportMap, index, or name at the end of the range. Can accept: XMLExportMap, Long Integer or String. */ itemByRange(from: number | XMLExportMap | string, to: number | XMLExportMap | string): XMLExportMap[]; /** * Returns the last XMLExportMap in the collection. */ lastItem(): XMLExportMap; /** * Returns the middle XMLExportMap in the collection. */ middleItem(): XMLExportMap; /** * Returns the XMLExportMap whose index follows the specified XMLExportMap in * the collection. * @param obj The XMLExportMap whose index comes before the desired XMLExportMap. */ nextItem(obj: XMLExportMap): XMLExportMap; /** * Returns the XMLExportMap with the index previous to the specified index. * @param obj The index of the XMLExportMap that follows the desired XMLExportMap. */ previousItem(obj: XMLExportMap): XMLExportMap; /** * Generates a string which, if executed, will return the XMLExportMap. */ toSource(): string; } /** * XML export preferences. */ declare class XMLExportPreference extends Preference { /** * If true, transforms the XML using an XSLT file. */ allowTransform: boolean; /** * If true, replaces special characters with character references. */ characterReferences: boolean; /** * If true, copies formatted images to the images subfolder. */ copyFormattedImages: boolean; /** * If true, copies optimized images to the images subfolder. */ copyOptimizedImages: boolean; /** * If true, copies original images to the images subfolder. */ copyOriginalImages: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, excludes the DTD from the exported XML content. */ excludeDtd: boolean; /** * If true, exports XML content from the selected XML element. If false, * exports the entire document. */ exportFromSelected: boolean; /** * The export format for untagged tables in tagged stories. */ exportUntaggedTablesFormat: XMLExportUntaggedTablesFormat; /** * The file encoding type for exporting XML content. */ fileEncoding: XMLFileEncoding; /** * If true, generates interlaced GIFs. Note: Not valid when image conversion is * JPEG. */ gifOptionsInterlaced: boolean; /** * The color palette for GIF conversion. Note: Not valid when image conversion * is JPEG. */ gifOptionsPalette: GIFOptionsPalette; /** * The file format to use for converted images. Note: Valid only when copy * optimized images and/or copy formatted images is true. */ imageConversion: ImageConversion; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The formatting method for converted JPEG images. Note: Not valid when image * conversion is GIF. */ jpegOptionsFormat: JPEGOptionsFormat; /** * The quality of converted JPEG images. Note: Not valid when image conversion * is GIF. */ jpegOptionsQuality: JPEGOptionsQuality; /** * The parent of the XMLExportPreference (a Application or Document). */ readonly parent: Application | Document; /** * The preferred browser for viewing XML. Can return: File or NothingEnum * enumerator. */ preferredBrowser: File | NothingEnum; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, includes Ruby text in the exported XML content. */ ruby: boolean; /** * The name of the XSLT file. Note: Valid when allow transform is true. Can * return: File or XMLTransformFile enumerator. */ transformFilename: File | XMLTransformFile; /** * If true, displays exported XML content in a specified viewer. */ viewAfterExport: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): XMLExportPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the XMLExportPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Export options for untagged tables in tagged stories. */ declare enum XMLExportUntaggedTablesFormat { /** * Exports untagged tables as CALS XML. */ CALS = 1484022643, /** * Does not export untagged tables. */ NONE = 1852796517, } /** * File encoding options for exported XML content. */ declare enum XMLFileEncoding { /** * Shift-JIS encoding. */ SHIFT_JIS = 1249077875, /** * UTF-16 encoding. */ UTF16 = 1937125686, /** * UTF-8 encoding. */ UTF8 = 1937134904, } /** * A mapping object that maps an XML tag to a style (paragraph, character, * table, or cell). */ declare class XMLImportMap { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the XMLImportMap within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The style mapped to the XML tag. Can return: ParagraphStyle, CharacterStyle, * TableStyle or CellStyle. Can also accept: String. */ mappedStyle: CharacterStyle | ParagraphStyle | string | TableStyle | CellStyle; /** * The XML tag applied to the element. Can also accept: String. */ readonly markupTag: XMLTag | string; /** * The parent of the XMLImportMap (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): XMLImportMap[]; /** * Deletes the XMLImportMap. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the XMLImportMap. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of XML import maps. */ declare class XMLImportMaps { /** Returns the XMLImportMap with the specified index or name. */ [index: number]: XMLImportMap; /** * The number of objects in the collection. */ readonly length: number; /** * Create a new mapping * @param markupTag The tag to map. Can accept: XMLTag or String. * @param mappedStyle the mapped style. Can accept: ParagraphStyle, CharacterStyle, TableStyle, CellStyle or String. * @param withProperties Initial values for properties of the new XMLImportMap (Optional) */ add(markupTag: XMLTag | string, mappedStyle: CellStyle | CharacterStyle | ParagraphStyle | TableStyle | string, withProperties?: Object): XMLImportMap; /** * Returns any XMLImportMap in the collection. */ anyItem(): XMLImportMap; /** * Displays the number of elements in the XMLImportMap. */ count(): number; /** * Returns every XMLImportMap in the collection. */ everyItem(): XMLImportMap; /** * Returns the first XMLImportMap in the collection. */ firstItem(): XMLImportMap; /** * Returns the XMLImportMap with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): XMLImportMap; /** * Returns the XMLImportMaps within the specified range. * @param from The XMLImportMap, index, or name at the beginning of the range. Can accept: XMLImportMap, Long Integer or String. * @param to The XMLImportMap, index, or name at the end of the range. Can accept: XMLImportMap, Long Integer or String. */ itemByRange(from: number | XMLImportMap | string, to: number | XMLImportMap | string): XMLImportMap[]; /** * Returns the last XMLImportMap in the collection. */ lastItem(): XMLImportMap; /** * Returns the middle XMLImportMap in the collection. */ middleItem(): XMLImportMap; /** * Returns the XMLImportMap whose index follows the specified XMLImportMap in * the collection. * @param obj The XMLImportMap whose index comes before the desired XMLImportMap. */ nextItem(obj: XMLImportMap): XMLImportMap; /** * Returns the XMLImportMap with the index previous to the specified index. * @param obj The index of the XMLImportMap that follows the desired XMLImportMap. */ previousItem(obj: XMLImportMap): XMLImportMap; /** * Generates a string which, if executed, will return the XMLImportMap. */ toSource(): string; } /** * XML import preferences. */ declare class XMLImportPreference extends Preference { /** * If true, transforms the XML using an XSLT file. */ allowTransform: boolean; /** * If true, creates a link to the imported XML file. If false, embeds the file. */ createLinkToXML: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, ignores elements that do not match the existing structure. Note: * Valid only when import style is merge. */ ignoreUnmatchedIncoming: boolean; /** * If true, leaves existing content in place if the matching XML content * contains only whitespace characters such as a carriage return or a tab * character. Note: Valid only when import style is merge. */ ignoreWhitespace: boolean; /** * If true, imports CALS tables as InDesign tables. */ importCALSTables: boolean; /** * The style of incorporating imported XML content into the document. */ importStyle: XMLImportStyles; /** * If true, imports text into tables if tags match placeholder tables and their * cells. Note: Valid only when import style is merge. */ importTextIntoTables: boolean; /** * If true, imports into the selected XML element. If false, imports at the * root element. */ importToSelected: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the XMLImportPreference (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, deletes existing elements or placeholders in the document that do * not have matches in the XML file. Note: Valid only when import style is * merge. */ removeUnmatchedExisting: boolean; /** * If true, repeating text elements inherit the formatting applied to * placeholder text. Note: Valid only when import style is merge. */ repeatTextElements: boolean; /** * The name of the XSLT file. Note: Valid when allow transform is true. Can * return: File or XMLTransformFile enumerator. */ transformFilename: File | XMLTransformFile; /** * Stylesheet parameters as a list of name/value pairs in the format [[name, * value], [name, value], ...]. Can return: Ordered array containing * name:String, value:String. */ transformParameters: (any[] | string)[]; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): XMLImportPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the XMLImportPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Options for incorporating imported XML content. */ declare enum XMLImportStyles { /** * Appends the imported content. */ APPEND_IMPORT = 1481466217, /** * Merges the imported content. */ MERGE_IMPORT = 1481469289, } /** * An XML processing instruction. */ declare class XMLInstruction extends XMLItem { /** * A value that tells the application reading the exported XML file what to do * with the processing instruction. */ data: string; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the XMLInstruction. */ readonly id: number; /** * The index of the XMLInstruction within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the XMLInstruction (a Document or XMLElement). */ readonly parent: Document | XMLElement; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The insertion point before the table in the story containing the table. */ readonly storyOffset: InsertionPoint; /** * A name that identifies the processing instruction to an application reading * the exported XML file. */ target: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the XMLInstruction. */ duplicate(): XMLInstruction; /** * Resolves the object specifier, creating an array of object references. */ getElements(): XMLInstruction[]; /** * Moves the element to the specified location. * @param to The location in relation to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. . Can accept: XMLItem or Text. (Optional) */ move(to: LocationOptions, reference?: XMLItem | Text): XMLInstruction; /** * Deletes the XMLInstruction. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Selects the object. * @param existingSelection The selection status of the XMLInstruction in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Generates a string which, if executed, will return the XMLInstruction. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of XML instructions. */ declare class XMLInstructions { /** Returns the XMLInstruction with the specified index or name. */ [index: number]: XMLInstruction; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a new XML processing instruction. * @param target A name that identifies the processing instruction to an application reading the exported XML file. * @param data A value that tells the application what to do with the processing instruction identified in the target. (Optional) * @param storyOffset The location within the story, specified as an insertion point. Can accept: InsertionPoint or Long Integer. (Optional) * @param withProperties Initial values for properties of the new XMLInstruction (Optional) */ add(target: string, data?: string, storyOffset?: InsertionPoint | number, withProperties?: Object): XMLInstruction; /** * Returns any XMLInstruction in the collection. */ anyItem(): XMLInstruction; /** * Displays the number of elements in the XMLInstruction. */ count(): number; /** * Returns every XMLInstruction in the collection. */ everyItem(): XMLInstruction; /** * Returns the first XMLInstruction in the collection. */ firstItem(): XMLInstruction; /** * Returns the XMLInstruction with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): XMLInstruction; /** * Returns the XMLInstruction with the specified ID. * @param id The ID. */ itemByID(id: number): XMLInstruction; /** * Returns the XMLInstructions within the specified range. * @param from The XMLInstruction, index, or name at the beginning of the range. Can accept: XMLInstruction, Long Integer or String. * @param to The XMLInstruction, index, or name at the end of the range. Can accept: XMLInstruction, Long Integer or String. */ itemByRange(from: number | XMLInstruction | string, to: number | XMLInstruction | string): XMLInstruction[]; /** * Returns the last XMLInstruction in the collection. */ lastItem(): XMLInstruction; /** * Returns the middle XMLInstruction in the collection. */ middleItem(): XMLInstruction; /** * Returns the XMLInstruction whose index follows the specified XMLInstruction * in the collection. * @param obj The XMLInstruction whose index comes before the desired XMLInstruction. */ nextItem(obj: XMLInstruction): XMLInstruction; /** * Returns the XMLInstruction with the index previous to the specified index. * @param obj The index of the XMLInstruction that follows the desired XMLInstruction. */ previousItem(obj: XMLInstruction): XMLInstruction; /** * Generates a string which, if executed, will return the XMLInstruction. */ toSource(): string; } /** * An XML item. */ declare class XMLItem { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the XMLItem. */ readonly id: number; /** * The index of the XMLItem within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the XMLItem (a Document or XMLElement). */ readonly parent: Document | XMLElement; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Duplicates the XMLItem. */ duplicate(): XMLItem; /** * Resolves the object specifier, creating an array of object references. */ getElements(): XMLItem[]; /** * Deletes the XMLItem. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Selects the object. * @param existingSelection The selection status of the XMLItem in relation to previously selected objects. (Optional) */ select(existingSelection?: SelectionOptions): void; /** * Generates a string which, if executed, will return the XMLItem. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of XML items. */ declare class XMLItems { /** Returns the XMLItem with the specified index or name. */ [index: number]: XMLItem; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any XMLItem in the collection. */ anyItem(): XMLItem; /** * Displays the number of elements in the XMLItem. */ count(): number; /** * Returns every XMLItem in the collection. */ everyItem(): XMLItem; /** * Returns the first XMLItem in the collection. */ firstItem(): XMLItem; /** * Returns the XMLItem with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): XMLItem; /** * Returns the XMLItem with the specified ID. * @param id The ID. */ itemByID(id: number): XMLItem; /** * Returns the XMLItems within the specified range. * @param from The XMLItem, index, or name at the beginning of the range. Can accept: XMLItem, Long Integer or String. * @param to The XMLItem, index, or name at the end of the range. Can accept: XMLItem, Long Integer or String. */ itemByRange(from: number | XMLItem | string, to: number | XMLItem | string): XMLItem[]; /** * Returns the last XMLItem in the collection. */ lastItem(): XMLItem; /** * Returns the middle XMLItem in the collection. */ middleItem(): XMLItem; /** * Returns the XMLItem whose index follows the specified XMLItem in the * collection. * @param obj The XMLItem whose index comes before the desired XMLItem. */ nextItem(obj: XMLItem): XMLItem; /** * Returns the XMLItem with the index previous to the specified index. * @param obj The index of the XMLItem that follows the desired XMLItem. */ previousItem(obj: XMLItem): XMLItem; /** * Generates a string which, if executed, will return the XMLItem. */ toSource(): string; } /** * An XML list object. */ declare class XMLList { } /** * XML preferences. */ declare class XMLPreference extends Preference { /** * The color of the default cell tag, specified either as an array of three * doubles, each in the range 0 to 255 and representing R, G, and B values, or * as a UI color. Note: Valid only when default cell tag name value creates a * new tag. Does not update the color of an existing tag. . Can return: Array * of 3 Reals (0 - 255) or UIColors enumerator. */ defaultCellTagColor: (number[][] | UIColors)[]; /** * The name of the default tag to use for new table cell elements. Note: Either * specifies an existing tag or creates a new tag. */ defaultCellTagName: string; /** * The color to give a new image tag, specified either as an array of three * doubles, each in the range 0 to 255 and representing R, G, and B values, or * as a UI color. Note: Used only when the tag needs to be created. Can return: * Array of 3 Reals (0 - 255) or UIColors enumerator. */ defaultImageTagColor: (number[][] | UIColors)[]; /** * The default name for new image elements created automatically. */ defaultImageTagName: string; /** * The color of the default story tag, specified either as an array of three * doubles, each in the range 0 to 255 and representing R, G, and B values, or * as a UI color. Notes: Valid only when default story tag name value creates a * new tag. Does not update the color of an existing tag. Can return: Array of * 3 Reals (0 - 255) or UIColors enumerator. */ defaultStoryTagColor: (number[][] | UIColors)[]; /** * The name of the default tag to use for new story elements. Note: Either * specifies an existing tag or creates a new tag. */ defaultStoryTagName: string; /** * The color of the default table tag, specified either as an array of three * doubles, each in the range 0 to 255 and representing R, G, and B values, or * as a UI color. Notes: Valid only when default table tag name value creates a * new tag. Does not update the color of an existing tag. . Can return: Array * of 3 Reals (0 - 255) or UIColors enumerator. */ defaultTableTagColor: (number[][] | UIColors)[]; /** * The name of the default tag to use for new table elements. Note: Either * specifies an existing tag or creates a new tag. */ defaultTableTagName: string; /** * The preference for deleting the element when deleting the associated content * like a page item or a text fragment. */ deleteElementOnContentDeletion: boolean; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the XMLPreference (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): XMLPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the XMLPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * An XML element matched by a rule or rules in the current XML rule set. */ declare class XMLRuleMatchData { /** * An XML element matched by a rule or rules in the current XML rule set. */ readonly element: XMLItem; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The index of the XMLRuleMatchData within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The indices of matching XML rules in the rule set. */ readonly matchRules: number[]; /** * The parent of the XMLRuleMatchData (a XMLRuleProcessor). */ readonly parent: XMLRuleProcessor; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): XMLRuleMatchData[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the XMLRuleMatchData. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * An XML rule processor. */ declare class XMLRuleProcessor { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * If true, the XML rule process has halted. */ readonly halted: boolean; /** * The unique ID of the XMLRuleProcessor. */ readonly id: number; /** * The index of the XMLRuleProcessor within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the XMLRuleProcessor; this is an alias to the XMLRuleProcessor's * label property. */ name: string; /** * The parent of the XMLRuleProcessor (a Application). */ readonly parent: Application; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The XPath condition paths of the rules in the rule set. */ readonly rulePaths: string[]; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Stop processing XML rule set. */ endProcessingRuleSet(): void; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds the next matching XML element. */ findNextMatch(): XMLRuleMatchData; /** * Resolves the object specifier, creating an array of object references. */ getElements(): XMLRuleProcessor[]; /** * Halt the XML rule processor. */ halt(): void; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the XMLRuleProcessor. */ remove(): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Do not process XML elements (children) of the current XML element. */ skipChildren(): void; /** * Start processing an XML rule set. * @param initialElement The XML element at which to start processing the rule set. */ startProcessingRuleSet(initialElement: XMLElement): XMLRuleMatchData; /** * Process the XML elements of the current XML element. */ startProcessingSubtree(): XMLRuleMatchData; /** * Generates a string which, if executed, will return the XMLRuleProcessor. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of XML rule processors. */ declare class XMLRuleProcessors { /** Returns the XMLRuleProcessor with the specified index or name. */ [index: number]: XMLRuleProcessor; /** * The number of objects in the collection. */ readonly length: number; /** * Create a new XMLRuleProcessor * @param rulePaths The XPath condition paths of the rules in the rule set. * @param prefixMappingTable The namespace mapping table. Can accept: Array of Arrays of 2 Strings. (Optional) * @param withProperties Initial values for properties of the new XMLRuleProcessor (Optional) */ add(rulePaths: string[], prefixMappingTable?: string[][][][], withProperties?: Object): XMLRuleProcessor; /** * Returns any XMLRuleProcessor in the collection. */ anyItem(): XMLRuleProcessor; /** * Displays the number of elements in the XMLRuleProcessor. */ count(): number; /** * Returns every XMLRuleProcessor in the collection. */ everyItem(): XMLRuleProcessor; /** * Returns the first XMLRuleProcessor in the collection. */ firstItem(): XMLRuleProcessor; /** * Returns the XMLRuleProcessor with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): XMLRuleProcessor; /** * Returns the XMLRuleProcessor with the specified ID. * @param id The ID. */ itemByID(id: number): XMLRuleProcessor; /** * Returns the XMLRuleProcessor with the specified name. * @param name The name. */ itemByName(name: string): XMLRuleProcessor; /** * Returns the XMLRuleProcessors within the specified range. * @param from The XMLRuleProcessor, index, or name at the beginning of the range. Can accept: XMLRuleProcessor, Long Integer or String. * @param to The XMLRuleProcessor, index, or name at the end of the range. Can accept: XMLRuleProcessor, Long Integer or String. */ itemByRange(from: number | XMLRuleProcessor | string, to: number | XMLRuleProcessor | string): XMLRuleProcessor[]; /** * Returns the last XMLRuleProcessor in the collection. */ lastItem(): XMLRuleProcessor; /** * Returns the middle XMLRuleProcessor in the collection. */ middleItem(): XMLRuleProcessor; /** * Returns the XMLRuleProcessor whose index follows the specified * XMLRuleProcessor in the collection. * @param obj The XMLRuleProcessor whose index comes before the desired XMLRuleProcessor. */ nextItem(obj: XMLRuleProcessor): XMLRuleProcessor; /** * Returns the XMLRuleProcessor with the index previous to the specified index. * @param obj The index of the XMLRuleProcessor that follows the desired XMLRuleProcessor. */ previousItem(obj: XMLRuleProcessor): XMLRuleProcessor; /** * Generates a string which, if executed, will return the XMLRuleProcessor. */ toSource(): string; } /** * An XML markup tag. */ declare class XMLTag { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The unique ID of the XMLTag. */ readonly id: number; /** * The index of the XMLTag within its containing object. */ readonly index: number; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * A property that can be set to any string. */ label: string; /** * The name of the XMLTag. */ name: string; /** * The parent of the XMLTag (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The color of the tag, specified either as an array of three doubles, each in * the range 0 to 255 and representing R, G, and B values, or as a UI color. * Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. */ tagColor: (number[][] | UIColors)[]; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Resolves the object specifier, creating an array of object references. */ getElements(): XMLTag[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * Deletes the tag. * @param replacingWith The tag to substitute. Can accept: XMLTag or String. */ remove(replacingWith: XMLTag | string): void; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the XMLTag. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of XML tags. */ declare class XMLTags { /** Returns the XMLTag with the specified index or name. */ [index: number]: XMLTag; /** * The number of objects in the collection. */ readonly length: number; /** * Creates a tag. * @param name The name of the tag. (Optional) * @param tagColor The dolor of the tag, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Can accept: Array of 3 Reals (0 - 255) or UIColors enumerator. (Optional) * @param withProperties Initial values for properties of the new XMLTag (Optional) */ add(name?: string, tagColor?: (number[][] | UIColors)[], withProperties?: Object): XMLTag; /** * Returns any XMLTag in the collection. */ anyItem(): XMLTag; /** * Displays the number of elements in the XMLTag. */ count(): number; /** * Returns every XMLTag in the collection. */ everyItem(): XMLTag; /** * Returns the first XMLTag in the collection. */ firstItem(): XMLTag; /** * Returns the XMLTag with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): XMLTag; /** * Returns the XMLTag with the specified ID. * @param id The ID. */ itemByID(id: number): XMLTag; /** * Returns the XMLTag with the specified name. * @param name The name. */ itemByName(name: string): XMLTag; /** * Returns the XMLTags within the specified range. * @param from The XMLTag, index, or name at the beginning of the range. Can accept: XMLTag, Long Integer or String. * @param to The XMLTag, index, or name at the end of the range. Can accept: XMLTag, Long Integer or String. */ itemByRange(from: number | XMLTag | string, to: number | XMLTag | string): XMLTag[]; /** * Returns the last XMLTag in the collection. */ lastItem(): XMLTag; /** * Returns the middle XMLTag in the collection. */ middleItem(): XMLTag; /** * Returns the XMLTag whose index follows the specified XMLTag in the * collection. * @param obj The XMLTag whose index comes before the desired XMLTag. */ nextItem(obj: XMLTag): XMLTag; /** * Returns the XMLTag with the index previous to the specified index. * @param obj The index of the XMLTag that follows the desired XMLTag. */ previousItem(obj: XMLTag): XMLTag; /** * Generates a string which, if executed, will return the XMLTag. */ toSource(): string; } /** * File used for XML transformation. */ declare enum XMLTransformFile { /** * Use stylesheet specified in XML */ STYLESHEET_IN_XML = 1483961208, } /** * XML view preferences */ declare class XMLViewPreference extends Preference { /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The parent of the XMLViewPreference (a Application or Document). */ readonly parent: Application | Document; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * If true, displays attributes as well as elements in the structure view. * Note: Valid only when show structure is true. */ showAttributes: boolean; /** * If true, displays the structure view. */ showStructure: boolean; /** * If true, displays XML tags. */ showTagMarkers: boolean; /** * If true, displays the tag options dialog when tagging any item whose parent * is not tagged. */ readonly showTagOptions: boolean; /** * If true, displays XML tags in tagged frames. */ showTaggedFrames: boolean; /** * If true, the structure view displays text snippets of element content. Note: * Valid only when show structure is true. */ showTextSnippets: boolean; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * Resolves the object specifier, creating an array of object references. */ getElements(): XMLViewPreference[]; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Generates a string which, if executed, will return the XMLViewPreference. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * A collection of xml stories. */ declare class XmlStories { /** Returns the XmlStory with the specified index or name. */ [index: number]: XmlStory; /** * The number of objects in the collection. */ readonly length: number; /** * Returns any XmlStory in the collection. */ anyItem(): XmlStory; /** * Displays the number of elements in the XmlStory. */ count(): number; /** * Returns every XmlStory in the collection. */ everyItem(): XmlStory; /** * Returns the first XmlStory in the collection. */ firstItem(): XmlStory; /** * Returns the XmlStory with the specified index or name. * @param index The index or name. Can accept: Long Integer or String. */ item(index: number | string): XmlStory; /** * Returns the XmlStory with the specified ID. * @param id The ID. */ itemByID(id: number): XmlStory; /** * Returns the XmlStory with the specified name. * @param name The name. */ itemByName(name: string): XmlStory; /** * Returns the XmlStories within the specified range. * @param from The XmlStory, index, or name at the beginning of the range. Can accept: XmlStory, Long Integer or String. * @param to The XmlStory, index, or name at the end of the range. Can accept: XmlStory, Long Integer or String. */ itemByRange(from: number | XmlStory | string, to: number | XmlStory | string): XmlStory[]; /** * Returns the last XmlStory in the collection. */ lastItem(): XmlStory; /** * Returns the middle XmlStory in the collection. */ middleItem(): XmlStory; /** * Returns the XmlStory whose index follows the specified XmlStory in the * collection. * @param obj The XmlStory whose index comes before the desired XmlStory. */ nextItem(obj: XmlStory): XmlStory; /** * Returns the XmlStory with the index previous to the specified index. * @param obj The index of the XmlStory that follows the desired XmlStory. */ previousItem(obj: XmlStory): XmlStory; /** * Generates a string which, if executed, will return the XmlStory. */ toSource(): string; } /** * XML text content that has not yet been placed in the layout. */ declare class XmlStory extends Story { /** * If true, aligns the baseline of the text to the baseline grid. */ alignToBaseline: boolean; /** * Lists all graphics contained by the XmlStory. */ readonly allGraphics: Graphic[]; /** * Lists all page items contained by the XmlStory. */ readonly allPageItems: PageItem[]; /** * If true, words unassociated with a hyphenation dictionary can break to the * next line on any character. */ allowArbitraryHyphenation: boolean; /** * The character style applied to the text. Can also accept: String. */ appliedCharacterStyle: CharacterStyle | string; /** * The font applied to the XmlStory, specified as either a font object or the * name of font family. Can return: Font or String. */ appliedFont: Font | string; /** * The language of the text. Can return: LanguageWithVendors or Language. Can * also accept: String. */ appliedLanguage: LanguageWithVendors | string | Language; /** * The named grid in use. */ appliedNamedGrid: NamedGrid; /** * The applied character styles dictated by nested styles. */ readonly appliedNestedStyles: CharacterStyle[]; /** * The list to be part of. Can return: NumberingList or String. */ appliedNumberingList: NumberingList | string; /** * The paragraph style applied to the text. Can also accept: String. */ appliedParagraphStyle: ParagraphStyle | string; /** * The XML element associated with the XmlStory. */ readonly associatedXMLElement: XMLItem; /** * The percent of the type size to use for auto leading. (Range: 0 to 500). * @remarks Range: 0 to 500 */ autoLeading: number; /** * The number of half-width characters at or below which the characters * automatically run horizontally in vertical text. */ autoTcy: number; /** * If true, auto tcy includes Roman characters. */ autoTcyIncludeRoman: boolean; /** * If true or set to an enumeration value, balances ragged lines. Note: Not * valid with a single-line text composer. Can return: Boolean or * BalanceLinesStyle enumerator. */ balanceRaggedLines: boolean | BalanceLinesStyle; /** * The baseline shift applied to the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ baselineShift: number | string; /** * Bullet character. */ readonly bulletChar: Bullet; /** * The alignment of the bullet character. */ bulletsAlignment: ListAlignment; /** * List type for bullets and numbering. */ bulletsAndNumberingListType: ListType; /** * The character style to be used for the text after string. Can return: * CharacterStyle or String. */ bulletsCharacterStyle: CharacterStyle | string; /** * The text after string expression for bullets. */ bulletsTextAfter: string; /** * If true, adds the double period (..), ellipse (...), and double hyphen (--) * to the selected kinsoku set. Note: Valid only when a kinsoku set is in * effect. */ bunriKinshi: boolean; /** * A collection of buttons. */ readonly buttons: Buttons; /** * The capitalization scheme. */ capitalization: Capitalization; /** * A collection of cell style mappings. */ readonly cellStyleMappings: CellStyleMappings; /** * A collection of changes. */ readonly changes: Changes; /** * A collection of char style mappings. */ readonly charStyleMappings: CharStyleMappings; /** * The alignment of small characters to the largest character in the line. */ characterAlignment: CharacterAlignment; /** * The direction of the character. */ characterDirection: CharacterDirectionOptions; /** * The rotation angle (in degrees) of individual characters. Note: The rotation * is counterclockwise. */ characterRotation: number; /** * A collection of characters. */ readonly characters: Characters; /** * A collection of checkboxes. */ readonly checkBoxes: CheckBoxes; /** * If true, uses grid tracking to track non-Roman characters in CJK grids. */ cjkGridTracking: boolean; /** * A collection of comboboxes. */ readonly comboBoxes: ComboBoxes; /** * The text composer to use to compose the text. */ composer: string; /** * The contents of the text. Can return: String or SpecialCharacters * enumerator. */ readonly contents: string | SpecialCharacters; /** * Value of Design Axes */ designAxes: number[]; /** * The desired width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ desiredGlyphScaling: number; /** * The desired letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) */ desiredLetterSpacing: number; /** * The desired word spacing, specified as a percentage of the font word space * value. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ desiredWordSpacing: number; /** * Position of diacriticical characters. */ diacriticPosition: DiacriticPositionOptions; /** * The digits type. */ digitsType: DigitsTypeOptions; /** * The number of characters to drop cap. * @remarks Range: 0 to 150 */ dropCapCharacters: number; /** * The number of lines to drop cap. * @remarks Range: 0 to 25 */ dropCapLines: number; /** * The character style to apply to the drop cap. Can also accept: String. */ dropCapStyle: CharacterStyle | string; /** * Details about the drop cap based on the glyph outlines. 1 = left side * bearing. 2 = descenders. 0x100,0x200,0x400 are used for Japanese frame grid. */ dropcapDetail: number; /** * The stroke join type applied to the characters of the text. */ endJoin: OutlineJoin; /** * A collection of endnote text ranges. */ readonly endnoteRanges: EndnoteRanges; /** * A collection of endnote text frames. */ readonly endnoteTextFrames: EndnoteTextFrames; /** * A collection of endnotes. */ readonly endnotes: Endnotes; /** * EPSTexts */ readonly epstexts: EPSTexts; /** * A collection of event listeners. */ readonly eventListeners: EventListeners; /** * A collection of events. */ readonly events: Events; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of the * XmlStory. . Can also accept: String. */ fillColor: Swatch | string; /** * The tint (as a percentage) of the fill color of the XmlStory. (To specify a * tint percentage, use a number in the range of 0 to 100; to use the inherited * or overridden value, use -1.) * @remarks Range: 0 to 100 */ fillTint: number; /** * The amount to indent the first line. * @remarks Measurement unit — also accepts a string such as "12mm". */ firstLineIndent: number | string; /** * The name of the font style. */ fontStyle: string; /** * A collection of footnotes. */ readonly footnotes: Footnotes; /** * A collection of form fields. */ readonly formFields: FormFields; /** * The glyph variant to substitute for standard glyphs. */ glyphForm: AlternateGlyphForms; /** * The angle of a linear gradient applied to the fill of the text. (Range: -180 * to 180) */ gradientFillAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the fill of the text. */ gradientFillLength: number; /** * The starting point (in page coordinates) of a gradient applied to the fill * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientFillStart: (number | string)[]; /** * The angle of a linear gradient applied to the stroke of the text. (Range: * -180 to 180) */ gradientStrokeAngle: number; /** * The length (for a linear gradient) or radius (for a radial gradient) applied * to the stroke of the text. */ gradientStrokeLength: number; /** * The starting point (in page coordinates) of a gradient applied to the stroke * of the text, in the format [x, y]. * @remarks Measurement unit — also accepts a string such as "12mm". */ gradientStrokeStart: (number | string)[]; /** * A collection of graphic lines. */ readonly graphicLines: GraphicLines; /** * If true, aligns only the first line to the frame grid or baseline grid. If * false, aligns all lines to the grid. */ gridAlignFirstLineOnly: boolean; /** * The alignment to the frame grid or baseline grid. */ gridAlignment: GridAlignment; /** * Default grid properties. Note: Applies to named, layout, and frame (story) * grids. */ readonly gridData: GridDataInformation; /** * The manual gyoudori setting. */ gridGyoudori: number; /** * A collection of groups. */ readonly groups: Groups; /** * A collection of hidden text objects. */ readonly hiddenTexts: HiddenTexts; /** * The horizontal scaling applied to the XmlStory. */ horizontalScale: number; /** * The relative desirability of better spacing vs. fewer hyphens. A lower value * results in greater use of hyphens. (Range: 0 to 100) * @remarks Range: 0 to 10 */ hyphenWeight: number; /** * If true, allows the last word in a text column to be hyphenated. */ hyphenateAcrossColumns: boolean; /** * The mininum number of letters at the beginning of a word that can be broken * by a hyphen. * @remarks Range: 1 to 15 */ hyphenateAfterFirst: number; /** * The minimum number of letters at the end of a word that can be broken by a * hyphen. * @remarks Range: 1 to 15 */ hyphenateBeforeLast: number; /** * If true, allows hyphenation of capitalized words. */ hyphenateCapitalizedWords: boolean; /** * The maximum number of hyphens that can appear on consecutive lines. To * specify unlimited consecutive lines, use zero. * @remarks Range: 0 to 25 */ hyphenateLadderLimit: number; /** * If true, allows hyphenation in the last word in a paragraph. Note: Valid * only when hyphenation is true. */ hyphenateLastWord: boolean; /** * The minimum number of letters a word must have in order to qualify for * hyphenation. * @remarks Range: 3 to 25 */ hyphenateWordsLongerThan: number; /** * If true, allows hyphenation. */ hyphenation: boolean; /** * The amount of white space allowed at the end of a line of non-justified text * before hypenation begins. Note: Valid when composer is single-line composer. * @remarks Measurement unit — also accepts a string such as "12mm". */ hyphenationZone: number | string; /** * The unique ID of the XmlStory. */ readonly id: number; /** * If true, ignores optical edge alignment for the paragraph. */ ignoreEdgeAlignment: boolean; /** * Export options for InCopy INCX document format. */ readonly incopyExportOptions: InCopyExportOption; /** * The index of the XmlStory within its containing object. */ readonly index: number; /** * A collection of insertion points. */ readonly insertionPoints: InsertionPoints; /** * returns true if it's an endnote story otherwise returns false. */ readonly isEndnoteStory: boolean; /** * Returns true if the object specifier resolves to valid objects. */ readonly isValid: boolean; /** * The source file of the link. */ readonly itemLink: Link; /** * The number of grid squares in which to arrange the text. */ jidori: number; /** * The paragraph alignment. */ justification: Justification; /** * Use of Kashidas for justification */ kashidas: KashidasOptions; /** * If true, keeps all lines of the paragraph together. If false, allows * paragraphs to break across pages or columns. */ keepAllLinesTogether: boolean; /** * The minimum number of lines to keep together in a paragraph before allowing * a page break. * @remarks Range: 1 to 50 */ keepFirstLines: number; /** * The minimum number of lines to keep together in a paragraph after a page * break. * @remarks Range: 1 to 50 */ keepLastLines: number; /** * If true, keeps a specified number of lines together when the paragraph * breaks across columns or text frames. */ keepLinesTogether: boolean; /** * If true, forces the rule above the paragraph to remain in the frame bounds. * Note: Valid only when rule above is true. */ keepRuleAboveInFrame: boolean; /** * The minimum number of lines to keep with the next paragraph. * @remarks Range: 0 to 5 */ keepWithNext: number; /** * If the first line in the paragraph should be kept with the last line of * previous paragraph. */ keepWithPrevious: boolean; /** * The alignment of kenten characters relative to the parent characters. */ kentenAlignment: KentenAlignment; /** * The character set used for the custom kenten character. Note: Valid only * when kenten kind is custom. */ kentenCharacterSet: KentenCharacterSet; /** * The character used for kenten. Note: Valid only when kenten kind is custom. */ kentenCustomCharacter: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of * kenten characters. Can return: Swatch or String. */ kentenFillColor: Swatch | string; /** * The font to use for kenten characters. Can return: Font or String. */ kentenFont: Font | string; /** * The size (in points) of kenten characters. */ kentenFontSize: number; /** * The font style of kenten characters. Can return: String or NothingEnum * enumerator. */ kentenFontStyle: string | NothingEnum; /** * The style of kenten characters. */ kentenKind: KentenCharacter; /** * The method of overprinting the kenten fill. */ kentenOverprintFill: AdornmentOverprint; /** * The method of overprinting the kenten stroke. */ kentenOverprintStroke: AdornmentOverprint; /** * The distance between kenten characters and their parent characters. */ kentenPlacement: number; /** * The kenten position relative to the parent character. */ kentenPosition: RubyKentenPosition; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * kenten characters. Can return: Swatch or String. */ kentenStrokeColor: Swatch | string; /** * The stroke tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenStrokeTint: number; /** * The fill tint (as a percentage) of kenten characters. (Range: 0 to 100) * @remarks Range: 0 to 100 */ kentenTint: number; /** * The stroke weight (in points) of kenten characters. */ kentenWeight: number; /** * The horizontal size of kenten characters as a percent of the original size. */ kentenXScale: number; /** * The vertical size of kenten charachers as a percent of the original size. */ kentenYScale: number; /** * The type of pair kerning. */ kerningMethod: string; /** * The keyboard direction of the character. */ keyboardDirection: CharacterDirectionOptions; /** * The type of hanging punctuation to allow. Note: Valid only when a kinsoku * set is in effect. */ kinsokuHangType: KinsokuHangTypes; /** * The kinsoku set that determines legitimate line breaks. Can return: * KinsokuTable, KinsokuSet enumerator or String. */ kinsokuSet: KinsokuSet | KinsokuTable | string; /** * The type of kinsoku processing for preventing kinsoku characters from * beginning or ending a line. Note: Valid only when a kinsoku set is defined. */ kinsokuType: KinsokuType; /** * A property that can be set to any string. */ label: string; /** * The amount to indent the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ lastLineIndent: number | string; /** * The leading applied to the text. Can return: Unit or Leading enumerator. */ leading: number | Leading; /** * The amount of space before each character. */ leadingAki: number; /** * The point from which leading is measured from line to line. */ leadingModel: LeadingModel; /** * The width of the left indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ leftIndent: number | string; /** * The number of objects in the collection. */ readonly length: number; /** * If true, replaces specific character combinations (e.g., fl, fi) with * ligature characters. */ ligatures: boolean; /** * A collection of lines. */ readonly lines: Lines; /** * Linked story options */ readonly linkedStoryOptions: LinkedStoryOption; /** * A collection of listboxes. */ readonly listBoxes: ListBoxes; /** * The lock state. */ readonly lockState: LockStateValues; /** * The maximum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ maximumGlyphScaling: number; /** * The maximum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ maximumLetterSpacing: number; /** * The maximum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ maximumWordSpacing: number; /** * If true, consecutive para borders with completely similar properties are * merged. */ mergeConsecutiveParaBorders: boolean; /** * The minimum width (as a percentage) of individual characters. (Range: 50 to * 200) * @remarks Range: 50 to 200 */ minimumGlyphScaling: number; /** * The minimum letter spacing, specified as a percentge of the built-in space * between letters in the font. (Range: -100 to 500) Note: Valid only when text * is justified. */ minimumLetterSpacing: number; /** * The minimum word spacing, specified as a percentage of the font word space * value. Note: Valid only when text is justified. (Range: 0 to 1000) * @remarks Range: 0 to 1000 */ minimumWordSpacing: number; /** * The limit of the ratio of stroke width to miter length before a miter * (pointed) join becomes a bevel (squared-off) join. * @remarks Range: 0 to 1000 */ miterLimit: number; /** * The mojikumi table. For information, see mojikumi table defaults. Can * return: MojikumiTable, String or MojikumiTableDefaults enumerator. */ mojikumi: MojikumiTable | string | MojikumiTableDefaults; /** * A collection of multi-state objects. */ readonly multiStateObjects: MultiStateObjects; /** * The name of the XmlStory; this is an alias to the XmlStory's label property. */ name: string; /** * A collection of nested GREP styles. */ readonly nestedGrepStyles: NestedGrepStyles; /** * A collection of nested line styles. */ readonly nestedLineStyles: NestedLineStyles; /** * A collection of nested styles. */ readonly nestedStyles: NestedStyles; /** * If true, keeps the text on the same line. */ noBreak: boolean; /** * A collection of notes. */ readonly notes: Notes; /** * The alignment of the number. */ numberingAlignment: ListAlignment; /** * If true, apply the numbering restart policy. */ numberingApplyRestartPolicy: boolean; /** * The character style to be used for the number string. Can return: * CharacterStyle or String. */ numberingCharacterStyle: CharacterStyle | string; /** * Continue the numbering at this level. */ numberingContinue: boolean; /** * The number string expression for numbering. */ numberingExpression: string; /** * Numbering format options. Can return: NumberingStyle enumerator or String. */ numberingFormat: NumberingStyle | string; /** * The level of the paragraph. */ numberingLevel: number; /** * Numbering restart policies. */ readonly numberingRestartPolicies: NumberingRestartPolicy; /** * Determines starting number in a numbered list. */ numberingStartAt: number; /** * OpenType features. Can return: Array of Array of 2 Strings or Long Integers. */ opentypeFeatures: (string[][] | number[])[]; /** * If true, uses contextual alternate forms in OpenType fonts. */ otfContextualAlternate: boolean; /** * If true, uses discretionary ligatures in OpenType fonts. */ otfDiscretionaryLigature: boolean; /** * The figure style in OpenType fonts. */ otfFigureStyle: OTFFigureStyle; /** * If true, uses fractions in OpenType fonts. */ otfFraction: boolean; /** * If true, switches hiragana fonts, which have different glyphs for horizontal * and vertical. */ otfHVKana: boolean; /** * If true, use historical forms in OpenType fonts. */ otfHistorical: boolean; /** * If true, use alternate justification forms in OpenType fonts */ otfJustificationAlternate: boolean; /** * If true, uses localized forms in OpenType fonts. */ otfLocale: boolean; /** * If true, uses mark positioning in OpenType fonts. */ otfMark: boolean; /** * If true, uses ordinals in OpenType fonts. */ otfOrdinal: boolean; /** * If true, use overlapping swash forms in OpenType fonts */ otfOverlapSwash: boolean; /** * If true, kerns according to proportional CJK metrics in OpenType fonts. */ otfProportionalMetrics: boolean; /** * If true, applies italics to half-width alphanumerics. */ otfRomanItalics: boolean; /** * If true, use a slashed zeroes in OpenType fonts. */ otfSlashedZero: boolean; /** * If true, use stretched alternate forms in OpenType fonts */ otfStretchedAlternate: boolean; /** * If true, use stylistic alternate forms in OpenType fonts */ otfStylisticAlternate: boolean; /** * The stylistic sets to use in OpenType fonts. */ otfStylisticSets: number; /** * If true, uses swash forms in OpenType fonts. */ otfSwash: boolean; /** * If true, uses titling forms in OpenType fonts. */ otfTitling: boolean; /** * A collection of ellipses. */ readonly ovals: Ovals; /** * If true, the story has overset text. */ readonly overflows: boolean; /** * If true, the fill color of the characters will overprint. */ overprintFill: boolean; /** * If true, the stroke of the characters will overprint. */ overprintStroke: boolean; /** * The page items collection, which can be used to process all page items in a * container (such as a document, page, or group), regardless of type. */ readonly pageItems: PageItems; /** * A collection of para style mappings. */ readonly paraStyleMappings: ParaStyleMappings; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphBorderBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLeftCornerRadius: number | string; /** * The bottom line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomLineWeight: number | string; /** * The distance to offset the bottom edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph border. */ paragraphBorderBottomOrigin: ParagraphBorderBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphBorderBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderBottomRightCornerRadius: number | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * stroke. Can return: Swatch or String. */ paragraphBorderColor: Swatch | string; /** * If true, then paragraph border is also displayed at the points where the * paragraph splits across frames or columns. */ paragraphBorderDisplayIfSplits: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * border gap. Note: Valid only when the border type is not solid. Can return: * Swatch or String. */ paragraphBorderGapColor: Swatch | string; /** * If true, the paragraph border gap will overprint. Note: Valid only when * border type is not solid. */ paragraphBorderGapOverprint: boolean; /** * The tint (as a percentage) of the paragraph border gap. Note: Valid only * when the border type is not solid. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderGapTint: number; /** * The left line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftLineWeight: number | string; /** * The distance to offset the left edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderLeftOffset: number | string; /** * If true, the paragraph border is on. */ paragraphBorderOn: boolean; /** * If true, the paragraph border will overprint. */ paragraphBorderOverprint: boolean; /** * The right line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightLineWeight: number | string; /** * The distance to offset the right edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderRightOffset: number | string; /** * The end shape of an open path. */ paragraphBorderStrokeEndCap: EndCap; /** * The corner join applied to the XmlStory. */ paragraphBorderStrokeEndJoin: EndJoin; /** * The tint (as a percentage) of the paragraph stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphBorderTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphBorderTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLeftCornerRadius: number | string; /** * The top line weight of the border of paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopLineWeight: number | string; /** * The distance to offset the top edge of the paragraph border. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph border. */ paragraphBorderTopOrigin: ParagraphBorderTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphBorderTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphBorderTopRightCornerRadius: number | string; /** * The type of the border for the paragraph. Can return: StrokeStyle or String. */ paragraphBorderType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph border. */ paragraphBorderWidth: ParagraphBorderEnum; /** * Paragraph direction. */ paragraphDirection: ParagraphDirectionOptions; /** * If true, the gyoudori mode applies to the entire paragraph. If false, the * gyoudori mode applies to each line in the paragraph. */ paragraphGyoudori: boolean; /** * Paragraph justification. */ paragraphJustification: ParagraphJustificationOptions; /** * Paragraph kashida width. 0 is none, 1 is short, 2 is medium, 3 is long */ paragraphKashidaWidth: number; /** * The shape to apply to the bottom left corner of rectangular shapes. */ paragraphShadingBottomLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * left corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomLeftCornerRadius: number | string; /** * The distance to offset the bottom edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomOffset: number | string; /** * The basis (descent or baseline) used to calculate the bottom origin of the * paragraph shading. */ paragraphShadingBottomOrigin: ParagraphShadingBottomOriginEnum; /** * The shape to apply to the bottom right corner of rectangular shapes. */ paragraphShadingBottomRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the bottom * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingBottomRightCornerRadius: number | string; /** * If true, forces the shading of the paragraph to be clipped with respect to * frame shape. */ paragraphShadingClipToFrame: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * shading. Can return: Swatch or String. */ paragraphShadingColor: Swatch | string; /** * The distance to offset the left edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingLeftOffset: number | string; /** * If true, the paragraph shading is On. */ paragraphShadingOn: boolean; /** * If true, the paragraph shading will overprint. */ paragraphShadingOverprint: boolean; /** * The distance to offset the right edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingRightOffset: number | string; /** * If true, suppress printing of the shading of the paragraph. */ paragraphShadingSuppressPrinting: boolean; /** * The tint (as a percentage) of the paragraph shading. (Range: 0 to 100) * @remarks Range: 0 to 100 */ paragraphShadingTint: number; /** * The shape to be applied to the top left corner of rectangular shapes and all * corners of non-rectangular shapes.Note: corner option differs from end join * in which you can set a radius for a corner option, whereas the rounded or * beveled effect of an end join depends on the stroke weight. */ paragraphShadingTopLeftCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top left * corner of rectangular shapes and all corners of non-rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopLeftCornerRadius: number | string; /** * The distance to offset the top edge of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopOffset: number | string; /** * The basis (cap height, ascent or baseline) used to calculate the top origin * of the paragraph shading. */ paragraphShadingTopOrigin: ParagraphShadingTopOriginEnum; /** * The shape to apply to the top right corner of rectangular shapes */ paragraphShadingTopRightCornerOption: CornerOptions; /** * The radius in measurement units of the corner effect applied to the top * right corner of rectangular shapes * @remarks Measurement unit — also accepts a string such as "12mm". */ paragraphShadingTopRightCornerRadius: number | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph shading. */ paragraphShadingWidth: ParagraphShadingWidthEnum; /** * A collection of paragraphs. */ readonly paragraphs: Paragraphs; /** * The parent of the XmlStory (a Document). */ readonly parent: Document; /** * The text size. * @remarks Measurement unit — also accepts a string such as "12mm". */ pointSize: number | string; /** * A collection of polygons. */ readonly polygons: Polygons; /** * The text position relative to the baseline. */ position: Position; /** * The OpenType positional form. */ positionalForm: PositionalForms; /** * A collection of preferences objects. */ readonly preferences: Preferences; /** * A property that allows setting of several properties at the same time. */ properties: Object; /** * The hyphenation style chosen for the provider. */ providerHyphenationStyle: HyphenationStyleEnum; /** * A collection of radio buttons. */ readonly radioButtons: RadioButtons; /** * A collection of rectangles. */ readonly rectangles: Rectangles; /** * If true, disallows line breaks in numbers. If false, lines can break between * digits in multi-digit numbers. */ rensuuji: boolean; /** * The width of the right indent. * @remarks Measurement unit — also accepts a string such as "12mm". */ rightIndent: number | string; /** * If true, rotates Roman characters in vertical text. */ rotateSingleByteCharacters: boolean; /** * The ruby alignment. */ rubyAlignment: RubyAlignments; /** * If true, auto aligns ruby. */ rubyAutoAlign: boolean; /** * If true, automatically scales ruby to the specified percent of parent text * size. For information on specifying a percent, see ruby parent scaling * percent. */ rubyAutoScaling: boolean; /** * If true, automatically scales glyphs in auto tcy (tate-chuu-yoko) in ruby to * fit one em. */ rubyAutoTcyAutoScale: boolean; /** * The number of digits included in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyDigits: number; /** * If true, includes Roman characters in auto tcy (tate-chuu-yoko) in ruby. */ rubyAutoTcyIncludeRoman: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the fill of ruby * characters. Can return: Swatch or String. */ rubyFill: Swatch | string; /** * If true, ruby is on. */ rubyFlag: boolean; /** * The font applied to ruby characters. Can return: Font or String. */ rubyFont: Font | string; /** * The size (in points) of ruby characters. */ rubyFontSize: number; /** * The font style of ruby characters. Can return: String or NothingEnum * enumerator. */ rubyFontStyle: string | NothingEnum; /** * If true, uses OpenType Pro fonts for ruby. */ rubyOpenTypePro: boolean; /** * If true, constrains ruby overhang to the specified amount. For information * on specifying an amount, see ruby parent overhang amount. */ rubyOverhang: boolean; /** * The method of overprinting the ruby fill. */ rubyOverprintFill: AdornmentOverprint; /** * The method of overprinting the ruby stroke. */ rubyOverprintStroke: AdornmentOverprint; /** * The amount by which ruby characters can overhang the parent text. */ rubyParentOverhangAmount: RubyOverhang; /** * The amount (as a percentage) to scale the parent text size to determine the * ruby text size. */ rubyParentScalingPercent: number; /** * The ruby spacing relative to the parent text. */ rubyParentSpacing: RubyParentSpacing; /** * The position of ruby characters relative to the parent text. */ rubyPosition: RubyKentenPosition; /** * The ruby string contents. */ rubyString: string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * ruby characters. Can return: Swatch or String. */ rubyStroke: Swatch | string; /** * The stroke tint (as a percentage) of ruby characters. */ rubyStrokeTint: number; /** * The tint (as a percentage) of the ruby fill color. (Range: 0 to 100) * @remarks Range: 0 to 100 */ rubyTint: number; /** * The ruby type. */ rubyType: RubyTypes; /** * The stroke weight (in points) of ruby characters. */ rubyWeight: number; /** * The amount of horizontal space between ruby and parent characters. */ rubyXOffset: number; /** * The horizontal size of ruby characters, specified as a percent of the * original size. */ rubyXScale: number; /** * The amount of vertical space between ruby and parent characters. */ rubyYOffset: number; /** * The vertical size of ruby characters, specified as a percent of the original * size. */ rubyYScale: number; /** * If true, places a rule above the paragraph. */ ruleAbove: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule above. Can return: Swatch or String. */ ruleAboveColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule above. Note: Valid only when the paragraph rule above * type is not solid. Can return: Swatch or String. */ ruleAboveGapColor: Swatch | string; /** * If true, the stroke gap of the paragraph rule above will overprint. Note: * Valid only the rule above type is not solid. */ ruleAboveGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule. * (Range: 0 to 100) Note: Valid only when the rule above type is not solid. * @remarks Range: 0 to 100 */ ruleAboveGapTint: number; /** * The distance to indent the left edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLeftIndent: number | string; /** * The line weight of the rule above. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveLineWeight: number | string; /** * The amount to offset the paragraph rule above from the baseline of the first * line the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveOffset: number | string; /** * If true, the paragraph rule above will overprint. */ ruleAboveOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule above (based on * either the text width or the column width of the first line in the * paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleAboveRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule above. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleAboveTint: number; /** * The stroke type of the rule above the paragraph. Can return: StrokeStyle or * String. */ ruleAboveType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule above. */ ruleAboveWidth: RuleWidth; /** * If true, applies a paragraph rule below. */ ruleBelow: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the paragraph * rule below. Can return: Swatch or String. */ ruleBelowColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap * of the paragraph rule below. Note: Valid only when the paragraph rule below * type is not solid. Can return: Swatch or String. */ ruleBelowGapColor: Swatch | string; /** * If true, the gap color of the rule below will overprint. */ ruleBelowGapOverprint: boolean; /** * The tint (as a percentage) of the stroke gap color of the paragraph rule * below. (Range: 0 to 100) Note: Valid only when the paragraph rule below type * is not solid. * @remarks Range: 0 to 100 */ ruleBelowGapTint: number; /** * The distance to indent the left edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLeftIndent: number | string; /** * The line weight of the rule below. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowLineWeight: number | string; /** * The amount to offset the the paragraph rule below from the baseline of the * last line of the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowOffset: number | string; /** * If true, the rule below will overprint. */ ruleBelowOverprint: boolean; /** * The distance to indent the right edge of the paragraph rule below (based on * either the text width or the column width of the last line in the paragraph. * @remarks Measurement unit — also accepts a string such as "12mm". */ ruleBelowRightIndent: number | string; /** * The tint (as a percentage) of the paragraph rule below. (Range: 0 to 100) * @remarks Range: 0 to 100 */ ruleBelowTint: number; /** * The stroke type of the rule below the paragraph. Can return: StrokeStyle or * String. */ ruleBelowType: StrokeStyle | string; /** * The basis (text width or column width) used to calculate the width of the * paragraph rule below. */ ruleBelowWidth: RuleWidth; /** * The space between paragraphs using same style. Can return: Unit or Spacing * enumerator. */ sameParaStyleSpacing: number | Spacing; /** * If true, the line changes size when characters are scaled. */ scaleAffectsLineHeight: boolean; /** * If true, applies shatai rotation. */ shataiAdjustRotation: boolean; /** * If true, adjusts shatai tsume. */ shataiAdjustTsume: boolean; /** * The shatai lens angle (in degrees). */ shataiDegreeAngle: number; /** * The amount (as a percentage) of shatai obliquing to apply. */ shataiMagnification: number; /** * A collection of signature fields. */ readonly signatureFields: SignatureFields; /** * The alignment to use for lines that contain a single word. */ singleWordJustification: SingleWordJustification; /** * The skew angle of the XmlStory. */ skew: number; /** * The height of the paragraph space below. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceAfter: number | string; /** * The height of the paragraph space above. * @remarks Measurement unit — also accepts a string such as "12mm". */ spaceBefore: number | string; /** * The minimum space after a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceAfter: number | string; /** * The minimum space before a span or a split column * @remarks Measurement unit — also accepts a string such as "12mm". */ spanColumnMinSpaceBefore: number | string; /** * Whether a paragraph should be a single column, span columns or split columns */ spanColumnType: SpanColumnTypeOptions; /** * The number of columns a paragraph spans or the number of split columns. Can * return: Short Integer (1 - 40) or SpanColumnCountOptions enumerator. */ spanSplitColumnCount: number | SpanColumnCountOptions; /** * The spline items collection. */ readonly splineItems: SplineItems; /** * The inside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnInsideGutter: number | string; /** * The outside gutter if the paragraph splits columns * @remarks Measurement unit — also accepts a string such as "12mm". */ splitColumnOutsideGutter: number | string; /** * The location at which to start the paragraph. */ startParagraph: StartParagraph; /** * Story preference settings. */ readonly storyPreferences: StoryPreference; /** * Title for this InCopy story. */ storyTitle: string; /** * The type of story. */ readonly storyType: StoryTypes; /** * The swatch (color, gradient, tint, or mixed ink) applied to the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * strikethrough stroke. Can return: Swatch or String. */ strikeThroughGapColor: Swatch | string; /** * If true, the gap color of the strikethrough stroke will overprint. Note: * Valid when strike through type is not solid. */ strikeThroughGapOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke gap color. (Range: 0 * to 100) Note: Valid when strike through type is not solid. * @remarks Range: 0 to 100 */ strikeThroughGapTint: number; /** * The amount by which to offset the strikethrough stroke from the text * baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughOffset: number | string; /** * If true, the strikethrough stroke will overprint. */ strikeThroughOverprint: boolean; /** * The tint (as a percentage) of the strikethrough stroke. (Range: 0 to 100) * @remarks Range: 0 to 100 */ strikeThroughTint: number; /** * The stroke type of the strikethrough stroke. Can return: StrokeStyle or * String. */ strikeThroughType: StrokeStyle | string; /** * The stroke weight of the strikethrough stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ strikeThroughWeight: number | string; /** * If true, draws a strikethrough line through the text. */ strikeThru: boolean; /** * The stroke alignment applied to the text. */ strokeAlignment: TextStrokeAlign; /** * The swatch (color, gradient, tint, or mixed ink) applied to the stroke of * the XmlStory. Can also accept: String. */ strokeColor: Swatch | string; /** * The tint (as a percentage) of the stroke color of the XmlStory. (To specify * a tint percentage, use a number in the range of 0 to 100; to use the * inherited or overridden value, use -1.) * @remarks Range: 0 to 100 */ strokeTint: number; /** * The stroke weight applied to the characters of the text. * @remarks Measurement unit — also accepts a string such as "12mm". */ strokeWeight: number | string; /** * If true, the applied style has been overridden with additional attributes. */ readonly styleOverridden: boolean; /** * A list of the tab stops in the paragraph. Can return: Array of Arrays of * Property Name/Value Pairs. */ tabList: any[][][]; /** * A collection of tab stops. */ readonly tabStops: TabStops; /** * A collection of table style mappings. */ readonly tableStyleMappings: TableStyleMappings; /** * A collection of tables. */ readonly tables: Tables; /** * If true, makes the character horizontal in vertical text. */ tatechuyoko: boolean; /** * The horizontal offset for horizontal characters in vertical text. */ tatechuyokoXOffset: number; /** * The vertical offset for horizontal characters in vertical text. */ tatechuyokoYOffset: number; /** * A collection of text boxes. */ readonly textBoxes: TextBoxes; /** * A collection of text columns. */ readonly textColumns: TextColumns; /** * Array of text frames or text paths. Can return: Array of TextFrames or * TextPaths. */ readonly textContainers: (TextFrames | TextPaths)[]; /** * A collection of text frames. */ readonly textFrames: TextFrames; /** * A collection of text style ranges. */ readonly textStyleRanges: TextStyleRanges; /** * A collection of text variable instances. */ readonly textVariableInstances: TextVariableInstances; /** * A collection of text objects. */ readonly texts: Texts; /** * If true, track changes is turned on. */ trackChanges: boolean; /** * The amount by which to loosen or tighten a block of text, specified in * thousands of an em. */ tracking: number; /** * The amount of space after each character. */ trailingAki: number; /** * If true, ideographic spaces will not wrap to the next line like text * characters. */ treatIdeographicSpaceAsSpace: boolean; /** * The amount of horizontal character compression. */ tsume: number; /** * If true, underlines the text. */ underline: boolean; /** * The swatch (color, gradient, tint, or mixed ink) applied to the underline * stroke. . Can return: Swatch or String. */ underlineColor: Swatch | string; /** * The swatch (color, gradient, tint, or mixed ink) applied to the gap of the * underline stroke. Note: Valid when underline type is not solid. Can return: * Swatch or String. */ underlineGapColor: Swatch | string; /** * If true, the gap color of the underline stroke will overprint. */ underlineGapOverprint: boolean; /** * The tint (as a percentage) of the gap color of the underline stroke. (Range: * 0 to 100) Note: Valid when underline type is not solid. * @remarks Range: 0 to 100 */ underlineGapTint: number; /** * The amount by which to offset the underline from the text baseline. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineOffset: number | string; /** * If true, the underline stroke color will overprint. */ underlineOverprint: boolean; /** * The underline stroke tint (as a percentage). (Range: 0 to 100) * @remarks Range: 0 to 100 */ underlineTint: number; /** * The stroke type of the underline stroke. Can return: StrokeStyle or String. */ underlineType: StrokeStyle | string; /** * The stroke weight of the underline stroke. * @remarks Measurement unit — also accepts a string such as "12mm". */ underlineWeight: number | string; /** * Indicates whether the text is user or placeholder text. */ userText: boolean; /** * The vertical scaling applied to the XmlStory. */ verticalScale: number; /** * If true, turns on warichu. */ warichu: boolean; /** * The warichu alignment. */ warichuAlignment: WarichuAlignment; /** * The minimum number of characters allowed after a line break. */ warichuCharsAfterBreak: number; /** * The minimum number of characters allowed before a line break. */ warichuCharsBeforeBreak: number; /** * The gap between lines of warichu characters. */ warichuLineSpacing: number; /** * The number of lines of warichu within a single normal line. */ warichuLines: number; /** * The amount (as a percentage) to scale parent text size to determine warichu * size. */ warichuSize: number; /** * A collection of words. */ readonly words: Words; /** * The x (horizontal) offset for diacritic adjustment. */ xOffsetDiacritic: number; /** * The y (vertical) offset for diacritic adjustment. */ yOffsetDiacritic: number; /** * Dispatched after a XmlStory is placed. This event bubbles. This event is not * cancelable. */ static readonly AFTER_PLACE: string; /** * Dispatched before a XmlStory is placed. This event bubbles. This event is * cancelable. */ static readonly BEFORE_PLACE: string; /** * Adds an event listener. * @param eventType The event type. * @param handler The event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ addEventListener(eventType: string, handler: File | Function, captures?: boolean): EventListener; /** * asynchronously exports the object(s) to a file. * @param format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String. * @param to The path to the export file. * @param showingOptions If true, displays the export options dialog. (Optional) * @param using The export style. (Optional) * @param versionComments The comment for this version. (Optional) * @param forceSave If true, forcibly saves a version. (Optional) */ asynchronousExportFile(format: ExportFormat | string, to: File, showingOptions?: boolean, using?: PDFExportPreset, versionComments?: string, forceSave?: boolean): BackgroundTask; /** * Finds glyphs that match the find what value and replaces the glyphs with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value and replaces the text with the * change to value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value and replaces the text * with the change character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ changeTransliterate(reverseOrder?: boolean): Text[]; /** * Sets the case of the text. * @param using The text case option. */ changecase(using: ChangecaseMode): void; /** * Clears the specified types of override. * @param overridesToClear The types of override to clear. (Optional) */ clearOverrides(overridesToClear?: OverrideType): void; /** * Convert bullets and numbering to text. */ convertBulletsAndNumberingToText(): void; /** * Converts text to outlines. Each line of text becomes a polygon object. When * the converted text is a single letter that has no internal spaces or * detached parts, the polygon contains only a single path. Note: To determine * whether a font allows the creation of outlines, see allow outlines. * @param deleteOriginal If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional) */ createOutlines(deleteOriginal?: boolean): PageItem[]; /** * Duplicates the text in the specified location. * @param to The location relative to the reference object or within the containing object. * @param reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text, Story, Cell, Row, Column, Table or PageItem. (Optional) */ duplicate(to: LocationOptions, reference?: Cell | Column | Row | Story | Table | Text | PageItem): Text; /** * Gets the label value associated with the specified key. * @param key The key. */ extractLabel(key: string): string; /** * Finds glyphs that match the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGlyph(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findGrep(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find what value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findText(reverseOrder?: boolean): Text[]; /** * Finds text that matches the find character type value. * @param reverseOrder If true, returns the results in reverse order. (Optional) */ findTransliterate(reverseOrder?: boolean): Text[]; /** * Resolves the object specifier, creating an array of object references. */ getElements(): XmlStory[]; /** * Sets the label to the value associated with the specified key. * @param key The key. * @param value The value. */ insertLabel(key: string, value: string): void; /** * If true, Nth design axis of variable font is hidden. * @param nthAxisIndex Index of design axis. */ isNthDesignAxisHidden(nthAxisIndex: number): boolean; /** * Removes the event listener. * @param eventType The registered event type. * @param handler The registered event handler. Can accept: File or JavaScript Function. * @param captures This parameter is obsolete. (Optional) */ removeEventListener(eventType: string, handler: File | Function, captures?: boolean): boolean; /** * Set Nth design axis of a variable font. * @param nthAxisIndex Index of design axis. * @param nthAxisValue Value of nth design axis. */ setNthDesignAxis(nthAxisIndex: number, nthAxisValue: number): void; /** * Generates a string which, if executed, will return the XmlStory. */ toSource(): string; /** * Retrieves the object specifier. */ toSpecifier(): string; } /** * Display size options. */ declare enum ZoomOptions { /** * Zooms to 100%. */ ACTUAL_SIZE = 2053206906, /** * Centers the active page in the window. */ FIT_PAGE = 2053534832, /** * Centers the active spread in the window. */ FIT_SPREAD = 2053534835, /** * Fits the entire pasteboard in the window. */ SHOW_PASTEBOARD = 2054385762, /** * Magnifies the view to the next preset percentage. */ ZOOM_IN = 2053990766, /** * Reduces the view to the next preset percentage. */ ZOOM_OUT = 2054124916, } /** * The application object */ declare const app: Application; /** * Displays an alert box * @param message The text to display * @param title The title of the alert; ignored on the Macintosh * @param errorIcon Display an Error icon; ignored on the Macintosh */ declare function alert(message: string, title?: string, errorIcon?: boolean): void; /** * Displays an alert box with Yes and No buttons; returns true for Yes * @param message The text to display * @param noAsDefault Set to true to set the No button as the default button * @param title The title of the alert; ignored on the Macintosh */ declare function confirm(message: string, noAsDefault: boolean, title?: string): boolean; /** * Returns true if the supplied string is a valid XML name. * @param name The XML name to test. */ declare function isXMLName(name: string): boolean; /** * Localizes a ZString-encoded string and merges additional arguments into the * string. * @param what The string to localize. A ZString-encoded string that can contain placeholder for additional arguments in the form %1 to %n. * @param argument Optional argument(s) to be merged into the string. There may be more than one argument. */ declare function localize(what: string, argument?: any): string; /** * Displays a dialog allowing the user to enter text * @param prompt The text to display * @param default_ The default text to preset the edit field with * @param title The title of the dialog; */ declare function prompt(prompt: string, default_?: string, title?: string): string; /** * Defines the default XML namespace. * @param namespace The namespace to use. */ declare function setDefaultXMLNamespace(namespace: Namespace): void; /** * Creates a source code representation of the supplied argument, and returns * it as a string. * @param what The object to uneval. */ declare function uneval(what: any): string;