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

Setting the snapshot parameters

The SVGImage.toImage(SVGSnapshotParameters) method allow to specify the parameters to use to produce the snapshot.

The SVGSnapshotParameters encapsulate the SnapshotParameters to use to produce the image.

Default snapshot parameters

By default the SnapshotParameters used to generate the images will use a default SnapshotParameters It is possible to set the parameters to use by using the following methods:

• The SVGImage.toImage(SVGSnapshotParameters)
• The SVGImage.toImage(SnapshotParameters)

It is possible to specify the default SVGSnapshotParameters to use when creating snapshots by using the SVGImage.setDefaultSnapshotParameters(SVGSnapshotParameters) method.

Defining the viewport of the resulting image

The SVGSnapshotParameters.setViewportType(short type) allows to specify which viewport to choose for the resulting image:

• The SVGSnapshotParameters.USE_CONTENT_SIZE will use the viewport of the content of the SVG image (and not use the explicit viewport if it is defined). This is the default value
• The SVGSnapshotParameters.USE_BEST_VIEWPORT_SIZE will use the explicit viewport which is set for the SVG image (if it is defined)

For example, for the following SVG content:

   <svg xmlns="http://www.w3.org/2000/svg" height="24px" viewBox="0 -960 960 960" width="24px" fill="#1f1f1f">
      <path d="M160-440v-80h640v80H160Z"/>
    </svg>

If you use the following code:

   URL url = <my SVG content>
   SVGImage result = SVGLoader.load(url);
   Image img = result.toImage();      

The width and height of the image will be (16 px, 2 px), which is the size of the path.

If you use the following code:

   URL url = <my SVG content>
   SVGImage result = SVGLoader.load(url);
   SVGSnapshotParameters params = new SVGSnapshotParameters();
   params.setViewportType(SVGSnapshotParameters.USE_BEST_VIEWPORT_SIZE);
   Image img = result.toImage(params);   

The width and height of the image will be (24 px, 24 px), which is the size of the viewport.

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);