print_code

ScaleBar.print_code(fixed=True, return_str=False)

Print the command that will reproduce the scalebar in its current state.

Parameters:

• fixed (bool, optional) –

  • If True, the returned command will produce a scalebar that is fixed with respect to its scale, and position.

  • If False, the command will produce a scalebar that autoscales itself with respect to the currently set autoscale parameters.

  The default is True.

• return_str (bool, optional) – If True, the string is returned. If False, the string is only printed and None is returned. The default is False.

Returns:

code – A string of the command that will reproduce the scalebar.

Return type:

str