Common api¶

getRelatedUsers¶

Get other users associated with the current base (collaborators of the table, the shared person of the table, etc.)

dtable.getRelatedUsers()

Example

const collaborators = dtable.getRelatedUsers();

getCollaboratorsName¶

Get a list of names of collaborators

dtable.getCollaboratorsName(collaborators, value)

Arguments

collaborators: collaborator list in this base
value: email list of collaborators

Example

const collaborators = dtable.getRelatedUsers();
const value = ['abc@seafile.com', 'shun@seafile.com'];
const name = dtable.getCollaboratorsName(collaborators, value); // 'abc, shun'

getTableFormulaResults¶

Get the data in the calculation formula column of the table

dtable.getTableFormulaResults(table, rows)

Arguments

table: table object
rows: row data of the relevant data of the calculation formula column

Example

const tableName = 'tableName';
const viewName = 'viewName';
const table = dtable.getTableByName(tableName);
const view = dtable.getViewByName(table, viewName);
const rows = dtable.getViewRows(view, table);

const formulaResult = dtable.getTableFormulaResults(table, rows);

getViewRowsColor¶

Get the color attributes of the row data in the view

dtable.getViewRowsColor(rows, view, table)

Arguments

rows: the rows of the color attribute
view: view object
table: table object

Example

const tableName = 'tableName';
const viewName = 'viewName';
const table = dtable.getTableByName(tableName);
const view = dtable.getViewByName(table, viewName);
const rows = dtable.getViewRows(view, table);

const rowsColor = dtable.getViewRowsColor(rows, view, table);

getLinkCellValue¶

Get the id list of the row data of the table linked with the row data of other tables

dtable.getLinkCellValue(linkId, tableId, otherTableId, rowId)

Arguments

linkId: the link_id value corresponding to the column
tableId: the id value of the current table
otherTableId: the id value of the linked table
rowId: the id value of the row in the current table

Example

const tableName = 'tableName';
const table = dtable.getTableByName(tableName);

const rows = table.rows;
const row = rows[0];

const columnName = 'linkColumn';
const linkColumn = dtable.getColumnByName(table, columnName);
const { link_id, table_id, other_table_id, display_column_key } = linkColumn.data;
const linkedTableId = table._id === table_id ? other_table_id : table_id;

const linkedRowIds = dtable.getLinkCellValue(link_id, table._id, linkedTableId, row._id);

getLinkDisplayString¶

Get the content value of the linked row of the link column

dtable.getLinkDisplayString(linkedRowIds, linkedTable, displayColumnKey)

Arguments

linkedRowIds: list of linked row ids
linkedTable: linked table object
displayColumnKey: display column key

Example

const tableName = 'tableName';
const table = dtable.getTableByName(tableName);

const rows = table.rows;
const row = rows[0];

const columnName = 'linkColumn';
const linkColumn = dtable.getColumnByName(table, columnName);
const { link_id, table_id, other_table_id, display_column_key } = linkColumn.data;
const linkedTableId = table._id === table_id ? other_table_id : table_id;

const linkedRowIds = dtable.getLinkCellValue(link_id, table._id, linkedTableId, row._id);
const linkedTable = dtable.getTableById(linkedTableId);

const results = dtable.getLinkDisplayString(linkedRowIds, linkedTable, display_column_key);

getNumberDisplayString¶

Get the string display of the number column (return user data according to different formats)

dtable.getNumberDisplayString(value, columnData)

Arguments

value: the value corresponding to the number column
columnData: the data configuration attribute of the corresponding column of the number column

Example

const tableName = 'tableName';
const table = dtable.getTableByName(tableName);
const columnName = 'numberColumn';
const column = dtable.getColumnByName(table, columnName);

const value = 190203;
const name = dtable.getNumberDisplayString(value, column.data);

getGeolocationDisplayString¶

Get the string display of the geolocation column (return user data according to different configuration parameters)

dtable.getGeolocationDisplayString(value, columnData)

Arguments

value: the value corresponding to the geolocation column
columnData: the data configuration attribute of the corresponding column geolocation column

Example

const tableName = 'tableName';
const table = dtable.getTableByName(tableName);
const columnName = 'geolocationColumn';
const column = dtable.getColumnByName(table, columnName);

const value = {country_region: 'Germany'};
const name = dtable.getGeolocationDisplayString(value, column.data);

getDurationDisplayString¶

Get the string display of the duration column (return user data according to different configuration parameters)

dtable.getDurationDisplayString(value, columnData)

Arguments

value: the value corresponding to the duration column
columnData: the data configuration attribute of the corresponding column of the duration column

Example

const tableName = 'tableName';
const table = dtable.getTableByName(tableName);
const columnName = 'durationColumn';
const column = dtable.getColumnByName(table, columnName);

const value = '12:30';
const name = dtable.getDurationDisplayString(value, column.data);

getDateDisplayString¶

Get the string display of the date column (return user data according to different configuration parameters)

dtable.getDateDisplayString(value, columnData)

Arguments

value: the value corresponding to the date column
columnData: the data configuration attribute of the column corresponding to the date column

Example

const tableName = 'tableName';
const table = dtable.getTableByName(tableName);
const columnName = 'dateColumn';
const column = dtable.getColumnByName(table, columnName);

const value = 'YYYY-MM-DD';
const name = dtable.getDateDisplayString(value, column.data);