FootnoteOption

Footnote options.

FootnoteOption Properties

Property Type Access Description
continuingRuleColor Swatch, String r/w The color of the rule for continued footnotes.
continuingRuleGapColor Swatch, String r/w The gap color of the rule used for continued footnotes.
continuingRuleGapOverprint Boolean r/w If true, overprint the rule’s gap for continued footnotes.
continuingRuleGapTint Real (0 – 100) r/w The tint of the rule’s gap for continued footnotes (in percentage tint).
continuingRuleLeftIndent Unit (-103680 – 103680 points) r/w The left indent of the rule for continued footnotes.
continuingRuleLineWeight Unit (0 – 1000 points) r/w The line weight of the rule for continued footnotes.
continuingRuleOffset Unit (-15552 – 15552 points) r/w The vertical offset of the rule used for continued footnotes.
continuingRuleOn Boolean r/w If true, draw a rule between the text and the first footnote (that continues from the previous column).
continuingRuleOverprint Boolean r/w If true, overprint the rule for continued footnotes.
continuingRuleTint Real (0 – 100) r/w The tint of the rule for continued footnotes (in percentage tint).
continuingRuleType StrokeStyle, String r/w The stroke style of the rule used for continued footnotes.
continuingRuleWidth Unit (0 – 103680 points) r/w The stroke weight of the rule used for continued footnotes.
eosPlacement Boolean r/w If true, the footnote at the end of the story will be placed just below the text, otherwise it will appear at the bottom of the column.
footnoteFirstBaselineOffset FootnoteFirstBaseline enumeration r/w The distance between the baseline of the text and the top inset of the footnote container.
footnoteMarkerStyle CharacterStyle r/w The initial character style of a new footnote’s reference marker (all new footnotes created will use this style).
footnoteMinimumFirstBaselineOffset Unit (0 – 103680 points) r/w The minimum distance in points from the baseline of the first line of text in the footnote container and the top inset of the container.
footnoteNumberingStyle FootnoteNumberingStyle enumeration, String r/w The footnote numbering style.
footnoteTextStyle ParagraphStyle r/w The initial paragraph style of a new footnote’s text (all new footnotes created will use this style).
markerPositioning FootnoteMarkerPositioning enumeration, String r/w How to position the footnote marker.
noSplitting Boolean r/w If true, footnotes will not split across columns. Otherwise, depending on the size of the footnote and the location of the marker within the column, the footnote may flow into succeeding column(s).
parent Object read The parent of the object.
prefix String r/w The prefix text. The maximum number of characters in the prefix is 100.
properties An array of property names and values r/w Property that allows setting of several properties at the same time.
restartNumbering FootnoteRestarting enumeration, String r/w The point at which to restart footnote numbering (if at all).
ruleColor Swatch, String r/w The stroke color of the rule for new footnotes.
ruleGapColor Swatch, String r/w The gap color of the rule used for new footnotes.
ruleGapOverprint Boolean r/w If true, overprint the rule’s gap for new footnotes.
ruleGapTint Real (0 – 100) r/w The tint of the rule’s gap for new footnotes (in percentage tint).
ruleLeftIndent Unit (-103680 – 103680 points) r/w The left indent of the rule for new footnotes.
ruleLineWeight Unit (0 – 1000 points) r/w The stroke weight of the rule for new footnotes.
ruleOffset Unit (-15552 – 15552 points) r/w The vertical offset of the rule used for new footnotes.
ruleOn Boolean r/w If true, draw a rule between the text and the first footnote (that starts in this column).
ruleOverprint Boolean r/w If true, overprint the rule for new footnotes.
ruleTint Real (0 – 100) r/w The tint of the rule for new footnotes (in percentage tint).
ruleType StrokeStyle, String r/w The stroke style of the rule used for new footnotes.
ruleWidth Unit (0 – 103680 points) r/w The stroke weight of the rule used for new footnotes.
separatorText String r/w The text to insert between the footnote marker and the footnote text in the footnote itself. The maximum number of characters in the separator is 100.
showPrefixSuffix FootnotePrefixSuffix enumeration, String r/w Where to show the prefix and/or suffix text (if at all).
spaceBetween Unit (0 – 864 points) r/w The vertical space to add between individual footnotes.
spacer Unit (0 – 864 points) r/w The vertical space to add between the text and the first footnote (either new or continuing).
startAt Long (1 – 400) r/w The number at which to start footnote numbering.
suffix String r/w The suffix text. The maximum number of characters in the suffix is 100.

FootnoteOption Methods

Method Returns Description
getElements Array of Objects Resolve the object specifier.
toSource String Generate JavaScript source that, if executed, will return the specified objects.
toSpecifier String Retrieve the object specifier.

Leave a Comment

Previous post:

Next post: