K4 InDesign Javascript API Documentation

TablesTable

A table.

Instance Properties

Name Description Access
allGraphics Graphic Lists all graphics contained by the Table. read-only
allPageItems PageItem Lists all page items contained by the Table. read-only
alternatingFills AlternatingFillsTypes The pattern for alternating fills. read-write
appliedTableStyle TableStyle The table style applied to the table. Can also accept: String. read-write
associatedXMLElement XMLItem The XML element associated with the Table. read-only
bodyRowCount number The number of body rows. read-write
bottomBorderStrokeColor Swatch The color, specified as a swatch (color, gradient, tint, or mixed ink), of the bottom border stroke. read-write
bottomBorderStrokeGapColor 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. read-write
bottomBorderStrokeGapOverprint bool If true, the gap of the bottom border stroke will overprint. Note: Valid only when bottom border stroke type is not solid. read-write
bottomBorderStrokeGapTint number 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. read-write
bottomBorderStrokeOverprint bool If true, the bottom border stroke will overprint. read-write
bottomBorderStrokeTint number The tint (as a percentage) of the bottom border stroke. (Range: 0 to 100) read-write
bottomBorderStrokeType StrokeStyle The stroke type of the bottom border. Can also accept: String. read-write
bottomBorderStrokeWeight Measurement Unit (Number or String)=any The stroke weight of the bottom border stroke. read-write
breakFooters HeaderFooterBreakTypes The footer placement. read-write
breakHeaders HeaderFooterBreakTypes The header placement. read-write
buttons Buttons A collection of buttons. read-only
cells Cells A collection of table cells. read-only
changes Changes A collection of changes. read-only
checkBoxes CheckBoxes A collection of checkboxes. read-only
clipContentToGraphicCell bool If true, clips the graphic cell's content to width and height of the cell. read-write
clipContentToTextCell bool If true, clips the text cell's content to width and height of the cell. read-write
columnCount number The number of columns. read-write
columnFillsPriority bool If true, hides alternating row fills. If false, hides alternating column fills. read-write
columns Columns A collection of table columns. read-only
comboBoxes ComboBoxes A collection of comboboxes. read-only
contents 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. read-write
displayCollapsed bool If true, then the table will show collapsed in story and galley views. read-write
displayOrder DisplayOrderOptions Specifies the order the table cells will display in when viewing in story and galley views. read-write
endColumnFillColor Swatch 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. read-write
endColumnFillCount number The number of columns in the second alternating fills group. Note: Valid when alternating fills are defined for table columns. read-write
endColumnFillOverprint bool If true, the columns in the second alternating fills group will overprint. Note: Valid when alternating fills are defined for table columns. read-write
endColumnFillTint number 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. read-write
endColumnLineStyle StrokeStyle The stroke type of columns in the second alternating strokes group. Can also accept: String. read-write
endColumnStrokeColor Swatch 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. read-write
endColumnStrokeCount number The number of columns in the second alternating column strokes group. read-write
endColumnStrokeGapColor Swatch 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. read-write
endColumnStrokeGapOverprint bool 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. read-write
endColumnStrokeGapTint number 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. read-write
endColumnStrokeOverprint bool 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. read-write
endColumnStrokeTint number 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. read-write
endColumnStrokeWeight Measurement Unit (Number or String)=any The stroke weight of column borders in the second alternating column strokes group. Note: Valid when end column stroke count is 1 or greater. read-write
endRowFillColor Swatch 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. read-write
endRowFillCount number The number of rows in the second alternating fills group. Note: Valid when alternating fills are defined for table rows. read-write
endRowFillOverprint bool If true, the rows in the second alternating fills group will overprint. Note: Valid when alternating fills are defined for table rows. read-write
endRowFillTint number 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. read-write
endRowStrokeColor Swatch 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. read-write
endRowStrokeCount number The number of rows in the second alternating row strokes group. read-write
endRowStrokeGapColor Swatch 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. read-write
endRowStrokeGapOverprint bool 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. read-write
endRowStrokeGapTint number 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. read-write
endRowStrokeOverprint bool If true, the rows in the second alternating rows group will overprint. Note: Valid when end row stroke count is 1 or greater. read-write
endRowStrokeTint number 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. read-write
endRowStrokeType StrokeStyle The stroke type of rows in the second alternating strokes group. Can also accept: String. read-write
endRowStrokeWeight Measurement Unit (Number or String)=any The stroke weight of row borders in the second alternating row strokes group. Note: Valid when end row stroke count is 1 or greater. read-write
endnoteTextFrames EndnoteTextFrames A collection of endnote text frames. read-only
epstexts EPSTexts EPSTexts read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
footerRowCount number The number of footer rows. read-write
formFields FormFields A collection of form fields. read-only
graphicBottomInset Measurement Unit (Number or String)=any The bottom inset of the graphic cell. read-write
graphicLeftInset Measurement Unit (Number or String)=any The left inset of the graphic cell. read-write
graphicLines GraphicLines A collection of graphic lines. read-only
graphicRightInset Measurement Unit (Number or String)=any The right inset of the graphic cell. read-write
graphicTopInset Measurement Unit (Number or String)=any The top inset of the graphic cell. read-write
groups Groups A collection of groups. read-only
headerRowCount number The number of header rows. read-write
height Measurement Unit (Number or String)=any The height of the Table. For a table or column, specifies the sum of the row heights. read-write
hiddenTexts HiddenTexts A collection of hidden text objects. read-only
id number The unique ID of the Table. read-only
index number The index of the Table within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
leftBorderStrokeColor Swatch The color, specified as a swatch (color, gradient, tint, or mixed ink), of the left border stroke. read-write
leftBorderStrokeGapColor 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. read-write
leftBorderStrokeGapOverprint bool If true, the gap of the left border stroke will overprint. Note: Valid only when left border stroke type is not solid. read-write
leftBorderStrokeGapTint number 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. read-write
leftBorderStrokeOverprint bool If true, the left border stroke will overprint. read-write
leftBorderStrokeTint number The tint (as a percentage) of the left border stroke. (Range: 0 to 100) read-write
leftBorderStrokeType StrokeStyle The stroke type of the left border. Can also accept: String. read-write
leftBorderStrokeWeight Measurement Unit (Number or String)=any The stroke weight of the left border stroke. read-write
listBoxes ListBoxes A collection of listboxes. read-only
multiStateObjects MultiStateObjects A collection of multi-state objects. read-only
name string The name of the Table; this is an alias to the Table's label property. read-write
notes Notes A collection of notes. read-only
ovals Ovals A collection of ellipses. read-only
pageItems PageItems 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. read-only
parent The parent of the Table (a XMLElement, XmlStory, TextFrame, EndnoteTextFrame, Text, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, Character, Story or Cell). read-only
polygons Polygons A collection of polygons. read-only
properties Object A property that allows setting of several properties at the same time. read-write
radioButtons RadioButtons A collection of radio buttons. read-only
rectangles Rectangles A collection of rectangles. read-only
rightBorderStrokeColor Swatch The color, specified as a swatch (color, gradient, tint, or mixed ink), of the right border stroke. read-write
rightBorderStrokeGapColor 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. read-write
rightBorderStrokeGapOverprint bool If true, the gap color of the right border stroke will overprint. Note: Valid only when right border stroke type is not solid. read-write
rightBorderStrokeGapTint number 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. read-write
rightBorderStrokeOverprint bool If true, the right border stroke will overprint. read-write
rightBorderStrokeTint number The tint (as a percentage) of the right border stroke. (Range: 0 to 100) read-write
rightBorderStrokeType StrokeStyle The stroke type of the right border. Can also accept: String. read-write
rightBorderStrokeWeight Measurement Unit (Number or String)=any The stroke weight of the right border stroke. read-write
rows Rows A collection of table rows. read-only
signatureFields SignatureFields A collection of signature fields. read-only
skipFirstAlternatingFillColumns number 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. read-write
skipFirstAlternatingFillRows 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. read-write
skipFirstAlternatingStrokeColumns 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. read-write
skipFirstAlternatingStrokeRows 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. read-write
skipFirstHeader bool If true, skips the first occurrence of header rows. read-write
skipLastAlternatingFillColumns 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. read-write
skipLastAlternatingFillRows 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. read-write
skipLastAlternatingStrokeColumns 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. read-write
skipLastAlternatingStrokeRows 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. read-write
skipLastFooter bool If true, skips the last occurrence of footer rows. read-write
spaceAfter Measurement Unit (Number or String)=any The space below the table. read-write
spaceBefore Measurement Unit (Number or String)=any The space above the table. read-write
splineItems SplineItems The spline items collection. read-only
startColumnFillColor Swatch 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. read-write
startColumnFillCount number The number of columns in the first alternating fills group. Note: Valid when alternating fills are defined for table columns. read-write
startColumnFillOverprint bool If true, the columns in the first alternating fills group will overprint. Note: Valid when alternating fills are defined for table columns. read-write
startColumnFillTint number 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. read-write
startColumnStrokeColor Swatch The stroke color, specified as a swatch (color, gradient, tint, or mixed ink), of column borders in the first alternating column strokes group. read-write
startColumnStrokeCount number The number of columns in the first alternating column strokes group. read-write
startColumnStrokeGapColor Swatch 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. read-write
startColumnStrokeGapOverprint bool 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. read-write
startColumnStrokeGapTint number 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. read-write
startColumnStrokeOverprint bool 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. read-write
startColumnStrokeTint number 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. read-write
startColumnStrokeType StrokeStyle The stroke type of columns in the first alternating strokes group. Can also accept: String. read-write
startColumnStrokeWeight Measurement Unit (Number or String)=any The stroke weight of column borders in the first alternating column strokes group. Note: Valid when start column stroke count is 1 or greater. read-write
startRowFillColor Swatch 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. read-write
startRowFillCount number The number of rows in the first alternating fills group. Note: Valid when alternating fills are defined for table rows. read-write
startRowFillOverprint bool If true, the rows in the first alternating fills group will overprint. Note: Valid when alternating fills are defined for table rows. read-write
startRowFillTint number 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. read-write
startRowStrokeColor Swatch 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. read-write
startRowStrokeCount number The number of rows in the first alternating row strokes group. read-write
startRowStrokeGapColor Swatch 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. read-write
startRowStrokeGapOverprint bool 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. read-write
startRowStrokeGapTint number 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. read-write
startRowStrokeOverprint bool 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. read-write
startRowStrokeTint number 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. read-write
startRowStrokeType StrokeStyle The stroke type of rows in the first alternating strokes group. Can also accept: String. read-write
startRowStrokeWeight Measurement Unit (Number or String)=any The stroke weight of row borders in the first alternating row strokes group. Note: Valid when start row stroke count is 1 or greater. read-write
storyOffset InsertionPoint The insertion point before the table in the story containing the table. read-only
strokeOrder StrokeOrderTypes The order in which to display row and column strokes at corners. read-write
tableDirection TableDirectionOptions The direction of the the table read-write
textBottomInset Measurement Unit (Number or String)=any The bottom inset of the text cell. read-write
textBoxes TextBoxes A collection of text boxes. read-only
textFrames TextFrames A collection of text frames. read-only
textLeftInset Measurement Unit (Number or String)=any The left inset of the text cell. read-write
textRightInset Measurement Unit (Number or String)=any The right inset of the text cell. read-write
textTopInset Measurement Unit (Number or String)=any The top inset of the text cell. read-write
textVariableInstances TextVariableInstances A collection of text variable instances. read-only
topBorderStrokeColor Swatch The color, specified as a swatch (color, gradient, tint, or mixed ink), of the table's top border stroke. read-write
topBorderStrokeGapColor 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. read-write
topBorderStrokeGapOverprint bool If true, the gap of the top border stroke will overprint. Note: Valid only when top border stroke type is not solid. read-write
topBorderStrokeGapTint number 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. read-write
topBorderStrokeOverprint bool If true, the top border strokes will overprint. read-write
topBorderStrokeTint number The tint (as a percentage) of the table's top border stroke. (Range: 0 to 100) read-write
topBorderStrokeType StrokeStyle The stroke type of the top border. Can also accept: String. read-write
topBorderStrokeWeight Measurement Unit (Number or String)=any The stroke weight of the table's top border stroke. read-write
width Measurement Unit (Number or String)=any The width of the Table. For a table or row, specifies the sum of the column widths. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
autoTag(
)
changeGlyph(
[reverseOrder])
  → Text
