Template API Reference

Objects

`notebook` : object

Functions for creating Fiberplane Notebooks

`cell` : object

Functions for creating notebook cells

`format` : object

Functions for formatting text

Functions

`snippet(cells)` ⇒ Array.<Cell>

Function for creating Snippets, or reusable groups of cells.

notebook : object

Functions for creating Fiberplane Notebooks

Kind: global namespace
Example

fp.notebook.new('My Notebook')
 .setTimeRangeRelative(minutes=60)
 .addCells([...])

• notebook : object
  • .Notebook
    • .setTimeRangeRelative(minutes) ⇒ Notebook
    • .setTimeRangeAbsolute(from, to) ⇒ Notebook
    • .setSelectedDataSource(providerType, dataSourceName, proxyName) ⇒ Notebook
    • .addCell(cell) ⇒ Notebook
    • .addCells(cells) ⇒ Notebook
    • .addLabel(key, value) ⇒ Notebook
    • .addLabels(labels) ⇒ Notebook
  • .new(title) ⇒ Notebook

notebook.Notebook

A Fiberplane Notebook.

Kind: static class of notebook
See: notebook.new to create a Notebook

• .Notebook
  • .setTimeRangeRelative(minutes) ⇒ Notebook
  • .setTimeRangeAbsolute(from, to) ⇒ Notebook
  • .setSelectedDataSource(providerType, dataSourceName, proxyName) ⇒ Notebook
  • .addCell(cell) ⇒ Notebook
  • .addCells(cells) ⇒ Notebook
  • .addLabel(key, value) ⇒ Notebook
  • .addLabels(labels) ⇒ Notebook

notebook.setTimeRangeRelative(minutes) ⇒ Notebook

Set the notebook time range relative to when it is created.

For example, specifying minutes=60 will set the start timestamp to 60 minutes before the notebook is created. The end timestamp will automatically be set to the time when the notebook is created.

By default, the time range is set to 60 minutes relative to when the notebook is created.

Kind: instance method of Notebook

notebook.setTimeRangeAbsolute(from, to) ⇒ Notebook

Set the time range of the notebook using absolute timestamps.

