Back to Beekeeper Studio

Data Editor API

apps/ui-kit/docs/api/data-editor.md

5.7.21.8 KB
Original Source

Data Editor API

For examples and usage details, visit Data Editor page.

Properties

NameTypeDescriptionDefault
entitiesobject[]An array of entities. See Entity API for more details.[]
entityListPropsobjectAn object of Entity List properties.{}
sqlTextEditorPropsobjectAn object of SQL Text Editor properties.{}
tablePropsobjectAn object of Table properties.{}

Methods

NameDescriptionArguments
setEntity()Sets the entity data.Entity

Events

All events of Table, Entity List and SQL Text Editor components are available, in addition to the following events:

NameDescriptionEvent Detail
bks-query-submitEmitted when the query is submitted.{ query: string }