FigureRendererOptions

Inheritance: java.lang.Object

public class FigureRendererOptions

Common options for rendering a LaTeX source code fragment.

Constructors

ConstructorDescription
FigureRendererOptions()Creates a new instance.

Methods

MethodDescription
getPreamble()Gets LaTeX document preamble.
setPreamble(String value)Sets LaTeX document preamble.
getScale()Gets the scale. 1000 means 100%, 1200 means 120%, etc.
setScale(int value)Sets the scale. 1000 means 100%, 1200 means 120%, etc.
getBackgroundColor()Gets the background color.
setBackgroundColor(Color value)Sets the background color.
getLogStream()Gets the stream to write log output to.
setLogStream(OutputStream value)Sets the stream to write log output to.
showTerminal()Gets the flag that controls terminal output.
showTerminal(boolean value)Sets the flag that controls terminal output.
getErrorReport()Gets the error report.
getRequiredInputDirectory()Gets the directory for the required input, e.g., packages that are beyond Aspose.TeX’s LaTeX support.
setRequiredInputDirectory(IInputWorkingDirectory value)Gets the directory for the required input, e.g., packages that are beyond Aspose.TeX’s LaTeX support.
getMargin()Gets the margin width.
setMargin(float value)Sets the margin width.

FigureRendererOptions()

public FigureRendererOptions()

Creates a new instance.

getPreamble()

public String getPreamble()

Gets LaTeX document preamble.

Returns: java.lang.String - LaTeX document preamble.

setPreamble(String value)

public void setPreamble(String value)

Sets LaTeX document preamble.

Parameters:

ParameterTypeDescription
valuejava.lang.StringThe LaTeX document preamble.

getScale()

public int getScale()

Gets the scale. 1000 means 100%, 1200 means 120%, etc.

Returns: int - The scale. 1000 means 100%, 1200 means 120%, etc.

setScale(int value)

public void setScale(int value)

Sets the scale. 1000 means 100%, 1200 means 120%, etc.

Parameters:

ParameterTypeDescription
valueintThe scale. 1000 means 100%, 1200 means 120%, etc.

getBackgroundColor()

public Color getBackgroundColor()

Gets the background color.

Returns: java.awt.Color - The background color.

setBackgroundColor(Color value)

public void setBackgroundColor(Color value)

Sets the background color.

Parameters:

ParameterTypeDescription
valuejava.awt.Colorbackground color.

getLogStream()

public OutputStream getLogStream()

Gets the stream to write log output to.

Returns: java.io.OutputStream - The stream to write log output to.

setLogStream(OutputStream value)

public void setLogStream(OutputStream value)

Sets the stream to write log output to.

Parameters:

ParameterTypeDescription
valuejava.io.OutputStreamThe stream to write log output to.

showTerminal()

public boolean showTerminal()

Gets the flag that controls terminal output. If true then terminal output is written to console.

Returns: boolean - The flag that controls terminal output.

showTerminal(boolean value)

public void showTerminal(boolean value)

Sets the flag that controls terminal output. If true then terminal output is written to console.

Parameters:

ParameterTypeDescription
valuebooleanThe flag that controls terminal output.

getErrorReport()

public String getErrorReport()

Gets the error report.

Returns: java.lang.String - The error report.

getRequiredInputDirectory()

public IInputWorkingDirectory getRequiredInputDirectory()

Gets the directory for the required input, e.g., packages that are beyond Aspose.TeX’s LaTeX support.

Returns: IInputWorkingDirectory - The directory for the required input.

setRequiredInputDirectory(IInputWorkingDirectory value)

public void setRequiredInputDirectory(IInputWorkingDirectory value)

Gets the directory for the required input, e.g., packages that are beyond Aspose.TeX’s LaTeX support.

Parameters:

ParameterTypeDescription
valueIInputWorkingDirectoryThe directory for the required input.

getMargin()

public float getMargin()

Gets the margin width.

Returns: float - The margin width.

setMargin(float value)

public void setMargin(float value)

Sets the margin width.

Parameters:

ParameterTypeDescription
valuefloatThe margin width.