changeGrep(
[reverseOrder])
  → Text
changeText(
[reverseOrder])
  → Text
changeTransliterate(
[reverseOrder])
  → Text
clearTableStyleOverrides(
)
convertBulletsAndNumberingToText(
)
convertToText(
[columnSeparator] ​[, rowSeparator])
  → Text
createOutlines(
[deleteOriginal])
  → PageItem
extractLabel(
key)
  → string
findGlyph(
[reverseOrder])
  → Text
findGrep(
[reverseOrder])
  → Text
findText(
[reverseOrder])
  → Text
findTransliterate(
[reverseOrder])
  → Text
getElements(
)
  → Table
insertLabel(
key, value)
markup(
using)
recompose(
)
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
select(
[existingSelection])
toSource(
)
  → string
toSpecifier(
)
  → string
unmerge(
)
  → Cell
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)
autoTag(
)
Tag the object or the parent story using default tags defined in XML preference.
changeGlyph(
[reverseOrder])
  → Text
Finds glyphs that match the find what value and replaces the glyphs with the change to value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
changeGrep(
[reverseOrder])
  → Text
Finds text that matches the find what value and replaces the text with the change to value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
changeText(
[reverseOrder])
  → Text
Finds text that matches the find what value and replaces the text with the change to value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
changeTransliterate(
[reverseOrder])
  → Text
