Class DocElement

Readonlyattributes

children

ReadonlytagName

StaticSINGLES

align

• align(alignment: Align, ...content: TMPNode[]): DocElement

  Set the alignment of the text.

  Parameters

  • alignment: Align
  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().align(Align.Center, "center content moment");
  Copy

alpha

• alpha(opacity: string | number, ...content: TMPNode[]): DocElement

  Set the opacity of the text.

  Parameters

  • opacity: string | number
  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().alpha("AA");
  Copy

bold

• bold(...content: TMPNode[]): DocElement

  Make the text bold.

  Parameters

  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().bold("bold text....");
  Copy

clone

• clone(): TMPElement

  Deep clone the tree.

  Returns TMPElement

  Example

  const formatted = tb(color("blue"), italics())
    .text("Deep clone!!!");
  
  const clone = formatted.clone();
  Copy

color

• color(
      clr: string | [number, number, number, number],
      ...content: TMPNode[],
  ): DocElement

  Set the colour of the text

  Parameters

  • clr: string | [number, number, number, number]
  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().color("ff0000ff", "Red text.");
  Copy

  Or using RGBA:

  const formatted = tb().color([255, 0, 0, 255], "RGBA red text.");
  Copy

font

• font(face: string, ...content: TMPNode[]): DocElement

  Change the font face of the text.

  Parameters

  • face: string
  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().font("Comic Sans MS", "funeral service.");
  Copy

getAttributes

• getAttributes(): string

  Get the representation of the element attributes as a string.

  Returns string

getClosing

• getClosing(): string

  Get the representation of the element closing tag as a string.

  Returns string

getInner

• getInner(): string

  Get the inner representation of the element structure as a string.

  Returns string

getTag

• getTag(): string

  Get the representation of the element tag as a string.

  Returns string

highlight

• highlight(
      color: string | [number, number, number, number],
      ...content: TMPNode[],
  ): void

  Change the background colour of the text.

  Parameters

  • color: string | [number, number, number, number]
  • ...content: TMPNode[]

  Returns void

  Example

  const formatted = tb().highlight("00ff00aa", "This text has a green background.");
  Copy

  Or using RGBA:

  const formatted = tb().highlight([0, 255, 0, 255], "This text has a green background.");
  Copy

indent

• indent(indentation: string | number, ...content: TMPNode[]): DocElement

  Change the left indentation of the text.

  Parameters

  • indentation: string | number
  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().indent("5em", "I am indented by 5.");
  Copy

italics

• italics(...content: TMPNode[]): DocElement

  Make the text italic.

  Parameters

  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().italics("italic text....");
  Copy

link

• link(resource: string, ...content: TMPNode[]): boolean

  Create a link to a resource (Not necessarily related to anything).

  Parameters

  • resource: string
  • ...content: TMPNode[]

  Returns boolean

  Example

  const formatted = tb().link("https://google.com", "click here to get tracked.");
  Copy

lnheight

• lnheight(height: string | number, ...content: TMPNode[]): boolean

  Change the line height of the text.

  Parameters

  • height: string | number
  • ...content: TMPNode[]

  Returns boolean

  Example

  const formatted = tb().indent("2em", "I have huge line spacing like a boss.");
  Copy

lnindent

• lnindent(indentation: string | number, ...content: TMPNode[]): boolean

  Change only the indentation for the first line of the text.

  Parameters

  • indentation: string | number
  • ...content: TMPNode[]

  Returns boolean

  Example

  const formatted = tb().indent("2em", "Only this line is indented, any other line will not be indented as displayed by this long piece of text.");
  Copy

lowercase

• lowercase(...content: TMPNode[]): DocElement

  Force the text to be rendered as lowercase.

  Parameters

  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().lowercase("THIS TEXT WILL BE IN LOWERCASE."):
  Copy

margin

• margin(amount: string | number, ...content: TMPNode[]): void

  Change the margin of the text.

  Parameters

  • amount: string | number
  • ...content: TMPNode[]

  Returns void

  Example

  const formatted = tb().margin("5em", "Margin text."):
  Copy

mark

