Teradata Package for Python Function Reference | 20.00 - __init__ - Teradata Package for Python - Look here for syntax, methods and examples for the functions included in the Teradata Package for Python.
Teradata® Package for Python Function Reference - 20.00
- Deployment
- VantageCloud
- VantageCore
- Edition
- Enterprise
- IntelliFlex
- VMware
- Product
- Teradata Package for Python
- Release Number
- 20.00.00.03
- Published
- December 2024
- ft:locale
- en-US
- ft:lastEdition
- 2024-12-19
- dita:id
- TeradataPython_FxRef_Enterprise_2000
- lifecycle
- latest
- Product Category
- Teradata Vantage
- teradataml.plot.Figure.__init__ = __init__(self, width=640, height=480, dpi=100, image_type='png', heading=None, layout=(1, 1))
- Create a new figure for the plot.
PARAMETERS:
width:
Optional Argument.
Specifies the width of the figure in pixels.
Default Value: 640
Notes:
* Valid range for "width" is: 400 <= width <= 4096.
* Total number of pixels in output image, i.e., the product of "width"
and "height" should not exceed 4000000.
Types: int
height:
Optional Argument.
Specifies the height of the figure in pixels.
Default Value: 480
Notes:
* Valid range for "height" is: 400 <= height <= 4096.
* Total number of pixels in output image, i.e., the product of "width"
and "height" should not exceed 4000000.
Types: int
dpi:
Optional Argument.
Specifies the number of dots per inch for the output image.
Note:
* Valid range for "dpi" is: 72 <= width <= 300.
Default Value: 100 for PNG and JPG Type image.
Types: int
image_type:
Optional Argument.
Specifies the type of output image.
Default Value: PNG
Permitted Values:
* png
* jpeg
* svg
Types: str
heading:
Optional Argument.
Specifies the heading for the plot.
Types: str
layout:
Optional Argument.
Specifies the layout for the plot. Element 1 represents rows
and element 2 represents columns.
Default Value: (1, 1)
Types: tuple
RAISES:
TeradataMlException
EXAMPLES:
# Example 1: Create a Figure object with height and width as 500
# pixels and 600 pixels respectively.
>>> from teradataml import Figure
>>> figure = Figure(height=500, width=600)
>>>
# Example 2: Create a Figure object with default height and width along
# with heading as 'Plot Heading'.
>>> from teradataml import Figure
>>> figure = Figure(heading="Plot Heading")
>>>