Zum Hauptinhalt springen

TableGadget

Deprecated​

use TableGadgetReact from ou.sp.gadget.TableGadgetReact instead

Implements​

Constructors​

Constructor​

new TableGadget(options): TableGadget

Erstellt eine neue TableGadget Instanz.

Parameters​

options​

TableGadgetOptions

Die Optionen für das TableGadget

Returns​

TableGadget

Example​

context.returnValue = new TableGadget({
 rows: [
     { id: "1", name: "name1" },
     { id: "2", name: "name2" },
     { id: "3", name: "name3" }
 ]
}).transfer();

Properties​

gadgetBuilder​

gadgetBuilder: MultiTableGadgetBuilder

Implementation of​

ITransferableMultiTable.gadgetBuilder

options​

options: TableGadgetOptions

Implementation of​

MultiTableInstance.options

Methods​

toString()​

toString(): string

Returns a string representation of an object.

Returns​

string

Implementation of​

ITransferableMultiTable.toString

transfer()​

transfer(): string

Returns​

string

Implementation of​

ITransferableMultiTable.transfer

saveAsXlsx()​

saveAsXlsx(filePath): MultiTableXlsxExporter

Speichert die Instanz als Excel-Datei ab.

Parameters​

filePath​

string

Der Zielpfad (inkl. Dateiname) z.B. "D:\tmp\test.xlsx"

Returns​

MultiTableXlsxExporter

Implementation of​

IXlsxExportableMultiTable.saveAsXlsx

downloadAsXlsx()​

downloadAsXlsx(filePath): string

Parameters​

filePath​

string

Returns​

string

setStore()​

setStore(fieldName): void

Parameters​

fieldName​

string

Returns​

void

hasWriteAccessOnFileField()​

hasWriteAccessOnFileField(): boolean

Checks for write access on specified field

Returns​

boolean

from()​

static from(rows): TableGadget

Erstellt ein neues TableGadget Objekt anhand der rows

Parameters​

rows​

object[]

Returns​

TableGadget

Example​

context.returnValue = TableGadget.from({
 rows: [
     { id: "1", name: "name1" },
     { id: "2", name: "name2" },
     { id: "3", name: "name3" }
 ]
}).transfer();

fromFileResultset()​

static fromFileResultset<TFileTypeName>(fileResultset, fields?): TableGadget

Iterate through an FileResultset

Type Parameters​

TFileTypeName​

TFileTypeName extends FileTypeName

Parameters​

fileResultset​

FileResultset<TFileTypeName>

fields?​

string[]

Returns​

TableGadget

Example​

const { TableGadget } = require("ou.sp.gadget.TableGadget");
const fileResultset = new FileResultset("YOURFILETYPE")
const fields = ["field1", "field2"]
context.returnValue = TableGadget.fromFileResultset(fileResultset, fields).transfer();

fromHitResultset()​

static fromHitResultset(hitResultset): TableGadget

Iterate through an HitResultset

Parameters​

hitResultset​

HitResultset

Returns​

TableGadget

Example​

const { TableGadget } = require("ou.sp.gadget.TableGadget");
const hitResultset = new HitResultset(searchResources, filter, sortOrder, hitlist)
context.returnValue = TableGadget.fromHitResultset(hitResultset).transfer()

fromDatabase()​

static fromDatabase(query): TableGadget

Creates a TableGadget from a database query. It uses the columns alias or name as label and the type from the given type. If no columns are defined, it will use the first row to generate the columns.

Parameters​

query​

SelectBuilder

Returns​

TableGadget

Example​

const { TableGadget } = require("ou.sp.gadget.TableGadget");

const db = new DBConnection("odbc", "invoicecontroldb", "user", "pwd")
const query = SelectBuilder
                 .from("costcenter", db)
                 .select([{
                          name: "id",
                          alias: "Kostenstelle",
                          type: "number",
                      },{
                          name: "costcenterName",
                          alias: "Kostenstelle Bezeichnung",
                          type: "string",
                      },
                 ]);

context.returnValue = TableGadget.fromDatabase(query).transfer();
// Generates a gadget with the costcenters from the database with the column header "Kostenstelle" and "Kostenstelle Bezeichnung"