com.yworks.yfiles.view

Class ContextConfigurator

java.lang.Object

com.yworks.yfiles.view.ContextConfigurator

public class ContextConfigurator
extends Object

This class sets up an IRenderContext object for exporting the contents of a CanvasControl (see #setup(CanvasControl)).

• It is possible to export only a part of the contents, see WorldBounds.
• The size of the target graphics is controlled by the Scale. For a given target width or height, the apropriate scale can be calculated using calculateScaleForWidth(double) and calculateScaleForHeight(double).

Constructor Summary

Constructors

Constructor and Description
ContextConfigurator(RectD worldBounds) Creates a new ContextConfigurator instance for the given world bounds and scale.
ContextConfigurator(RectD worldBounds, double scale) Creates a new ContextConfigurator instance for the given world bounds and scale.

Method Summary

Modifier and Type	Method and Description
double	calculateScaleForHeight(double height) Calculates the value to set the Scale to in order to achieve the given target height (without Margin).
double	calculateScaleForWidth(double width) Calculates the value to set the Scale to in order to achieve the given target width (without Margin).
IRenderContext	createRenderContext(CanvasControl canvas) Returns an initialized IRenderContext and taht contains a transforms and clip such that a part of the given CanvasControl instance can be exported.
InsetsD	getMargin() Gets the margins for the exported image.
double	getScale() Gets the scale for the export.
int	getViewHeight() Gets the resulting height of the target image with respect to WorldBounds, Scale and Margin.
int	getViewWidth() Gets the resulting width of the target image with respect to WorldBounds, Scale and Margin.
RectD	getWorldBounds() Gets the bounds of the content to export in world coordinates.
double	getZoom() Gets the Zoom property to use during the creation of the visualization.
void	setMargin(InsetsD value) Sets the margins for the exported image.
void	setScale(double value) Sets the scale for the export.
void	setWorldBounds(RectD value) Sets the bounds of the content to export in world coordinates.
void	setZoom(double value) Sets the Zoom property to use during the creation of the visualization.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContextConfigurator

public ContextConfigurator(RectD worldBounds)

Creates a new ContextConfigurator instance for the given world bounds and scale.

Parameters:

worldBounds - the bounds of the content to export, see WorldBounds

ContextConfigurator

public ContextConfigurator(RectD worldBounds,
                           double scale)

Creates a new ContextConfigurator instance for the given world bounds and scale.

Parameters:

worldBounds - the bounds of the content to export, see WorldBounds

scale - the scale, see Scale

Method Detail

calculateScaleForHeight

public final double calculateScaleForHeight(double height)

Calculates the value to set the Scale to in order to achieve the given target height (without Margin).

Parameters:

height - the height of the target image

Returns:

the scale value to use

calculateScaleForWidth

public final double calculateScaleForWidth(double width)

Calculates the value to set the Scale to in order to achieve the given target width (without Margin).

Parameters:

width - the width of the target image

Returns:

the scale value to use

createRenderContext

public IRenderContext createRenderContext(CanvasControl canvas)

Returns an initialized IRenderContext and taht contains a transforms and clip such that a part of the given CanvasControl instance can be exported.

Parameters:

canvas - the CanvasControl instance to export from

Returns:

an IRenderContext to use for creating the content to export

getMargin

public final InsetsD getMargin()

Gets the margins for the exported image.

The margins are added to the content. This means that an image with non-zero margins is larger than the WorldBounds even if the Scale is 1.0. The margins are not scaled. They are interpreted to be in units (pixels for bitmaps) for the resulting image. The default is an empty margin instance.

Returns:

The Margin.

See Also:

setMargin(InsetsD)

getScale

public final double getScale()

Gets the scale for the export.

A scale of 1 preserves the original size, a scale of 0.5 results in a target image with half the original size and so on.

This value has to be strictly greater than 0. Its default value is 1.0

Returns:

The Scale.

See Also:

setScale(double)

getViewHeight

public final int getViewHeight()

Gets the resulting height of the target image with respect to WorldBounds, Scale and Margin.

Returns:

The ViewHeight.

getViewWidth

public final int getViewWidth()

Gets the resulting width of the target image with respect to WorldBounds, Scale and Margin.

Returns:

The ViewWidth.

getWorldBounds

public RectD getWorldBounds()

Gets the bounds of the content to export in world coordinates.

Returns:

The WorldBounds.

See Also:

setWorldBounds(RectD)

getZoom

public final double getZoom()

Gets the Zoom property to use during the creation of the visualization.

In contrast to the Scale property, which works on the output graphics, this property determines what zoom value is to be assumed on the canvas when creating the visual. This can affect the rendering of zoom dependent visuals.

This value has to be strictly greater than 0. Its default value is 1.0

Returns:

The Zoom.

See Also:

setZoom(double)

setMargin

public final void setMargin(InsetsD value)

Sets the margins for the exported image.

The margins are added to the content. This means that an image with non-zero margins is larger than the WorldBounds even if the Scale is 1.0. The margins are not scaled. They are interpreted to be in units (pixels for bitmaps) for the resulting image. The default is an empty margin instance.

Parameters:

value - The Margin to set.

See Also:

getMargin()

setScale

public final void setScale(double value)

Sets the scale for the export.

A scale of 1 preserves the original size, a scale of 0.5 results in a target image with half the original size and so on.

This value has to be strictly greater than 0. Its default value is 1.0

Parameters:

value - The Scale to set.

See Also:

getScale()

setWorldBounds

public void setWorldBounds(RectD value)

Sets the bounds of the content to export in world coordinates.

Parameters:

value - The WorldBounds to set.

See Also:

getWorldBounds()

setZoom

public final void setZoom(double value)

Sets the Zoom property to use during the creation of the visualization.

In contrast to the Scale property, which works on the output graphics, this property determines what zoom value is to be assumed on the canvas when creating the visual. This can affect the rendering of zoom dependent visuals.

This value has to be strictly greater than 0. Its default value is 1.0

Parameters:

value - The Zoom to set.

See Also:

getZoom()