LowCodeHtmlSaveOptions

LowCodeHtmlSaveOptions class

Options for saving html in low code way.

class LowCodeHtmlSaveOptions extends LowCodeSaveOptions;

Constructors

ConstructorDescription
constructor(LowCodeSaveOptions)Constructs from a parent object convertible to this.
constructor()Default Constructor.

Properties

PropertyTypeDescription
htmlOptionsHtmlSaveOptionsThe general options for saving html.
outputFilestringGets 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.
outputStreamUint8ArrayGets and sets the Stream for writing the generated data to. When setting this property with value other than null, OutputFile will be ignored.

Methods

MethodDescription
getHtmlOptions()@deprecated. Please use the ‘htmlOptions’ property instead. The general options for saving html.
setHtmlOptions(HtmlSaveOptions)@deprecated. Please use the ‘htmlOptions’ property instead. The general options for saving html.
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 and sets the format of spreadsheet.
setSaveFormat(SaveFormat)Gets and sets the format of spreadsheet.

constructor(LowCodeSaveOptions)

Constructs from a parent object convertible to this.

constructor(obj: LowCodeSaveOptions);

Parameters:

ParameterTypeDescription
objLowCodeSaveOptionsThe parent object.

constructor()

Default Constructor.

constructor();

htmlOptions

The general options for saving html.

htmlOptions : HtmlSaveOptions;

Remarks

When one HtmlSaveOptions instance is specified, the SaveFormat will be overwritten(if it had been specified before).

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;

getHtmlOptions()

@deprecated. Please use the ‘htmlOptions’ property instead. The general options for saving html.

getHtmlOptions() : HtmlSaveOptions;

Returns

HtmlSaveOptions

Remarks

When one HtmlSaveOptions instance is specified, the SaveFormat will be overwritten(if it had been specified before).

setHtmlOptions(HtmlSaveOptions)

@deprecated. Please use the ‘htmlOptions’ property instead. The general options for saving html.

setHtmlOptions(value: HtmlSaveOptions) : void;

Parameters:

ParameterTypeDescription
valueHtmlSaveOptionsThe value to set.

Remarks

When one HtmlSaveOptions instance is specified, the SaveFormat will be overwritten(if it had been specified before).

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:

ParameterTypeDescription
valuestringThe 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:

ParameterTypeDescription
valueUint8ArrayThe value to set.

getSaveFormat()

Gets and sets the format of spreadsheet.

getSaveFormat() : SaveFormat;

Returns

SaveFormat

Remarks

When changing this property, the save format specified by HtmlOptions will be ignored(if it had been specified before).

setSaveFormat(SaveFormat)

Gets and sets the format of spreadsheet.

setSaveFormat(value: SaveFormat) : void;

Parameters:

ParameterTypeDescription
valueSaveFormatThe value to set.

Remarks

When changing this property, the save format specified by HtmlOptions will be ignored(if it had been specified before).