Components

entity

6min

The entity component itself does not serve much of a purpose other than being a container for the below components:
﻿entity-field﻿﻿
﻿entity-field﻿﻿
﻿section﻿﻿
This container counts for the above-mentioned components on a default jig. Section﻿ and field-row﻿ are also available under the form component as its container. In the last mentioned case, entity-field﻿ are replaced by the form's﻿ children fields. 
When setting up an entity component, either a default jig﻿ or form component can be used in the below combinations:
An entity containing section(s)﻿ with rows﻿ and entity-field﻿﻿
An entity containing section(s)﻿ and entity-field﻿﻿
An entity containing rows﻿ and entity-field﻿﻿
An entity containing entity fields﻿﻿
﻿Configuration options﻿
Some properties are common to all components, see Common component properties﻿ for a list and their configuration options.
﻿
isCompact - when this property is set to true the entity-field will cover the whole row. So this compact variant doesn't allow usage of field-row component. 
﻿Examples and code snippets ﻿
Entity example
Basic
﻿
Compact
﻿
Examples:
Basic - See the full example using static data in GitHub.
Compact - See the full example using dynamic data in GitHub.
Basic-entity-section-row-entity-field
Compact-entity-section-entity-field
Datasource (dynamic)
|
datasources:
  cleaning-services:
    type: datasource.sqlite
    options:
      provider: DATA_PROVIDER_DYNAMIC
  
      entities:
        - entity: default/cleaning-services
  
      query: |
        SELECT 
          id, 
          '$.area', 
          '$.description', 
          '$.hourlyrate', 
          '$.illustration', 
          '$.image', 
          '$.indoor', 
          '$.onceoffrate', 
          '$.service', 
          '$.time' 
        FROM [default/cleaning-services] ORDER BY '$.service' ASC
datasources:
  cleaning-services:
    type: datasource.sqlite
    options:
      provider: DATA_PROVIDER_DYNAMIC
  
      entities:
        - entity: default/cleaning-services
  
      query: |
        SELECT 
          id, 
          '$.area', 
          '$.description', 
          '$.hourlyrate', 
          '$.illustration', 
          '$.image', 
          '$.indoor', 
          '$.onceoffrate', 
          '$.service', 
          '$.time' 
        FROM [default/cleaning-services] ORDER BY '$.service' ASC
﻿
See also
Developer reference 
﻿entity  
﻿entity-field﻿ 
﻿field-row﻿ 
﻿﻿﻿section﻿ ﻿ 
﻿