BackgroundColor Property

Summary

Gets or sets the background color to be used when rasterizing vector image files.

Syntax

Objective-C

C++/CLI

Java

Python

public RasterColor BackgroundColor { get; set; }

@property (nonatomic, copy) LTRasterColor *backgroundColor;

public RasterColor getBackgroundColor() 
public void setBackgroundColor(RasterColor backgroundColor)

public: 
property RasterColor BackgroundColor { 
   RasterColor get(); 
   void set (    RasterColor ); 
}

BackgroundColor # get and set (CodecsVectorLoadOptions)

Property Value

The default value is #FF000000

The background color to be used when rasterizing vector image files.

Remarks

If the vector image file being rasterized does not specify a background color, the value of this property will be used to fill the resulting raster image during rasterization.

You can override the value specified in the vector image file by setting ForceBackgroundColor to true.

Example

Java

using Leadtools; 
using Leadtools.Codecs; 
 
using Leadtools.ImageProcessing.Core; 
using Leadtools.Pdf; 
 
public void CodecsVectorLoadOptionsExample() 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
 
   string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "random.dxf"); 
 
   //Check if it is a vector file 
   CodecsImageInfo info = codecs.GetInformation(srcFileName, false); 
   Debug.WriteLine($"Is {srcFileName} a vector file? : {info.Vector.IsVectorFile}"); 
   Debug.WriteLine($"Units: {info.Vector.Unit}"); 
 
   //Parallelogram data 
   CodecsVectorImageInfo codecsVectorImageInfo = info.Vector; 
   Debug.WriteLine($"Parallelogram Max X: {codecsVectorImageInfo.ParallelogramMaxX}"); 
   Debug.WriteLine($"Parallelogram Max Y: {codecsVectorImageInfo.ParallelogramMaxY}"); 
   Debug.WriteLine($"Parallelogram Max Z: {codecsVectorImageInfo.ParallelogramMaxZ}"); 
   Debug.WriteLine($"Parallelogram Min X: {codecsVectorImageInfo.ParallelogramMinX}"); 
   Debug.WriteLine($"Parallelogram Min Y: {codecsVectorImageInfo.ParallelogramMinY}"); 
   Debug.WriteLine($"Parallelogram Min Z: {codecsVectorImageInfo.ParallelogramMinZ}"); 
 
   // Set the vector load options 
   // CodecsVectorOptions & CodecsVectorLoadOptions reference 
   codecs.Options.Vector.Load.BackgroundColor = new RasterColor(255, 255, 255); 
   codecs.Options.Vector.Load.BitsPerPixel = 24; 
   codecs.Options.Vector.Load.ForceBackgroundColor = true; 
   codecs.Options.Vector.Load.ViewWidth = 800; 
   codecs.Options.Vector.Load.ViewHeight = 800; 
   codecs.Options.Vector.Load.ViewMode = CodecsVectorViewMode.UseBest; 
 
   // Load the image 
   RasterImage image = codecs.Load(srcFileName); 
   // do something with the image here 
 
   // Clean up 
   image.Dispose(); 
   codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.File; 
import java.io.IOException; 
import java.net.URI; 
import java.net.URISyntaxException; 
import java.nio.file.Paths; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.*; 
import leadtools.codecs.*; 
import leadtools.imageprocessing.core.MinMaxBitsCommand; 
 
 
public void codecsVectorLoadOptionsExample() { 
 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   RasterCodecs codecs = new RasterCodecs(); 
   String srcFileName = combine(LEAD_VARS_IMAGES_DIR, "random.dxf"); 
   String outputFileName = combine(LEAD_VARS_IMAGES_DIR, "Result.jpg"); 
 
   // Check if it is a vector file 
   CodecsImageInfo info = codecs.getInformation(srcFileName, false); 
   System.out.println("Is {srcFileName} a vector file? : {info.Vector.IsVectorFile}"); 
   System.out.println("Units: {info.Vector.Unit}"); 
 
   // Parallelogram data 
   CodecsVectorImageInfo codecsVectorImageInfo = info.getVector(); 
   System.out.println("Parallelogram Max X: " + codecsVectorImageInfo.getParallelogramMaxX()); 
   System.out.println("Parallelogram Max Y: " + codecsVectorImageInfo.getParallelogramMaxY()); 
   System.out.println("Parallelogram Max Z: " + codecsVectorImageInfo.getParallelogramMaxZ()); 
   System.out.println("Parallelogram Min X: " + codecsVectorImageInfo.getParallelogramMinX()); 
   System.out.println("Parallelogram Min Y: " + codecsVectorImageInfo.getParallelogramMinY()); 
   System.out.println("Parallelogram Min Z: " + codecsVectorImageInfo.getParallelogramMinZ()); 
 
   // Set the vector load options 
   // CodecsVectorOptions & CodecsVectorLoadOptions reference 
   codecs.getOptions().getVector().getLoad().setBackgroundColor(new RasterColor(255, 255, 255)); 
   codecs.getOptions().getVector().getLoad().setBitsPerPixel(24); 
   codecs.getOptions().getVector().getLoad().setForceBackgroundColor(true); 
   codecs.getOptions().getVector().getLoad().setViewWidth(800); 
   codecs.getOptions().getVector().getLoad().setViewHeight(800); 
   codecs.getOptions().getVector().getLoad().setViewMode(CodecsVectorViewMode.UseBest); 
 
   // Load the image 
   RasterImage image = codecs.load(srcFileName); 
 
   codecs.save(image, outputFileName, RasterImageFormat.JPEG, 0); 
 
   // do something with the image here 
 
   assertTrue("File saved to " + outputFileName, (new File(outputFileName)).exists()); 
   System.out.printf("File successfully saved to %s%n", outputFileName); 
 
   // Clean up 
   image.dispose(); 
   codecs.dispose(); 
 
}

Requirements

Target Platforms

Reference

CodecsVectorLoadOptions Class

CodecsVectorLoadOptions Members

Download our FREE evaluation

Help Version 23.0.2024.2.29