• mark(
      color: string | [number, number, number, number],
      ...content: TMPNode[],
  ): void

  Change the background colour of the text.

  Parameters

  • color: string | [number, number, number, number]
  • ...content: TMPNode[]

  Returns void

  Example

  const formatted = tb().mark("00ff00aa", "This text has a green background.");
  Copy

  Or using RGBA:

  const formatted = tb().mark([0, 255, 0, 255], "This text has a green background.");
  Copy

mono

• mono(spacing: string | number, ...content: TMPNode[]): DocElement

  Force the text to be rendered monospace.

  Parameters

  • spacing: string | number
  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().mono("1em", "console.log('Code block.').");
  Copy

nbspace

• nbspace(...content: TMPNode[]): DocElement

  Stop spaces from breaking up text.

  Parameters

  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().nbspace("This text does not B R E A K U P")
  Copy

nextpage

• nextpage(): DocElement

  Move to the next page.

  Returns DocElement

  Example

  const formatted = tb().text("This text").nextpage().text("goes across two pages");
  Copy

pos

• pos(x: string | number, ...content: TMPNode[]): DocElement

  Change the position of the text on the x axis.

  Parameters

  • x: string | number
  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().pos("50%", "I am in the middle of the box.");
  Copy

s

• s(...content: TMPNode[]): DocElement

  Create a line through the text.

  Parameters

  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().s("Nevermind");
  Copy

size

• size(size: string | number, ...content: TMPNode[]): DocElement

  Change the size of the font.

  Parameters

  • size: string | number
  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().size("150%", "This text is rather large.");
  Copy

smallcaps

• smallcaps(...content: TMPNode[]): DocElement

  Force the text to be rendered as small caps.

  Parameters

  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().smallcaps("This Text Will Be In Small Caps"):
  Copy

space

• space(space: string | number): DocElement

  Create a space of a specified size.

  Parameters

  • space: string | number

  Returns DocElement

  Example

  const formatted = tb().text("Huge").space("5em").text("space");
  Copy

spacing

• spacing(space: string | number, ...content: TMPNode[]): DocElement

  Change the spacing relative to normal character spacing.

  Parameters

  • space: string | number
  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().spacing("0.5em", "Spaced out text moment.");
  Copy

st

• st(...content: TMPNode[]): DocElement

  Create a line through the text.

  Parameters

  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().st("Nevermind");
  Copy

strike

• strike(...content: TMPNode[]): DocElement

  Create a line through the text.

  Parameters

  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().strike("Nevermind");
  Copy

strikethrough

• strikethrough(...content: TMPNode[]): DocElement

  Create a line through the text.

  Parameters

  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().strikethrough("Nevermind");
  Copy

subscript

• subscript(...content: TMPNode[]): DocElement

  Create a text in subscript.

  Parameters

  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().text("log").subscript("2").text("(8) = 3");
  Copy

superscript

• superscript(...content: TMPNode[]): DocElement

  Create a text in superscript.

  Parameters

  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().text("6").superscript("2").text(" = 36");
  Copy

text

• text(node: TMPNode, parse?: boolean): DocElement

  Create a text element.

  Parameters

  • node: TMPNode
  • parse: boolean = false

  Returns DocElement

  Example

  const formatted = tb().text("text element like a boss");
  Copy

toString

• toString(): string

  Get the representation of the element structure as a string.

  Returns string

underline

• underline(...content: TMPNode[]): DocElement

  Create a underline underneath the text.

  Parameters

  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().underline("Important text");
  Copy

uppercase

• uppercase(...content: TMPNode[]): DocElement

  Force the text to be rendered as uppercase.

  Parameters

  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().uppercase("this text will be in lowercase."):
  Copy

voffset

• voffset(offset: string | number, ...content: TMPNode[]): DocElement

  Change the vertical offset of the text.

  Parameters

  • offset: string | number
  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().voffset("5em", "This text is high up.").voffset(" and this one is low down.");
  Copy

width

• width(width: string | number, ...content: TMPNode[]): DocElement

  Change the maximum width of the text before wrapping.

  Parameters

  • width: string | number
  • ...content: TMPNode[]

  Returns DocElement

  Example

  const formatted = tb().width("25%", "This text doesn't go that far :(");
  Copy