schema.datashape.md
January 18, 2023 ยท View on GitHub
Home > @datashaper/schema > DataShape
DataShape interface
Defines parameters for understanding the logical structure of data contents.
Signature:
export interface DataShape
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| matrix? | [width: number, height: number] | (Optional) Defines the Row x Column layout of a raw list of values (e.g., a pandas Series). For example, { data: [1,2,3,4,5,6], shape: { matrix: [3, 2] } } is interpreted as table 1 2 3 4 5 6 | |
| nature? | DataNature | (Optional) Defines the expected nature of the dataset | |
| orientation? | DataOrientation | (Optional) Data orientation. Default: "values" is the only valid option if the format is csv, "records" is default if JSON. |