K4 InDesign Javascript API Documentation

TablesTableStyle

A table style.

Instance Properties

Name Description Access
basedOn The style that this style is based on. Can return: TableStyle or String. read-write
bodyRegionCellStyle CellStyle The cell style of the body region. Can also accept: String. 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
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
columnFillsPriority bool If true, hides alternating row fills. If false, hides alternating column fills. 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
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
footerRegionCellStyle CellStyle The cell style of the footer region. Can also accept: String. read-write
footerRegionSameAsBodyRegion bool If true, uses the cell style of the body region for the footer region. 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
headerRegionCellStyle CellStyle The cell style of the header region. Can also accept: String. read-write
headerRegionSameAsBodyRegion bool If true, use the cell style of the body region for the header region. read-write
id number The unique ID of the TableStyle. read-only
index number The index of the TableStyle 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
leftColumnRegionCellStyle CellStyle The cell style of the left column region. Can also accept: String. read-write
leftColumnRegionSameAsBodyRegion bool If true, uses the cell style of the body region for the left column region. read-write
name string The name of the TableStyle. read-write
parent The parent of the TableStyle (a Document, Application or TableStyleGroup). read-only
properties Object A property that allows setting of several properties at the same time. read-write
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
rightColumnRegionCellStyle CellStyle The cell style of the right column region. Can also accept: String. read-write
rightColumnRegionSameAsBodyRegion bool If true, uses the cell style of the body region for the right column region. read-write
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
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
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
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
strokeOrder StrokeOrderTypes The order in which to display row and column strokes at corners. 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
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

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
duplicate(
)
  → TableStyle
extractLabel(
key)
  → string
getElements(
)
  → TableStyle
insertLabel(
key, value)
move(
to, reference)
  → TableStyle
remove(
[replacingWith])
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)
duplicate(
)
  → TableStyle
Duplicates the TableStyle.
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → TableStyle
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.
move(
to, reference)
  → TableStyle
Moves the style to the specified location.
to LocationOptions The location relative to the reference object or within the containing object.
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)
remove(
[replacingWith])
Deletes the style.
replacingWith TableStyle The style to apply in place of the deleted style. (Optional)
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 TableStyle.
toSpecifier(
)
  → string
Retrieves the object specifier.