Documentation
Documentation
API Reference
API Reference
cauldron.display
bokehcode_blockelapsedheadheaderhtmlimageinspectjinjajsonlatexlistinglist_gridmarkdownplotlypyplotstatussvgtabletailtextwhitespacecauldron.display
bokehcode_blockelapsedheadheaderhtmlimageinspectjinjajsonlatexlistinglist_gridmarkdownplotlypyplotstatussvgtabletailtextwhitespacecauldron.project
stopcauldron.project
stopdef
headerAdds a text header to the display with the specified level.
header_text
str
The text to display in the header.
level
int
The level of the header, which corresponds to the html header levels, such as <h1>, <h2>, ...
Default Value:
1
expand_full
bool
Whether or not the header will expand to fill the width of the entire notebook page, or be constrained by automatic maximum page width. The default value of False lines the header up with text displays.
Default Value:
False
Basic Usage
01
02
03
04
05
06
07
08
09
10
import cauldron as cd
# Add a level-1 header (the largest)
cd.display.header('Title')
# Add a level-2 header (smaller than a level-1)
cd.display.header('Subtitle', 2)
# Add a level-3 header (smaller than a level-2)
cd.display.header('Section Title', 3)