K4 InDesign Javascript API Documentation

TablesCellStyle

A cell style.

Instance Properties

Name Description Access
appliedParagraphStyle The paragraph style applied to the text. Can return: ParagraphStyle or NothingEnum enumerator. Can also accept: String. read-write
basedOn The style that this style is based on. Can return: CellStyle or String. read-write
bottomEdgeStrokeColor The swatch (color, gradient, tint, or mixed ink) applied to the bottom edge border stroke. Can return: Swatch or NothingEnum enumerator. read-write
bottomEdgeStrokeGapColor 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. Can return: Swatch or NothingEnum enumerator. read-write
bottomEdgeStrokeGapOverprint If true, the gap color of the bottom edge border stroke will overprint. Note: Not valid when bottom edge stroke type is solid. Can return: Boolean or NothingEnum enumerator. read-write
bottomEdgeStrokeGapTint 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. Can return: Real or NothingEnum enumerator. read-write
bottomEdgeStrokeOverprint If true, the bottom edge border stroke will overprint. Can return: Boolean or NothingEnum enumerator. read-write
bottomEdgeStrokeTint The tint (as a percentage) of the bottom edge border stroke. Can return: Real or NothingEnum enumerator. read-write
bottomEdgeStrokeType The stroke type of the bottom edge. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String. read-write
bottomEdgeStrokeWeight The stroke weight of the bottom edge border stroke. Can return: Unit or NothingEnum enumerator. read-write
bottomInset The bottom inset of the cell.The API has been deprecated. Use TextBottomInset or GraphicBottomInset. Can return: Unit or NothingEnum enumerator. read-write
clipContentToCell If true, clips the cell's content to width and height of the cell. The API has been deprecated. Use ClipContentsToTextCell or ClipContentsToPageItemCell. Can return: Boolean or NothingEnum enumerator. read-write
clipContentToGraphicCell If true, clips the graphic cell's content to width and height of the cell. Can return: Boolean or NothingEnum enumerator. read-write
clipContentToTextCell If true, clips the text cell's content to width and height of the cell. Can return: Boolean or NothingEnum enumerator. read-write
diagonalLineInFront If true, draws the diagonal line in front of cell contents. Can return: Boolean or NothingEnum enumerator. read-write
diagonalLineStrokeColor The diagonal line color, specified as a swatch. Can return: Swatch or NothingEnum enumerator. read-write
diagonalLineStrokeGapColor 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. Can return: Swatch or NothingEnum enumerator. read-write
diagonalLineStrokeGapOverprint If true, the stroke gap of the diagonal line will overprint. Note: Not valid when diagonal line stroke type is solid. Can return: Boolean or NothingEnum enumerator. read-write
diagonalLineStrokeGapTint The tint (as a percentage) of the diagonal line stroke gap color. Note: Not valid when diagonal line stroke type is solid. Can return: Real or NothingEnum enumerator. read-write
diagonalLineStrokeOverprint If true, the diagonal line stroke will overprint. Can return: Boolean or NothingEnum enumerator. read-write
diagonalLineStrokeTint The diagonal line tint (as a percentage). (Range: 0 to 100). Can return: Real or NothingEnum enumerator. read-write
diagonalLineStrokeType The stroke type of the diagonal line(s). Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String. read-write
diagonalLineStrokeWeight The diagonal line stroke weight. Can return: Unit or NothingEnum enumerator. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
fillColor The swatch (color, gradient, tint, or mixed ink) applied to the fill of the object. Can return: Swatch or NothingEnum enumerator. Can also accept: String. read-write
fillTint The tint (as a percentage) of the fill of the object. Can return: Real or NothingEnum enumerator. read-write
firstBaselineOffset The distance between the baseline of the text and the top inset of the cell. Can return: FirstBaseline enumerator or NothingEnum enumerator. read-write
gradientFillAngle The angle of a linear gradient applied to the fill of the object. (Range: -180 to 180). Can return: Real or NothingEnum enumerator. read-write
gradientFillLength The length (of a linear gradient) or radius (of a radial gradient) applied to the fill of the object. Can return: Real or NothingEnum enumerator. read-write
gradientFillStart The starting point (in page coordinates) of a gradient applied to the fill of the CellStyle, in the format [x, y]. Can return: Array of 2 Units or NothingEnum enumerator. read-write
graphicBottomInset The bottom inset of the graphic cell. Can return: Unit or NothingEnum enumerator. read-write
graphicLeftInset The left inset of the graphic cell. Can return: Unit or NothingEnum enumerator. read-write
graphicRightInset The right inset of the graphic cell. Can return: Unit or NothingEnum enumerator. read-write
graphicTopInset The top inset of the graphic cell. Can return: Unit or NothingEnum enumerator. read-write
id number The unique ID of the CellStyle. read-only
index number The index of the CellStyle 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
leftEdgeStrokeColor The swatch (color, gradient, tint, or mixed ink) applied to the left edge border stroke. Can return: Swatch or NothingEnum enumerator. read-write
leftEdgeStrokeGapColor 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. Can return: Swatch or NothingEnum enumerator. read-write
leftEdgeStrokeGapOverprint If true, the gap color of the left edge border stroke will overprint. Note: Not valid when left edge stroke type is solid. Can return: Boolean or NothingEnum enumerator. read-write
leftEdgeStrokeGapTint 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. Can return: Real or NothingEnum enumerator. read-write
leftEdgeStrokeOverprint If true, the left edge border stroke will overprint. Can return: Boolean or NothingEnum enumerator. read-write
leftEdgeStrokeTint The tint (as a percentage) of the left edge border stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator. read-write
leftEdgeStrokeType The stroke type of the left edge. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String. read-write
leftEdgeStrokeWeight The stroke weight of the left edge border stroke. Can return: Unit or NothingEnum enumerator. read-write
leftInset The left inset of the cell.The API has been deprecated. Use TextLeftInset or GraphicLeftInset. Can return: Unit or NothingEnum enumerator. read-write
minimumFirstBaselineOffset The space between the baseline of the text and the top inset of the frame or cell. Can return: Unit (0 - 8640 points) or NothingEnum enumerator. read-write
name string The name of the style. read-write
overprintFill If true, the fill of the object will overprint. Can return: Boolean or NothingEnum enumerator. read-write
paragraphSpacingLimit The maximum space that can be added between paragraphs in a cell. Note: Valid only when vertical justification is justified. Can return: Unit or NothingEnum enumerator. read-write
parent The parent of the CellStyle (a Document, Application or CellStyleGroup). read-only
properties Object A property that allows setting of several properties at the same time. read-write
rightEdgeStrokeColor The color, specified as a swatch, of the right edge border stroke. Can return: Swatch or NothingEnum enumerator. read-write
rightEdgeStrokeGapColor 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. Can return: Swatch or NothingEnum enumerator. read-write
rightEdgeStrokeGapOverprint If true, the gap color of the right edge border stroke will overprint. Note: Not valid when right edge stroke type is solid. Can return: Boolean or NothingEnum enumerator. read-write
rightEdgeStrokeGapTint 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. Can return: Real or NothingEnum enumerator. read-write
rightEdgeStrokeOverprint If true, the right edge border stroke will overprint. Can return: Boolean or NothingEnum enumerator. read-write
rightEdgeStrokeTint The tint (as a percentage) of the right edge border stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator. read-write
rightEdgeStrokeType The stroke type of the right edge. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String. read-write
rightEdgeStrokeWeight The stroke weight of the right edge border stroke. Can return: Unit or NothingEnum enumerator. read-write
rightInset The right inset of the cell.The API has been deprecated. Use TextLeftInset or GraphicRightInset. Can return: Unit or NothingEnum enumerator. read-write
rotationAngle The rotation angle (in degrees) of the cell, specified as one of the following values: 0, 90, 180, or 270. Can return: Real or NothingEnum enumerator. read-write
textBottomInset The bottom inset of the text cell. Can return: Unit or NothingEnum enumerator. read-write
textLeftInset The left inset of the text cell. Can return: Unit or NothingEnum enumerator. read-write
textRightInset The right inset of the text cell. Can return: Unit or NothingEnum enumerator. read-write
textTopInset The top inset of the text cell. Can return: Unit or NothingEnum enumerator. read-write
topEdgeStrokeColor The swatch (color, gradient, tint, or mixed ink) applied to the top edge border stroke. Can return: Swatch or NothingEnum enumerator. read-write
topEdgeStrokeGapColor 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. Can return: Swatch or NothingEnum enumerator. read-write
topEdgeStrokeGapOverprint If true, the gap color of the top edge border stroke will overprint. Note: Not valid when top edge stroke type is solid. . Can return: Boolean or NothingEnum enumerator. read-write
topEdgeStrokeGapTint 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. Can return: Real or NothingEnum enumerator. read-write
topEdgeStrokeOverprint If true, the top edge border stroke will overprint. Can return: Boolean or NothingEnum enumerator. read-write
topEdgeStrokeTint The tint (as a percentage) of the top edge border stroke. (Range: 0 to 100). Can return: Real or NothingEnum enumerator. read-write
topEdgeStrokeType The stroke type of the top edge. Can return: StrokeStyle or NothingEnum enumerator. Can also accept: String. read-write
topEdgeStrokeWeight The stroke weight of the top edge border stroke. Can return: Unit or NothingEnum enumerator. read-write
topInset The top inset of the cell. The API has been deprecated. Use TextTopInset or GraphicTopInset. Can return: Unit or NothingEnum enumerator. read-write
topLeftDiagonalLine If true, draws a diagonal line starting from the top left. Can return: Boolean or NothingEnum enumerator. read-write
topRightDiagonalLine If true, draws a diagonal line starting from the top right. Can return: Boolean or NothingEnum enumerator. read-write
verticalJustification The vertical alignment of cell. Can return: VerticalJustification enumerator or NothingEnum enumerator. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
duplicate(
)
  → CellStyle
extractLabel(
key)
  → string
getElements(
)
  → CellStyle
insertLabel(
key, value)
move(
to, reference)
  → CellStyle
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(
)
  → CellStyle
Duplicates the CellStyle.
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → CellStyle
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)
  → CellStyle
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 CellStyle 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 CellStyle.
toSpecifier(
)
  → string
Retrieves the object specifier.