visual3d:documentation:pipeline:report_commands:make_image_item
Table of Contents
Make Image Item
The Make_Image_Item command can be used to add an image to a report with an attached image description.
Pipeline Command
The Make Image Item command can be found in the Pipeline Workshop within the Reports/Interactive Graphs tab as so:
Make_Image_Item /FONT_NAME=Arial ! /FONT_SIZE=NORMAL ! /FONT_BOLD=FALSE ! /FONT_ITALIC=FALSE ! /FONT_UNDERLINE=FALSE ! /FONT_COLOR=BLACK ! /ALIGN_TOP=TRUE ! /ALIGNMENT=LEFT ! /IMAGE_FILE= /PAGE_NUMBER=1 /COLUMN_NUMBER=1 /ROW_NUMBER=1 ! /COLUMN_SPAN=1 ! /ROW_SPAN=1 ! /TEXT= ! /TEXT_ABOVE=TRUE ;
Command Parameters
The parameters that can be modified for this command are as follows:
| /FONT_NAME= | The name of the image text font to be used |
| /FONT_SIZE= | The selected size of image text |
| /FONT_BOLD= | True or False: bold text |
| /FONT_ITALIC= | True or False: italicize text |
| /FONT_UNDERLINE= | True or False: underline text |
| /FONT_COLOR= | Colour of text font |
| /ALIGN_TOP= | True or False: Align text to top of image |
| /ALIGNMENT= | Horizontal text alignment: left (0), middle (1), right (2) |
| /IMAGE_FILE= | Image file address/location |
| /PAGE_NUMBER= | The report page number on which the image will be added |
| /COLUMN_NUMBER= | The column on which the image will be added |
| /ROW_NUMBER= | The row on which the image will be added |
| /COLUMN_SPAN= | How many columns the image will span |
| /ROW_SPAN= | How many rows the image will span |
| /TEXT= | Image description text |
| /TEXT_ABOVE= | True or False: image text will be above (true) or below (false) the image |
Given the nature of this command and the complexity of some parameters, it is likely more practical to edit this command using the dialog box than as text.
Dialog
The command can be modified as text using the parameters above or using the dialog box below:
Example: Add Image to Report
The following code adds an image to the 2nd row of the 2nd column of a report with the text “Test Description” centered below the image:
Make_Image_Item /FONT_NAME=Arial ! /FONT_SIZE=NORMAL ! /FONT_BOLD=FALSE ! /FONT_ITALIC=FALSE ! /FONT_UNDERLINE=FALSE /FONT_COLOR=Black /ALIGN_TOP=FALSE /ALIGNMENT=1 /IMAGE_FILE=C:\downloads\test_image.png /PAGE_NUMBER=1 /COLUMN_NUMBER=2 /ROW_NUMBER=2 ! /COLUMN_SPAN=1 ! /ROW_SPAN=1 /TEXT=Test Description /TEXT_ABOVE=FALSE ;
visual3d/documentation/pipeline/report_commands/make_image_item.txt · Last modified: by wikisysop