K4 InDesign Javascript API Documentation

TablesColumn

A table column.

Instance Properties

Name Description Access
autoGrow bool 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. read-write
bottomEdgeStrokeColor Swatch The swatch (color, gradient, tint, or mixed ink) applied to the bottom edge border stroke. read-write
bottomEdgeStrokeGapColor 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. read-write
bottomEdgeStrokeGapOverprint bool If true, the gap color of the bottom edge border stroke will overprint. Note: Not valid when bottom edge stroke type is solid. read-write
bottomEdgeStrokeGapTint number 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. read-write
bottomEdgeStrokeOverprint bool If true, the bottom edge border stroke will overprint. read-write
bottomEdgeStrokeTint number The tint (as a percentage) of the bottom edge border stroke. read-write
bottomEdgeStrokeType StrokeStyle The stroke type of the bottom edge. Can also accept: String. read-write
bottomEdgeStrokeWeight Measurement Unit (Number or String)=any The stroke weight of the bottom edge border stroke. read-write
bottomInset Measurement Unit (Number or String)=any The bottom inset of the cell.The API has been deprecated. Use TextBottomInset or GraphicBottomInset read-write
cells Cells A collection of table cells. read-only
clipContentToCell bool If true, clips the cell's content to width and height of the cell. The API has been deprecated. Use ClipContentsToTextCell or ClipContentsToPageItemCell read-write
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
columnSpan number The number of columns that the object spans. read-only
columns Columns A collection of table columns. read-only
contents 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. read-write
diagonalLineInFront bool If true, draws the diagonal line in front of cell contents. read-write
diagonalLineStrokeColor Swatch The diagonal line color, specified as a swatch. read-write
diagonalLineStrokeGapColor 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. read-write
diagonalLineStrokeGapOverprint bool If true, the stroke gap of the diagonal line will overprint. Note: Not valid when diagonal line stroke type is solid. read-write
diagonalLineStrokeGapTint number The tint (as a percentage) of the diagonal line stroke gap color. Note: Not valid when diagonal line stroke type is solid. read-write
diagonalLineStrokeOverprint bool If true, the diagonal line stroke will overprint. read-write
diagonalLineStrokeTint number The diagonal line tint (as a percentage). (Range: 0 to 100) read-write
diagonalLineStrokeType StrokeStyle The stroke type of the diagonal line(s). Can also accept: String. read-write
diagonalLineStrokeWeight Measurement Unit (Number or String)=any The diagonal line stroke weight. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
fillColor Swatch The swatch (color, gradient, tint, or mixed ink) applied to the fill of the object. Can also accept: String. read-write
fillTint number The tint (as a percentage) of the fill of the object. read-write
firstBaselineOffset FirstBaseline The distance between the baseline of the text and the top inset of the cell. read-write
gradientFillAngle number The angle of a linear gradient applied to the fill of the object. (Range: -180 to 180) read-write
gradientFillLength number The length (of a linear gradient) or radius (of a radial gradient) applied to the fill of the object. read-write
gradientFillStart Measurement Unit (Number or String)=any The starting point (in page coordinates) of a gradient applied to the fill of the Column, in the format [x, y]. read-write
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
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
height Measurement Unit (Number or String)=any The height of the Column. For a table or column, specifies the sum of the row heights. read-write
index number The index of the Column within its containing object. read-only
innerColumnStrokeColor Swatch The color, specified as a swatch, of the inner column border stroke. read-write
innerColumnStrokeGapColor 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. read-write
innerColumnStrokeGapOverprint bool If true, the gap color of the inner column border stroke will overprint. Note: Not valid when inner column stroke type is solid. read-write
innerColumnStrokeGapTint number 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. read-write
innerColumnStrokeOverprint bool If true, the inner column border stroke will overprint. read-write
innerColumnStrokeTint number The tint (as a percentage) of the inner column border stroke. (Range: 0 to 100) read-write
innerColumnStrokeType StrokeStyle The stroke type of the inner column. Can also accept: String. read-write
innerColumnStrokeWeight Measurement Unit (Number or String)=any The stroke weight of the inner column border stroke. read-write
innerRowStrokeColor Swatch The color, specified as a swatch, of the inner row border stroke. read-write
innerRowStrokeGapColor 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. read-write
innerRowStrokeGapOverprint bool If true, the gap color of the inner row border stroke will overprint. Note: Not valid when inner row stroke type is solid. read-write
innerRowStrokeGapTint number 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. read-write
innerRowStrokeOverprint bool If true, the inner row border stroke will overprint. read-write
innerRowStrokeTint number The tint (as a percentage) of the inner row border stroke. (Range: 0 to 100) read-write
innerRowStrokeType StrokeStyle The stroke type of the inner row. Can also accept: String. read-write
innerRowStrokeWeight Measurement Unit (Number or String)=any The stroke weight of the inner row border strokes. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
keepWithNextRow bool If true, keeps the row with the next row when the table is split across text frames or pages. read-write
leftEdgeStrokeColor Swatch The swatch (color, gradient, tint, or mixed ink) applied to the left edge border stroke. read-write
leftEdgeStrokeGapColor 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. read-write
leftEdgeStrokeGapOverprint bool If true, the gap color of the left edge border stroke will overprint. Note: Not valid when left edge stroke type is solid. read-write
leftEdgeStrokeGapTint number 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. read-write
leftEdgeStrokeOverprint bool If true, the left edge border stroke will overprint. read-write
leftEdgeStrokeTint number The tint (as a percentage) of the left edge border stroke. (Range: 0 to 100) read-write
leftEdgeStrokeType StrokeStyle The stroke type of the left edge. Can also accept: String. read-write
leftEdgeStrokeWeight Measurement Unit (Number or String)=any The stroke weight of the left edge border stroke. read-write
leftInset Measurement Unit (Number or String)=any The left inset of the cell.The API has been deprecated. Use TextLeftInset or GraphicLeftInset read-write
maximumHeight Measurement Unit (Number or String)=any 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. read-write
minimumFirstBaselineOffset Measurement Unit (Number or String)=any The space between the baseline of the text and the top inset of the frame or cell. read-write
minimumHeight Measurement Unit (Number or String)=any 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. read-write
name string The name of the Column. read-only
overflows bool If true, the story has overset text. read-only
overprintFill bool If true, the fill of the object will overprint. read-write
paragraphSpacingLimit Measurement Unit (Number or String)=any The maximum space that can be added between paragraphs in a cell. Note: Valid only when vertical justification is justified. read-write
parent Table The parent of the Column (a Table). read-only
parentColumn Column The parent column of the cell. read-only
parentRow Row The parent row of the cell. read-only
properties Object A property that allows setting of several properties at the same time. read-write
rightEdgeStrokeColor Swatch The color, specified as a swatch, of the right edge border stroke. read-write
rightEdgeStrokeGapColor 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. read-write
rightEdgeStrokeGapOverprint bool If true, the gap color of the right edge border stroke will overprint. Note: Not valid when right edge stroke type is solid. read-write
rightEdgeStrokeGapTint number 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. read-write
rightEdgeStrokeOverprint bool If true, the right edge border stroke will overprint. read-write
rightEdgeStrokeTint number The tint (as a percentage) of the right edge border stroke. (Range: 0 to 100) read-write
rightEdgeStrokeType StrokeStyle The stroke type of the right edge. Can also accept: String. read-write
rightEdgeStrokeWeight Measurement Unit (Number or String)=any The stroke weight of the right edge border stroke. read-write
rightInset Measurement Unit (Number or String)=any The right inset of the cell.The API has been deprecated. Use TextLeftInset or GraphicRightInset read-write
rotationAngle number The rotation angle (in degrees) of the cell, specified as one of the following values: 0, 90, 180, or 270. read-write
rowSpan number The number of rows that the object spans. read-only
rowType RowTypes The row type. read-write
rows Rows A collection of table rows. read-only
startRow StartParagraph Indicates where to start the row. read-write
textBottomInset Measurement Unit (Number or String)=any The bottom inset of the text cell. read-write
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
topEdgeStrokeColor Swatch The swatch (color, gradient, tint, or mixed ink) applied to the top edge border stroke. read-write
topEdgeStrokeGapColor 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. read-write
topEdgeStrokeGapOverprint bool If true, the gap color of the top edge border stroke will overprint. Note: Not valid when top edge stroke type is solid. read-write
topEdgeStrokeGapTint number 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. read-write
topEdgeStrokeOverprint bool If true, the top edge border stroke will overprint. read-write
topEdgeStrokeTint number The tint (as a percentage) of the top edge border stroke. (Range: 0 to 100) read-write
topEdgeStrokeType StrokeStyle The stroke type of the top edge. Can also accept: String. read-write
topEdgeStrokeWeight Measurement Unit (Number or String)=any The stroke weight of the top edge border stroke. read-write
topInset Measurement Unit (Number or String)=any The top inset of the cell. The API has been deprecated. Use TextTopInset or GraphicTopInset read-write
topLeftDiagonalLine bool If true, draws a diagonal line starting from the top left. read-write
topRightDiagonalLine bool If true, draws a diagonal line starting from the top right. read-write
verticalJustification VerticalJustification The vertical alignment of cell. read-write
width Measurement Unit (Number or String)=any The width of the Column. For a table or row, specifies the sum of the column widths. read-write
writingDirection HorizontalOrVertical The direction of the text in the cell. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
changeGlyph(
[reverseOrder])
  → Text
