LowCodeImageSaveOptions
LowCodeImageSaveOptions class
Options for saving image in low code way.
class LowCodeImageSaveOptions extends LowCodeSaveOptions;
Constructors
| Constructor | Description |
|---|---|
| constructor(LowCodeSaveOptions) | Constructs from a parent object convertible to this. |
| constructor() | Default Constructor. |
Properties
| Property | Type | Description |
|---|---|---|
| imageOptions | ImageOrPrintOptions | The options for rendering images. |
| saveOptionsProvider | AbstractLowCodeSaveOptionsProvider | Provider of save options for saving generated images. |
| outputFile | string | Gets and sets the file(with path if needed) for saving the generated data. When setting this property with value other than null or empty string, OutputStream will be ignored. |
| outputStream | Uint8Array | Gets and sets the Stream for writing the generated data to. When setting this property with value other than null, OutputFile will be ignored. |
Methods
| Method | Description |
|---|---|
| getImageOptions() | @deprecated. Please use the ‘imageOptions’ property instead. The options for rendering images. |
| setImageOptions(ImageOrPrintOptions) | @deprecated. Please use the ‘imageOptions’ property instead. The options for rendering images. |
| getSaveOptionsProvider() | @deprecated. Please use the ‘saveOptionsProvider’ property instead. Provider of save options for saving generated images. |
| setSaveOptionsProvider(AbstractLowCodeSaveOptionsProvider) | @deprecated. Please use the ‘saveOptionsProvider’ property instead. Provider of save options for saving generated images. |
| isNull() | Checks whether the implementation object is null. |
| getOutputFile() | @deprecated. Please use the ‘outputFile’ property instead. Gets and sets the file(with path if needed) for saving the generated data. When setting this property with value other than null or empty string, OutputStream will be ignored. |
| setOutputFile(string) | @deprecated. Please use the ‘outputFile’ property instead. Gets and sets the file(with path if needed) for saving the generated data. When setting this property with value other than null or empty string, OutputStream will be ignored. |
| getOutputStream() | @deprecated. Please use the ‘outputStream’ property instead. Gets and sets the Stream for writing the generated data to. When setting this property with value other than null, OutputFile will be ignored. |
| setOutputStream(Uint8Array) | @deprecated. Please use the ‘outputStream’ property instead. Gets and sets the Stream for writing the generated data to. When setting this property with value other than null, OutputFile will be ignored. |
| getSaveFormat() | Gets or sets the save format. |
| setSaveFormat(SaveFormat) | Gets or sets the save format. |
constructor(LowCodeSaveOptions)
Constructs from a parent object convertible to this.
constructor(obj: LowCodeSaveOptions);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | LowCodeSaveOptions | The parent object. |
constructor()
Default Constructor.
constructor();
imageOptions
The options for rendering images.
imageOptions : ImageOrPrintOptions;
Remarks
When one ImageOrPrintOptions instance is specified, the SaveFormat will be overwritten(if it had been specified before).
saveOptionsProvider
Provider of save options for saving generated images.
saveOptionsProvider : AbstractLowCodeSaveOptionsProvider;
Remarks
The output(LowCodeSaveOptions.OutputFile or LowCodeSaveOptions.OutputStream) specified by this instance will take no effect when this property is specified. Instead the output of every generated image will be specified by the provider.
outputFile
Gets and sets the file(with path if needed) for saving the generated data. When setting this property with value other than null or empty string, OutputStream will be ignored.
outputFile : string;
outputStream
Gets and sets the Stream for writing the generated data to. When setting this property with value other than null, OutputFile will be ignored.
outputStream : Uint8Array;
getImageOptions()
@deprecated. Please use the ‘imageOptions’ property instead. The options for rendering images.
getImageOptions() : ImageOrPrintOptions;
Returns
Remarks
When one ImageOrPrintOptions instance is specified, the SaveFormat will be overwritten(if it had been specified before).
setImageOptions(ImageOrPrintOptions)
@deprecated. Please use the ‘imageOptions’ property instead. The options for rendering images.
setImageOptions(value: ImageOrPrintOptions) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ImageOrPrintOptions | The value to set. |
Remarks
When one ImageOrPrintOptions instance is specified, the SaveFormat will be overwritten(if it had been specified before).
getSaveOptionsProvider()
@deprecated. Please use the ‘saveOptionsProvider’ property instead. Provider of save options for saving generated images.
getSaveOptionsProvider() : AbstractLowCodeSaveOptionsProvider;
Returns
AbstractLowCodeSaveOptionsProvider
Remarks
The output(LowCodeSaveOptions.OutputFile or LowCodeSaveOptions.OutputStream) specified by this instance will take no effect when this property is specified. Instead the output of every generated image will be specified by the provider.
setSaveOptionsProvider(AbstractLowCodeSaveOptionsProvider)
@deprecated. Please use the ‘saveOptionsProvider’ property instead. Provider of save options for saving generated images.
setSaveOptionsProvider(value: AbstractLowCodeSaveOptionsProvider) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | AbstractLowCodeSaveOptionsProvider | The value to set. |
Remarks
The output(LowCodeSaveOptions.OutputFile or LowCodeSaveOptions.OutputStream) specified by this instance will take no effect when this property is specified. Instead the output of every generated image will be specified by the provider.
isNull()
Checks whether the implementation object is null.
isNull() : boolean;
getOutputFile()
@deprecated. Please use the ‘outputFile’ property instead. Gets and sets the file(with path if needed) for saving the generated data. When setting this property with value other than null or empty string, OutputStream will be ignored.
getOutputFile() : string;
setOutputFile(string)
@deprecated. Please use the ‘outputFile’ property instead. Gets and sets the file(with path if needed) for saving the generated data. When setting this property with value other than null or empty string, OutputStream will be ignored.
setOutputFile(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getOutputStream()
@deprecated. Please use the ‘outputStream’ property instead. Gets and sets the Stream for writing the generated data to. When setting this property with value other than null, OutputFile will be ignored.
getOutputStream() : Uint8Array;
setOutputStream(Uint8Array)
@deprecated. Please use the ‘outputStream’ property instead. Gets and sets the Stream for writing the generated data to. When setting this property with value other than null, OutputFile will be ignored.
setOutputStream(value: Uint8Array) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Uint8Array | The value to set. |
getSaveFormat()
Gets or sets the save format.
getSaveFormat() : SaveFormat;
Returns
Remarks
If ImageOptions has been specified, setting this property will also change the ImageOrPrintOptions.ImageType value of it.
setSaveFormat(SaveFormat)
Gets or sets the save format.
setSaveFormat(value: SaveFormat) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | SaveFormat | The value to set. |
Remarks
If ImageOptions has been specified, setting this property will also change the ImageOrPrintOptions.ImageType value of it.