Reference¶
create¶
- create(key, data)¶
Creates a component and prints a Markdown snippet to place in the article text.
- Parameters:
key (
str) – A unique key for the component.data (
Factbox|Highchart) – An SSB component object.
- Raises:
CreateComponentError – If reserved key is used.
- Return type:
None
Factbox¶
- Factbox(*args, **kwargs)¶
The factbox content type.
- Parameters:
args (Any)
kwargs (Any)
- Return type:
Any
- title¶
Title, shown when collapsed and expanded.
- display_type¶
How much to show when collapsed. Alternatives:
“default”: Only the title (standard)
“sneakPeek”: Title and some of the content
“aiIcon”: Title and some of the content + AI-icon
Highchart¶
- Highchart(*args, **kwargs)¶
The highchart content type.
- Parameters:
args (Any)
kwargs (Any)
- Return type:
Any
- title¶
Title, placed above the highchart.
- graph_type¶
Graph type. Alternatives:
“line”
“pie”
“column”
“bar”
“area”
“barNegative”
- dataframe¶
A pandas, polars or pyarrow dataframe.
- tbml¶
URL or tbml-id.
- xlabel¶
The x-axis title.
- ylabel¶
The y-axis title.