The ConstrainedSketchImageOptions object is used to store values and attributes associated with the background image for a particular sketch. The ConstrainedSketchImageOptions object has no constructor.
import sketch mdb.models[name].sketches[name].imageOptions
This method modifies the ConstrainedSketchOptions object.
Required arguments
Optional arguments
A String specifying the name of the image. A list of valid image names is in the images repository in the session object.
A Boolean specifying whether an image should be displayed in the sketcher background. The default value is OFF.
A pair of Floats specifying the X- and Y-offsets in millimeters from the lower-left corner of the viewport. The default value is (0, 0).
A Float specifying the scale applied to the image width. The default value is 1.0.
When xScale is negative, the image is mirrored about its y-axis but its position is not affected.
A Float specifying the scale applied to the image height. The default value is 1.0.
When yScale is negative, the image is mirrored about its x-axis but its position is not affected.
A Float specifying the translucency factor to use when displaying the image. Possible values are 0.0
translucency
Return value
Exceptions
RangeError.
The ConstrainedSketchImageOptions object has members with the same names and descriptions as the arguments to the setValues method.