Finds text that matches the find character type value and replaces the text with the change character type value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
clearTableStyleOverrides(
)
Clear Table Style Overrides
convertBulletsAndNumberingToText(
)
Convert bullets and numbering to text.
convertToText(
[columnSeparator] ​[, rowSeparator])
  → Text
Converts the table to text.
columnSeparator string 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)
rowSeparator string 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)
createOutlines(
[deleteOriginal=true])
  → PageItem
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.
deleteOriginal bool If true, deletes the original text. If false, creates the outlines as separate object(s) on top of the text. (Optional)
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
findGlyph(
[reverseOrder])
  → Text
Finds glyphs that match the find what value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
findGrep(
[reverseOrder])
  → Text
Finds text that matches the find what value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
findText(
[reverseOrder])
  → Text
Finds text that matches the find what value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
findTransliterate(
[reverseOrder])
  → Text
Finds text that matches the find character type value.
reverseOrder bool If true, returns the results in reverse order. (Optional)
getElements(
)
  → Table
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
markup(
using)
Associates the page item with the specified XML element while preserving existing content.
using XMLElement The XML element.
recompose(
)
Recomposes the text in the Table.
remove(
)
Deletes the Table.
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)
select(
[existingSelection=SelectionOptions.REPLACE_WITH])
Selects the object.
existingSelection SelectionOptions The selection status of the Table in relation to previously selected objects. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the Table.
toSpecifier(
)
  → string
Retrieves the object specifier.
unmerge(
)
  → Cell
Unmerges all merged cells in the Table.