TracingOptions
TracingOptions
Section titled “TracingOptions”image.tracing.tracingOptions
Description
Section titled “Description”A set of options used in converting raster art to vector art by tracing.
Properties
Section titled “Properties”TracingOptions.cornerAngle
Section titled “TracingOptions.cornerAngle”image.tracing.tracingOptions.cornerAngle
Description
Section titled “Description”The sharpness, in degrees of a turn in the original image that is considered a corner in the tracing result path.
Range: 0 to 180
Number (double)
TracingOptions.fills
Section titled “TracingOptions.fills”image.tracing.tracingOptions.fills
Description
Section titled “Description”If true, trace with fills. At least one of fills or strokes must be true.
Boolean
TracingOptions.ignoreWhite
Section titled “TracingOptions.ignoreWhite”image.tracing.tracingOptions.ignoreWhite
Description
Section titled “Description”If true, ignores white fill color.
Boolean
TracingOptions.livePaintOutput
Section titled “TracingOptions.livePaintOutput”image.tracing.tracingOptions.livePaintOutput
Description
Section titled “Description”If true, result is LivePaint art. If false, it is classic art.
Boolean
TracingOptions.maxColors
Section titled “TracingOptions.maxColors”image.tracing.tracingOptions.maxColors
Description
Section titled “Description”The maximum number of colors allowed for automatic palette generation.
Used only if tracingMode is TracingModeType.TRACINGMODECOLOR or TracingModeType.TRACINGMODEGRAY.
Range: 2 to 256
Number (long)
TracingOptions.maxStrokeWeight
Section titled “TracingOptions.maxStrokeWeight”image.tracing.tracingOptions.maxStrokeWeight
Description
Section titled “Description”The maximum stroke weight, when strokes is true.
Range: 0.01 to 100.0
Number (double)
TracingOptions.minArea
Section titled “TracingOptions.minArea”image.tracing.tracingOptions.minArea
Description
Section titled “Description”The smallest feature, in square pixels, that is traced.
For example, if it is 4, a feature of 2 pixels wide by 2 pixels high is traced.
Number (long)
TracingOptions.minStrokeLength
Section titled “TracingOptions.minStrokeLength”image.tracing.tracingOptions.minStrokeLength
Description
Section titled “Description”The minimum length in pixels of features in the original image that can be stroked, when strokes is true.
Smaller features are omitted.
Range: 0.0 to 200.0.
Default: 20.0
Number (double)
TracingOptions.outputToSwatches
Section titled “TracingOptions.outputToSwatches”image.tracing.tracingOptions.outputToSwatches
Description
Section titled “Description”If true, named colors (swatches) are generated for each new color created by the tracing result.
Used only if tracingMode is TracingModeType.TRACINGMODECOLOR or TracingModeType.TRACINGMODEGRAY.
Boolean
TracingOptions.palette
Section titled “TracingOptions.palette”image.tracing.tracingOptions.palette
Description
Section titled “Description”The name of a color palette to use for tracing. If the empty string, use the automatic palette.
Used only if tracingMode is TracingModeType.TRACINGMODECOLOR or TracingModeType.TRACINGMODEGRAY.
String
TracingOptions.parent
Section titled “TracingOptions.parent”image.tracing.tracingOptions.parent
Description
Section titled “Description”The object’s container.
Object; read-only.
TracingOptions.pathFitting
Section titled “TracingOptions.pathFitting”image.tracing.tracingOptions.pathFitting
Description
Section titled “Description”The distance between the traced shape and the original pixel shape. Lower values create a tighter path fitting.
Higher values create a looser path fitting.
Range: 0.0 to 10.0
Number (double)
TracingOptions.preprocessBlur
Section titled “TracingOptions.preprocessBlur”image.tracing.tracingOptions.preprocessBlur
Description
Section titled “Description”The amount of blur used during preprocessing, in pixels. Blurring helps reduce small artifacts and smooth jagged edges in the tracing result.
Range: 0.0 to 2.0
Number (double)
TracingOptions.preset
Section titled “TracingOptions.preset”image.tracing.tracingOptions.preset
Description
Section titled “Description”The name of a preset file containing these options.
String; read-only.
TracingOptions.resample
Section titled “TracingOptions.resample”image.tracing.tracingOptions.resample
Description
Section titled “Description”If true, resample when tracing. (This setting is not captured in a preset file.)
Always true when the raster source art is placed or linked.
Boolean
TracingOptions.resampleResolution
Section titled “TracingOptions.resampleResolution”image.tracing.tracingOptions.resampleResolution
Description
Section titled “Description”The resolution to use when resampling in pixels per inch (ppi).
Lower resolution increases the speed of the tracing operation. (This setting is not captured in a preset file.)
Number (double)
TracingOptions.strokes
Section titled “TracingOptions.strokes”image.tracing.tracingOptions.strokes
Description
Section titled “Description”If true, trace with strokes. At least one of fills or strokes must be true.
Used only if tracingMode is TracingModeType.TRACINGMODEBLACKANDWHITE.
Boolean
TracingOptions.threshold
Section titled “TracingOptions.threshold”image.tracing.tracingOptions.threshold
Description
Section titled “Description”The threshold value of black-and-white tracing. All pixels with a grayscale value greater than this are converted to black.
Used only if tracingMode is TracingModeType.TRACINGMODEBLACKANDWHITE.
Range: 0 to 255
Number (long)
TracingOptions.tracingMode
Section titled “TracingOptions.tracingMode”image.tracing.tracingOptions.tracingMode
Description
Section titled “Description”The color mode for tracing.
TracingOptions.typename
Section titled “TracingOptions.typename”image.tracing.tracingOptions.typename
Description
Section titled “Description”Read-only. The class name of the object.
String
TracingOptions.viewRaster
Section titled “TracingOptions.viewRaster”image.tracing.tracingOptions.viewRaster
Description
Section titled “Description”The view for previews of the raster image. (This setting is not captured in a preset file.)
TracingOptions.viewVector
Section titled “TracingOptions.viewVector”image.tracing.tracingOptions.viewVector
Description
Section titled “Description”The view for previews of the vector result. (This setting is not captured in a preset file.)
Methods
Section titled “Methods”TracingOptions.loadFromPreset()
Section titled “TracingOptions.loadFromPreset()”image.tracing.tracingOptions.loadFromPreset(parameter)
Description
Section titled “Description”Loads a set of options from the specified preset, as found in the Application.tracingPresetList array.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
presetName | String | Preset name to load |
Returns
Section titled “Returns”Boolean
TracingOptions.storeToPreset()
Section titled “TracingOptions.storeToPreset()”image.tracing.tracingOptions.storeToPreset(parameter)
Description
Section titled “Description”Saves this set of options in the specified preset.
Use a name found in the Application.tracingPresetList array, or a new name to create a new preset.
For an existing preset, overwrites an unlocked preset and returns true.
Returns false if the preset is locked.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
presetName | String | Preset name to save as |
Returns
Section titled “Returns”Boolean