au-widget-datasheet/au-widget-datasheet

Classes

AuWidgetDataSheet

A widget that is used to display tables.

The following example illustrates how you can configure the editor, display a product preview, and create a table of variable fields.

{
  "widgets": [
    {
      "name": "canvas",
      "type": "canvas",
      "params": {
        "initial": { ... }
      }
    },
    {
      "name": "preview",
      "type": "image-carousel",
      "params": {
        "containerColor": "#ccc",
        "images": [{ "url": "{{$['editor'].proofImageUrls[0][0]}}" }]
      }
    },
    {
      "name": "table",
      "type": "datasheet",
      "params": {
        "data": "{{ $['canvas'].variableData }}"
      }
    }
  ],
  "steps": [
    {
      "name": "design",
      "title": "1. Design",
      "mainPanel": { "name": "canvas" }
    },
    {
      "name": "user data",
      "title": "2. Your data",
      "onActivate": [
        "{{ #function $['canvas'].saveProduct() }}",
        "{{ #function $['canvas'].getVariableData() }}"
      ],
      "mainPanel": { "name": "preview" },
      "bottomPanel": {
        "name": "table",
        "height": "50%"
      }
    }
  ]
}

Extends

AuBaseSelectorWidget

Implements

IRestorableWidget

Properties

params

params: IWidgetDataSheetConfig;

Properties of the widget.

Overrides

AuBaseSelectorWidget.params

selectedColumnIndex

selectedColumnIndex: number;

selectedRow

selectedRow: DataSheetRow;

The selected row.

selectedRowIndex

selectedRowIndex: number = 0;

The index of the selected row.

tableData

tableData: DataSheetRow[];

total

total: number = 1;

Accessors

_

Get Signature

get _(): DataSheetRow;

Returns the selected row.

Returns

DataSheetRow

Overrides

AuBaseSelectorWidget._

Methods

addRow()

addRow(): void;

add row to table

Returns

void

checkInitDependenciesWidgets()

checkInitDependenciesWidgets(): string[];

Returns an array of widget names, due to which the current widget cannot receive parameters.

Returns

string[]

Inherited from

AuBaseSelectorWidget.checkInitDependenciesWidgets

deleteRow()

deleteRow(): void;

delete selected row

Returns

void

exportWidgetData()

exportWidgetData(force): Promise<TableWidgetData>;

Parameters

Parameter	Type
`force`	`boolean`

Returns

Promise<TableWidgetData>

Implementation of

IRestorableWidget.exportWidgetData

getSelectedRowData()

getSelectedRowData<TFieldData>(): TFieldData[];

Gets selected row data with all column-associated data.

Type Parameters

Type Parameter
`TFieldData` extends `DataSheetFieldData`

Returns

TFieldData[]

An array of column values with all associated data of the selected row.

getSelectedRowItemsData()

getSelectedRowItemsData(): IItemsData;

Gets 'ItemsData' from selected row.

Returns

IItemsData

getTableData()

getTableData<TFieldData>(): TFieldData[][];

Gets all row data with all associated data.

Type Parameters

Type Parameter
`TFieldData` extends `DataSheetFieldData`

Returns

TFieldData[][]

getTableItemsData()

getTableItemsData(): IItemsData[];

Gets 'ItemsData' from all table.

Returns

IItemsData[]

renderTable()

renderTable(): void;

Render table forcefully, hiding private tableService

Returns

void

resetPreloaderState()

resetPreloaderState(): void;

Returns

void

Inherited from

AuBaseSelectorWidget.resetPreloaderState

restoreWidgetFromData()

restoreWidgetFromData(widgetData, force): Promise<void>;

Parameters

Parameter	Type
`widgetData`	`TableWidgetData`
`force`	`boolean`

Returns

Promise<void>

Implementation of

IRestorableWidget.restoreWidgetFromData

setErrors()

setErrors(errors): void;

Sets a table error.

Parameters

Parameter	Type
`errors`	`DataSheetCellError`[]

Returns

void

showPreloader()

showPreloader(
   isPreload, 
   message?, 
   timeout?): void;

Shows a preloader.

"onClick": [
  "{{#function main.showPreloader(true, 'Creating print files...')}}",
  "{{#function $['editor'].getHiResImages(800,800)}}",
  "{{#function main.showPreloader(false)}}"
]

Parameters

Parameter	Type	Default value	Description
`isPreload`	`boolean`	`undefined`	If `true`, enables the preloader.
`message`	`string` \| `string`[]	`...`	A text message that appears next to the preloader.
`timeout`	`number`	`5`	-

Returns

void

Inherited from

AuBaseSelectorWidget.showPreloader

showToast()

showToast(data?, duration?): void;

Shows a toast.

return editor.loadUserInfo(data)
    .catch(err => {
        this.widget.showToast("Error: Invalid data");
        console.log(err);
    });

Parameters

Parameter	Type	Description
`data?`	`string`	A string message to display in the toast.
`duration?`	`number`	Defines how long to show the toast for.

Returns

void

Inherited from

AuBaseSelectorWidget.showToast

References

Renames and re-exports AuWidgetDataSheet

Classes​