changeGrep(
[reverseOrder])
  → Text
changeText(
[reverseOrder])
  → Text
changeTransliterate(
[reverseOrder])
  → Text
createOutlines(
[deleteOriginal])
  → PageItem
findGlyph(
[reverseOrder])
  → Text
findGrep(
[reverseOrder])
  → Text
findText(
[reverseOrder])
  → Text
findTransliterate(
[reverseOrder])
  → Text
getElements(
)
  → Column
merge(
with)
  → Cell
recompose(
)
redistribute(
using, thru)
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
select(
[existingSelection])
split(
using)
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)
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)
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)
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(
)
  → Column
Resolves the object specifier, creating an array of object references.
merge(
with)
  → Cell
Merges the cells.
with The cell(s) to merge with. Can accept: Cell, Row or Column. (Optional)
recompose(
)
Recomposes the text in the Column.
redistribute(
using, thru)
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.
using HorizontalOrVertical The direction in which to redistribute.
thru The last Column in the range. Can accept: Cell, Column or Row. (Optional)
remove(
)
Deletes the Column.
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 Column in relation to previously selected objects. (Optional)
split(
using)
Splits the cell along the specified axis.
using HorizontalOrVertical The direction in which to split the cell.
toSource(
)
  → string
Generates a string which, if executed, will return the Column.
toSpecifier(
)
  → string
Retrieves the object specifier.
unmerge(
)
  → Cell
Unmerges all merged cells in the Column.