K4 InDesign Javascript API Documentation

PreferencesGridDataInformation

Grid defaults. Note: Applies to named, layout, and frame (story) grids.

Extends

Instance Properties

Name Description Access
appliedFont The font applied to the GridDataInformation, specified as either a font object or the name of font family. Can return: Font or String. read-write
characterAki number The amount of white space between characters. read-write
characterAlignment CharacterAlignment The alignment of small characters to the largest character in the line. read-write
characterCountLocation CharacterCountLocation The character count location. Note: Valid when show character count is true. read-write
characterCountSize number The character size for the character count display. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
fontStyle string The name of the font style. read-write
gridAlignment GridAlignment The alignment to the frame grid or baseline grid. read-write
gridView GridViewSettings The grid view setting. read-write
horizontalScale number The horizontal scaling applied to the GridDataInformation. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
lineAki number The amount of white space between lines. read-write
lineAlignment LineAlignment The line justification. read-write
parent The parent of the GridDataInformation (a Story, XmlStory, Page, NamedGrid, TextFrame or EndnoteTextFrame). read-only
pointSize Measurement Unit (Number or String)=any The text size. read-write
properties Object A property that allows setting of several properties at the same time. read-write
verticalScale number The vertical scaling applied to the GridDataInformation. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → GridDataInformation
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(
)
  → GridDataInformation
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 GridDataInformation.
toSpecifier(
)
  → string
Retrieves the object specifier.