Class Footnote

constructor

• new Footnote(opts?): Footnote

• Parameters

  • Optional opts: {
        attributes?: Partial<FootnoteAttributes>;
        contents?: FootnoteContents;
    }

    • Optional attributes?: Partial<FootnoteAttributes>

    • Optional contents?: FootnoteContents

  Returns Footnote

attributes

contents

Readonly schema

Static Readonly schema

getColor

• getColor(): null | string

• Gets

  Returns null | string

getDefaultX

• getDefaultX(): null | number

• Gets

  Returns null | number

getDefaultY

• getDefaultY(): null | number

• Gets

  Returns null | number

getDir

• getDir(): null | "ltr" | "rtl" | "lro" | "rlo"

• Gets

  Returns null | "ltr" | "rtl" | "lro" | "rlo"

getEnclosure

• getEnclosure(): null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"

• Gets

  Returns null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"

getFontFamily

• getFontFamily(): null | string

• Gets

  Returns null | string

getFontSize

• getFontSize(): null | number | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large"

• Gets

  Returns null | number | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large"

getFontStyle

• getFontStyle(): null | "normal" | "italic"

• Gets

  Returns null | "normal" | "italic"

getFontWeight

• getFontWeight(): null | "normal" | "bold"

• Gets

  Returns null | "normal" | "bold"

getHalign

• getHalign(): null | "left" | "center" | "right"

• Gets

  Returns null | "left" | "center" | "right"

getJustify

• getJustify(): null | "left" | "center" | "right"

• Gets

  Returns null | "left" | "center" | "right"

getLetterSpacing

• getLetterSpacing(): null | number | "normal"

• Gets

  Returns null | number | "normal"

getLineHeight

• getLineHeight(): null | number | "normal"

• Gets

  Returns null | number | "normal"

getLineThrough

• getLineThrough(): null | number

• Gets

  Returns null | number

getOverline

• getOverline(): null | number

• Gets

  Returns null | number

getRelativeX

• getRelativeX(): null | number

• Gets

  Returns null | number

getRelativeY

• getRelativeY(): null | number

• Gets

  Returns null | number

getRotation

• getRotation(): null | number

• Gets

  Returns null | number

getText

• getText(): string

• Gets

  Returns string

getUnderline

• getUnderline(): null | number

• Gets

  Returns null | number

getValign

• getValign(): null | "top" | "middle" | "bottom" | "baseline"

• Gets

  Returns null | "top" | "middle" | "bottom" | "baseline"

getXmlLang

• getXmlLang(): null | string

• Gets

  Returns null | string

getXmlSpace

• getXmlSpace(): null | "default" | "preserve"

• Gets

  Returns null | "default" | "preserve"

setColor

• setColor(color): Footnote

• Sets

  Parameters

  • color: null | string

  Returns Footnote

setDefaultX

• setDefaultX(defaultX): Footnote

• Sets

  Parameters

  • defaultX: null | number

  Returns Footnote

setDefaultY

• setDefaultY(defaultY): Footnote

• Sets

  Parameters

  • defaultY: null | number

  Returns Footnote

setDir

• setDir(dir): Footnote

• Sets

  Parameters

  • dir: null | "ltr" | "rtl" | "lro" | "rlo"

  Returns Footnote

setEnclosure

• setEnclosure(enclosure): Footnote

• Sets

  Parameters

  • enclosure: null | "none" | "bracket" | "rectangle" | "square" | "oval" | "circle" | "inverted-bracket" | "triangle" | "diamond" | "pentagon" | "hexagon" | "heptagon" | "octagon" | "nonagon" | "decagon"

  Returns Footnote

setFontFamily

• setFontFamily(fontFamily): Footnote

• Sets

  Parameters

  • fontFamily: null | string

  Returns Footnote

setFontSize

• setFontSize(fontSize): Footnote

• Sets

  Parameters

  • fontSize: null | number | "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large"

  Returns Footnote

setFontStyle

• setFontStyle(fontStyle): Footnote

• Sets

  Parameters

  • fontStyle: null | "normal" | "italic"

  Returns Footnote

setFontWeight

• setFontWeight(fontWeight): Footnote

• Sets

  Parameters

  • fontWeight: null | "normal" | "bold"

  Returns Footnote

setHalign

• setHalign(halign): Footnote

• Sets

  Parameters

  • halign: null | "left" | "center" | "right"

  Returns Footnote

setJustify

• setJustify(justify): Footnote

• Sets

  Parameters

  • justify: null | "left" | "center" | "right"

  Returns Footnote

setLetterSpacing

• setLetterSpacing(letterSpacing): Footnote

• Sets

  Parameters

  • letterSpacing: null | number | "normal"

  Returns Footnote

setLineHeight

• setLineHeight(lineHeight): Footnote

• Sets

  Parameters

  • lineHeight: null | number | "normal"

  Returns Footnote

setLineThrough

• setLineThrough(lineThrough): Footnote

• Sets

  Parameters

  • lineThrough: null | number

  Returns Footnote

setOverline

• setOverline(overline): Footnote

• Sets

  Parameters

  • overline: null | number

  Returns Footnote

setRelativeX

• setRelativeX(relativeX): Footnote

• Sets

  Parameters

  • relativeX: null | number

  Returns Footnote

setRelativeY

• setRelativeY(relativeY): Footnote

• Sets

  Parameters

  • relativeY: null | number

  Returns Footnote

setRotation

• setRotation(rotation): Footnote

• Sets

  Parameters

  • rotation: null | number

  Returns Footnote

setText

• setText(text): Footnote

• Sets

  Parameters

  • text: string

  Returns Footnote

setUnderline

• setUnderline(underline): Footnote

• Sets

  Parameters

  • underline: null | number

  Returns Footnote

setValign

• setValign(valign): Footnote

• Sets

  Parameters

  • valign: null | "top" | "middle" | "bottom" | "baseline"

  Returns Footnote

setXmlLang

• setXmlLang(xmlLang): Footnote

• Sets

  Parameters

  • xmlLang: null | string

  Returns Footnote

setXmlSpace

• setXmlSpace(xmlSpace): Footnote

• Sets

  Parameters

  • xmlSpace: null | "default" | "preserve"

  Returns Footnote