ExportRangeToJsonOptions

ExportRangeToJsonOptions class

Indicates the options that exporting range to json.

class ExportRangeToJsonOptions;

Constructors

ConstructorDescription
constructor()Default Constructor.

Properties

PropertyTypeDescription
hasHeaderRowbooleanIndicates whether the range contains header row.
exportAsStringbooleanExports the string value of the cells to json.
exportEmptyCellsbooleanIndicates whether exporting empty cells as null.
indentstringIndicates the indent.

Methods

MethodDescription
getHasHeaderRow()@deprecated. Please use the ‘hasHeaderRow’ property instead. Indicates whether the range contains header row.
setHasHeaderRow(boolean)@deprecated. Please use the ‘hasHeaderRow’ property instead. Indicates whether the range contains header row.
getExportAsString()@deprecated. Please use the ’exportAsString’ property instead. Exports the string value of the cells to json.
setExportAsString(boolean)@deprecated. Please use the ’exportAsString’ property instead. Exports the string value of the cells to json.
getExportEmptyCells()@deprecated. Please use the ’exportEmptyCells’ property instead. Indicates whether exporting empty cells as null.
setExportEmptyCells(boolean)@deprecated. Please use the ’exportEmptyCells’ property instead. Indicates whether exporting empty cells as null.
getIndent()@deprecated. Please use the ‘indent’ property instead. Indicates the indent.
setIndent(string)@deprecated. Please use the ‘indent’ property instead. Indicates the indent.
isNull()Checks whether the implementation object is null.

constructor()

Default Constructor.

constructor();

hasHeaderRow

Indicates whether the range contains header row.

hasHeaderRow : boolean;

exportAsString

Exports the string value of the cells to json.

exportAsString : boolean;

exportEmptyCells

Indicates whether exporting empty cells as null.

exportEmptyCells : boolean;

indent

Indicates the indent.

indent : string;

Remarks

If the indent is null or empty, the exported json is not formatted.

getHasHeaderRow()

@deprecated. Please use the ‘hasHeaderRow’ property instead. Indicates whether the range contains header row.

getHasHeaderRow() : boolean;

setHasHeaderRow(boolean)

@deprecated. Please use the ‘hasHeaderRow’ property instead. Indicates whether the range contains header row.

setHasHeaderRow(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getExportAsString()

@deprecated. Please use the ’exportAsString’ property instead. Exports the string value of the cells to json.

getExportAsString() : boolean;

setExportAsString(boolean)

@deprecated. Please use the ’exportAsString’ property instead. Exports the string value of the cells to json.

setExportAsString(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getExportEmptyCells()

@deprecated. Please use the ’exportEmptyCells’ property instead. Indicates whether exporting empty cells as null.

getExportEmptyCells() : boolean;

setExportEmptyCells(boolean)

@deprecated. Please use the ’exportEmptyCells’ property instead. Indicates whether exporting empty cells as null.

setExportEmptyCells(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getIndent()

@deprecated. Please use the ‘indent’ property instead. Indicates the indent.

getIndent() : string;

Remarks

If the indent is null or empty, the exported json is not formatted.

setIndent(string)

@deprecated. Please use the ‘indent’ property instead. Indicates the indent.

setIndent(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

Remarks

If the indent is null or empty, the exported json is not formatted.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;