K4 InDesign Javascript API Documentation

PreferencesGridPreference

Grid preferences.

Extends

Instance Properties

Name Description Access
baselineColor 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. read-write
baselineDivision Measurement Unit (Number or String)=any The amount of space between baseline grid lines. read-write
baselineGridRelativeOption BaselineGridRelativeOption The zero point for the baseline grid offset. read-write
baselineGridShown bool If true, displays the baseline grid. read-write
baselineStart Measurement Unit (Number or String)=any The amount to offset the baseline grid from the zero point. read-write
baselineViewThreshold number The magnification (as a percentage) less than which ruler guides do not appear. (Range: 5 to 4000) read-write
documentGridShown bool If true, displays the document grid. read-write
documentGridSnapto bool If true, an object snaps to the nearest grid line when the object is created, moved, or resized. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
gridColor 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. read-write
gridsInBack bool If true, places grids behind all other objects on the spread. read-write
horizontalGridSubdivision number The number of rows into which to subdivide the space between horizontal document grid lines. read-write
horizontalGridlineDivision Measurement Unit (Number or String)=any The amount of space between major horizontal lines in the document grid. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent The parent of the GridPreference (a Application or Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write
verticalGridSubdivision number The number of columns into which to subdivide the space between vertical document grid lines. read-write
verticalGridlineDivision Measurement Unit (Number or String)=any The amount of space between major vertical lines in the document grid. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → GridPreference
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → GridPreference
Resolves the object specifier, creating an array of object references.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the GridPreference.
toSpecifier(
)
  → string
Retrieves the object specifier.