Package version:

Interface ExcelDataset

Excel dataset.

interface ExcelDataset {
    annotations?: any[];
    compression?: DatasetCompression;
    description?: string;
    firstRowAsHeader?: any;
    folder?: DatasetFolder;
    linkedServiceName: LinkedServiceReference;
    location?: DatasetLocationUnion;
    nullValue?: any;
    parameters?: {
        [propertyName: string]: ParameterSpecification;
    };
    range?: any;
    schema?: any;
    sheetIndex?: any;
    sheetName?: any;
    structure?: any;
    type: "Excel";
}

Hierarchy (view full)

Properties

annotations? compression? description? firstRowAsHeader? folder? linkedServiceName location? nullValue? parameters? range? schema? sheetIndex? sheetName? structure? type

Properties

Optionalannotations

annotations?: any[]

List of tags that can be used for describing the Dataset.

Optionalcompression

compression?: DatasetCompression

The data compression method used for the json dataset.

Optionaldescription

description?: string

Dataset description.

OptionalfirstRowAsHeader

firstRowAsHeader?: any

When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).

Optionalfolder

folder?: DatasetFolder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference

Linked service reference.

Optionallocation

location?: DatasetLocationUnion

The location of the excel storage.

OptionalnullValue

nullValue?: any

The null value string. Type: string (or Expression with resultType string).

Optionalparameters

parameters?: {
    [propertyName: string]: ParameterSpecification;
}

Parameters for dataset.

Optionalrange

range?: any

The partial data of one sheet. Type: string (or Expression with resultType string).

Optionalschema

schema?: any

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

OptionalsheetIndex

sheetIndex?: any

The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer)

OptionalsheetName

sheetName?: any

The sheet name of excel file. Type: string (or Expression with resultType string).

Optionalstructure

structure?: any

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

type

type

Polymorphic discriminator, which specifies the different types this object can be

Settings

Member Visibility