Skip to content

RunImageComp.md

Latest commit

 

History

History
50 lines (42 loc) · 1.3 KB

RunImageComp.md

File metadata and controls

50 lines (42 loc) · 1.3 KB
Raw

RunImageComp

PROCEDURE RunImageComp(
				FilePath    : STRING;
				savedView   : STRING;
				SettingsDir : STRING;
				imageWidth  : INTEGER;
				imageHeight : INTEGER);
def vs.RunImageComp(FilePath, savedView, SettingsDir, imageWidth, imageHeight):
    return BOOLEAN

Parameters

Name Type Description
FilePath STRING This is the file path to the test file
savedView STRING The name of the saved view test
SettingsDir STRING The path to the directory where the settings.csv file is
imageWidth INTEGER The width in pixels of the image this function will save of the saved view. This should be close to the width of the reference image.
imageHeight INTEGER The height in pixels of the image this function will save of the saved view. This should be close to the height of the reference image.

Examples

RunImageComp('file.txt', 'Example', 'Example', 1, 2);
import vs

FilePath = 'C:/Temp'
savedView = 'Example'
SettingsDir = 'C:/Temp'
imageWidth = 1
imageHeight = 2

ok = vs.RunImageComp(FilePath, savedView, SettingsDir, imageWidth, imageHeight)
if ok:
    vs.Message('RunImageComp succeeded')
else:
    vs.Message('RunImageComp failed')

Version

Availability: from Vectorworks 2020

Category