Documentation
Documentation
API Reference
API Reference
cauldron.display
bokehcode_blockelapsedheadheaderhtmlimageinspectjinjajsonlatexlistinglist_gridmarkdownplotlypyplotstatussvgtabletailtextwhitespacecauldron.display
bokehcode_blockelapsedheadheaderhtmlimageinspectjinjajsonlatexlistinglist_gridmarkdownplotlypyplotstatussvgtabletailtextwhitespacecauldron.project
stopcauldron.project
stopdef
imageAdds an image to the display. The image must be located within the assets directory of the Cauldron notebook's folder.
filename
str
Name of the file within the assets directory,
width
int
Optional width in pixels for the image.
Default Value:
None
height
int
Optional height in pixels for the image.
Default Value:
None
justify
str
One of 'left', 'center' or 'right', which specifies how the image is horizontally justified within the notebook display.
Default Value:
left
Basic Usage
warning
Images must be located in the project's assets directory.
01
02
03
import cauldron as cd
cd.display.image('plot.png')