edit_header

FarField.edit_header(company_name='PyAEDT', show_design_name=True, font='Arial', title_size=12, subtitle_size=12, italic=False, bold=False, color=(0, 0, 0))

Edit the plot header.

Parameters:

company_namestr, optional

Company name. The default is PyAEDT.

show_design_namebool, optional

Whether to show the design name in the plot. The default is True.

fontstr, optional

Font name. The default is "Arial".

title_sizeint, optional

Title font size. The default is 12.

subtitle_sizeint, optional

Subtitle font size. The default is 12.

italicbool, optional

Whether to use italic type. The default is False.

boldbool, optional

Whether to use bold type. The default is False.

colortuple, optional

Title (R, G, B) color. The default is (0, 0, 0). Each color value must be an integer in a range from 0 to 255.

Returns:

bool

True when successful, False when failed.