SVGImage

The SVGImage is a a JavaFX Group which is the result of the SVGLoader load static method.

Overview

The SVGImage can be used directly in any JavaFX node graph. This class has also several additional methods which allows you to:

• Get the JavaFX implementations of named SVG nodes
• Convert the resulting SVGImage to a JavaFX Image
• Scale a SVGImage
• Produce a snapshot in a File in an ImageIO supported output format

Limitations

You will be able to use the direct methods to generate a snapshot only if you have swing available. If not, you will still be able to save the image using an alternate third party library to save the converted JavaFX Image on the disk.

Threading usage

As for the SVGLoader class, you can use this class in the JavaFX Platform Thread or in any other Thread. The library will make sure that the conversion will be performed in the JavaFX Platform Thread, and will return the result in the calling Thread.

Scaling a SVGImage

To scale a SVGImage, you can use one of the following methods:

• The SVGImage.scale(double) method creates a new SVGImage scaled compared to the initial image
• The SVGImage.scale(double, boolean) method allows to modify the SVGImage rather than creating another one
• The SVGImage.scaleTo(double) method creates a new SVGImage scaled with a new width compared to the initial image
• The SVGImage.scaleTo(double, boolean) method allows to modify the SVGImage rather than creating another one

Note that these two methods will no just call setScaleX and setScaleY on the initial image, but will create a new SVGImage with the same SVG input and a scale parameter.

Examples

   SVGImage img = SVGLoader.load(<my SVG file>);
      
   // a new SVGImage will be created with a scale of 2
   SVGImage newImg = img.scale(2); 
   // the initial SVGImage will be scaled with a factor of 2
   img.scale(2, false);  
      
   // a new SVGImage will be created with a width of 200
   SVGImage newImg = img.scaleTo(200); 
   // the initial SVGImage will have a new width of 200
   img.scaleTo(200, false);        

Producing a snapshot

The SVGImage.snapshot(String, File) method allows to save a snapshot of the initial image.

For example:

   SVGImage img = SVGLoader.load(<my SVG file>);
   img.snapshot("png", <my PNG file>));

Producing a JavaFX image

The SVGImage.toImage() method allows to create a JavaFX image from the initial image. It is possible to specify the width of the result by using one of the following methods:

• The SVGImage.toImage(double) method will create a scaled JavaFX image from the initial image, using the width parameter as the width of the resulting image
• The SVGImage.toImage(short, double) method does the same thing, and allows to specify the quality of the result
• The SVGImage.toImageScaled(double, double) method will create a scaled JavaFX image from the initial image
• The SVGImage.toImageScaled(short, double, double) method will create a scaled JavaFX image from the initial image, and allows to specify the quality of the result

Examples

   SVGImage img = SVGLoader.load(<my SVG file>);
      
   // the resulting image will have a width of 100 pixels
   Image fxImg = img.toImage(100); 
   // the resulting image will be scaled by a 0.5 factor    
   Image fxImg2 = img.toImageScaled(0.5d); 
   // the resulting image will have a width of 50 pixels, but the image will be scaled at the SVG level before creating the image
   Image fxImg2 = img.toImage(ScaleQuality.RENDER_QUALITY, 50); 

SVGImage viewport

The SVGImage.getViewport() return the viewport of the SVGImage. The most useful methods of the Viewport are:

• The Viewbox.getWidth() return the width of the SVGImage (can be -1 if the width is not specified in the SVG file
• The Viewbox.getHeight() return the height of the SVGImage (can be -1 if the height is not specified in the SVG file
• The Viewbox.getViewboxWidth() return the width of the viewport (can be -1 if the viewport is not specified in the SVG file
• The Viewbox.getViewboxHeight() return the height of the viewport (can be -1 if the viewport is not specified in the SVG file
• The Viewport.getBestWidth() return the width if it exists, else it will be the viewBox width
• The Viewport.getBestHeight() return the height if it exists, else it will be the viewBox height

Integrating the SVGImage in a layout container

The SVGImage is a Group class. As a Group has no size by itself, it can not be integrated efficiently in a Layout containers (such as a BorderPane)^[1]

a Group is not directly resizable

.

To overcomme this problem and allow to integrate a SVGImage in a Layout container, you can use the SVGImage.createRegion() which will create a SVGImageRegion wrapping the SVGImage.

As the SVGImageRegion is a Region, it can be resized and be fully integrated in a Layout container.