Note: in most cases, you will want to use [notebook#setTimeRangeRelative](notebook#setTimeRangeRelative) instead.

Kind: instance method of Notebook

notebook.setSelectedDataSource(providerType, dataSourceName, proxyName) ⇒ Notebook

Select a data source for the given provider type.

The workspace defaults will be used if none is specified.

Kind: instance method of Notebook

notebook.addCell(cell) ⇒ Notebook

Add a single cell to the notebook.

Kind: instance method of Notebook

notebook.addCells(cells) ⇒ Notebook

Add an array of cells to the notebook.

Note: this function supports nested arrays of cells.

Kind: instance method of Notebook

notebook.addLabel(key, value) ⇒ Notebook

Add a single label to the notebook.

Kind: instance method of Notebook

Example

notebook.addLabel(key='service', value='api')

notebook.addLabels(labels) ⇒ Notebook

Add an object of labels to the notebook.

Kind: instance method of Notebook

Example

notebook.addLabels({
 service: 'api',
 severity: 'high'
})

notebook.new(title) ⇒ Notebook

Create a new notebook with the given title.

Kind: static method of notebook

cell : object

Functions for creating notebook cells

Kind: global namespace
Example (Adding cells to a notebook)

notebook.addCells([
  cell.h1('Title'),
  cell.text('Hello world!'),
  // See below for all of the available cell types
])

• cell : object
  • .Cell
    • .setReadOnly(readOnly) ⇒ Cell
  • .heading : object
    • .h1(content, readOnly) ⇒ Cell
    • .h2(content, readOnly) ⇒ Cell
    • .h3(content, readOnly) ⇒ Cell
  • .list : object
    • .ordered(cells, startNumber, level, readOnly) ⇒ Array.<Cell>
    • .unordered(cells, level, readOnly) ⇒ Array.<Cell>
  • .listItem : object
    • .ordered(content, startNumber, level, readOnly) ⇒ Cell
    • .unordered(content, level, readOnly) ⇒ Cell
  • .checkbox(checked, content, level, readOnly) ⇒ Cell
  • .code(checked, content, syntax, readOnly) ⇒ Cell
  • .divider(readOnly) ⇒ Cell
  • .provider(intent, title, queryData, readOnly)
  • .prometheus(content, readOnly) ⇒ Cell
  • .elasticsearch(content, readOnly) ⇒ Cell
  • .loki(content, readOnly) ⇒ Cell
  • .text(content, readOnly) ⇒ Cell
  • .image(url, readOnly)

cell.Cell

An individual cell in a notebook

Kind: static class of cell

cell.setReadOnly(readOnly) ⇒ Cell

Lock the cell

Kind: instance method of Cell

cell.heading : object

Heading cells

Kind: static namespace of cell

• .heading : object
  • .h1(content, readOnly) ⇒ Cell
  • .h2(content, readOnly) ⇒ Cell
  • .h3(content, readOnly) ⇒ Cell

heading.h1(content, readOnly) ⇒ Cell

Create an H1 cell

Also accessible as cell.h1

Kind: static method of heading

heading.h2(content, readOnly) ⇒ Cell

Create an H2 cell

Also accessible as cell.h2

Kind: static method of heading

heading.h3(content, readOnly) ⇒ Cell

Create an H3 cell

Also accessible as cell.h3

Kind: static method of heading

cell.list : object

Helper functions for easily creating lists

Kind: static namespace of cell

• .list : object
  • .ordered(cells, startNumber, level, readOnly) ⇒ Array.<Cell>
  • .unordered(cells, level, readOnly) ⇒ Array.<Cell>

list.ordered(cells, startNumber, level, readOnly) ⇒ Array.<Cell>

Create an ordered list

Also accessible as cell.ol and cell.orderedList

Kind: static method of list

list.unordered(cells, level, readOnly) ⇒ Array.<Cell>

Create an unordered list

Also accessible as cell.ul and cell.unorderedList

Kind: static method of list

cell.listItem : object

Individual list items.

In most cases, you will want to use [Cell.list](Cell.list) instead.

Kind: static namespace of cell

• .listItem : object
  • .ordered(content, startNumber, level, readOnly) ⇒ Cell
  • .unordered(content, level, readOnly) ⇒ Cell

listItem.ordered(content, startNumber, level, readOnly) ⇒ Cell

Create an ordered list item

Kind: static method of listItem

listItem.unordered(content, level, readOnly) ⇒ Cell

Create an unordered list item

Kind: static method of listItem

cell.checkbox(checked, content, level, readOnly) ⇒ Cell

Create a checkbox cell

Kind: static method of cell

cell.code(checked, content, syntax, readOnly) ⇒ Cell

Create a code cell

Kind: static method of cell

cell.divider(readOnly) ⇒ Cell

Create a divider (horizontal rule) cell

Kind: static method of cell

cell.provider(intent, title, queryData, readOnly)

Create a provider cell

Kind: static method of cell

cell.prometheus(content, readOnly) ⇒ Cell

Create a Prometheus query cell

Kind: static method of cell

cell.elasticsearch(content, readOnly) ⇒ Cell

Create an Elasticsearch query cell

Kind: static method of cell

cell.loki(content, readOnly) ⇒ Cell

Create a Loki query cell

Kind: static method of cell

cell.text(content, readOnly) ⇒ Cell

Create a plain text cell

Kind: static method of cell

cell.image(url, readOnly)

Create an image cell

Kind: static method of cell

format : object

Functions for formatting text

Kind: global namespace
Example

fp.format.bold('hello')

Example (Nested formatting)

fp.format.bold(fp.format.italic('hello'))

Example (Creating a cell with different text formats)

fp.cell.text(['hello ', fp.format.bold('world '), fp.format.italics('!')])
// This is equivalent to:
fp.cell.text(fp.format.raw('hello ').bold('world ').italics('!'))

• format : object
  • .FormattedContent
    • .raw(content) ⇒ FormattedContent
    • .bold(content) ⇒ FormattedContent
    • .italics(content) ⇒ FormattedContent
    • .code(content) ⇒ FormattedContent
    • .highlight(content) ⇒ FormattedContent
    • .strikethrough(content) ⇒ FormattedContent
    • .underline(content) ⇒ FormattedContent
    • .link(content, url) ⇒ FormattedContent
    • .mention(userName, userId) ⇒ FormattedContent
    • .timestamp(timestamp) ⇒ FormattedContent
    • .label(key, url) ⇒ FormattedContent
  • .raw(content) ⇒ FormattedContent
  • .bold(content) ⇒ FormattedContent
  • .code(content) ⇒ FormattedContent
  • .highlight(content) ⇒ FormattedContent
  • .italics(content) ⇒ FormattedContent
  • .underline(content) ⇒ FormattedContent
  • .strikethrough(content) ⇒ FormattedContent
  • .link(content, url) ⇒ FormattedContent

format.FormattedContent

A class representing formatted text. Each of the formatting functions can be called as methods to append text with the given formatting.

Kind: static class of format

• .FormattedContent
  • .raw(content) ⇒ FormattedContent
  • .bold(content) ⇒ FormattedContent
  • .italics(content) ⇒ FormattedContent
  • .code(content) ⇒ FormattedContent
  • .highlight(content) ⇒ FormattedContent
  • .strikethrough(content) ⇒ FormattedContent
  • .underline(content) ⇒ FormattedContent
  • .link(content, url) ⇒ FormattedContent
  • .mention(userName, userId) ⇒ FormattedContent
  • .timestamp(timestamp) ⇒ FormattedContent
  • .label(key, url) ⇒ FormattedContent

formattedContent.raw(content) ⇒ FormattedContent

Add raw text. Note that if this is added inside a formatting helper, the outer formatting will be applied to this text.

Kind: instance method of FormattedContent

formattedContent.bold(content) ⇒ FormattedContent

Add bold text

Kind: instance method of FormattedContent

formattedContent.italics(content) ⇒ FormattedContent

Add italicized text

Kind: instance method of FormattedContent

formattedContent.code(content) ⇒ FormattedContent

Add code-formatted text

Kind: instance method of FormattedContent

formattedContent.highlight(content) ⇒ FormattedContent

Add highlighted text

Kind: instance method of FormattedContent

formattedContent.strikethrough(content) ⇒ FormattedContent

Add strikethrough text

Kind: instance method of FormattedContent

formattedContent.underline(content) ⇒ FormattedContent

Add underlined text

Kind: instance method of FormattedContent

formattedContent.link(content, url) ⇒ FormattedContent

Add a link

Kind: instance method of FormattedContent

Example

fmt.link('Example', 'https://example.com')

Example

fmt.link('https://example.com')

formattedContent.mention(userName, userId) ⇒ FormattedContent

Add a mention

Kind: instance method of FormattedContent

formattedContent.timestamp(timestamp) ⇒ FormattedContent

Add a timestamp

Kind: instance method of FormattedContent

formattedContent.label(key, url) ⇒ FormattedContent

Add a label

Kind: instance method of FormattedContent

format.raw(content) ⇒ FormattedContent

Add raw text. Note that if this is added inside a formatting helper, the outer formatting will be applied to this text.

Kind: static method of format

format.bold(content) ⇒ FormattedContent

Add bold text

Kind: static method of format

format.code(content) ⇒ FormattedContent

Add code-formatted text

Kind: static method of format

format.highlight(content) ⇒ FormattedContent

Add highlighted text

Kind: static method of format

format.italics(content) ⇒ FormattedContent

Add italicized text

Kind: static method of format

format.underline(content) ⇒ FormattedContent

Add underlined text

Kind: static method of format

format.strikethrough(content) ⇒ FormattedContent

Add strikethrough text

Kind: static method of format

format.link(content, url) ⇒ FormattedContent

Add a link

Kind: static method of format

Example

fmt.link('Example', 'https://example.com')

Example

fmt.link('https://example.com')

snippet(cells) ⇒ Array.<Cell>

Function for creating Snippets, or reusable groups of cells.

Kind: global function

Example

fp.snippet([
 c.text('Hello, world!'),
 c.code('This is a snippet'),
])