jig.composite
The composite jig is a jig made up of several parts or elements. In this case, a jig is made up of several jigs. This jig allows you to display multiple jigs on one list where you would otherwise be unable to combine the functionality in the same way.
Configuration options
Some properties are common to all jig types, see Common jig type properties for a list and their configuration options.
jigId
The core structure includes two jigId or more (depends on how many jigs you are connecting).
icon
The icon will be displayed on the widget of this jig. Start typing the name of the icon to invoke the available list in IntelliSense. See Jigx icons for information on working with icons.
inputs
If you are setting up a jig.composite where jigs rely on input to display or otherwise interact with very specific data, you'll need to use inputs. Here you set the data you would like to transfer to the composite jig. There are 2 options to make data available for input: 1) Set them in output inside the jig. 2) Set them as a global variable by using set-state action.
isTitleHidden
The boolean value allows you to hide the title of your jig in the composite jig. Even if the jig's title is set to true , because the title is a mandatory property.
when
The ability to include or exclude a jig for display on a composite jig. If set to true the jig is included, if set to false the jig will not appear on the composite jig. Dynamically set this property by using expressions.
Considerations
When calling a jig in a composite jig for example,
jigId: personal-details, you can add aninstanceIdon the composite jig. This allows you to interact with the referenced jig, such as saving or calling a control on the referenced jig. If noinstanceIdexists, IntelliSense cannot show it in the composite jig configuration.
children:
- jigId: personal-details
instanceId: personalDetails
inputs:
inputName: My details
- jigId: work-details
instanceId: workDetails
- jigId: employee-details
instanceId: hrInfo
actions:
- children:
# you can choose an action to save the data as an object
- type: action.execute-entity
options:
title: Create my details
provider: DATA_PROVIDER_DYNAMIC
entity: default/personal
method: create
data: [email protected]
# or
# you can choose an action to save individual fields
- type: action.execute-entity
options:
title: Create my work details
provider: DATA_PROVIDER_DYNAMIC
entity: default/work
method: create
data:
employee-position: [email protected]
employee-startWork: [email protected]
# or
# you can choose an action to save individual fields from Multiple jigs
- type: action.execute-entity
options:
title: Create Employee details
provider: DATA_PROVIDER_DYNAMIC
entity: default/employees
method: create
data:
id: [email protected]
employee-first-name: [email protected]
employee-surname: [email protected]
employee-position: [email protected]
employee-contract: [email protected] Examples and code snippets
The code below is an extract from the full jigx-samples solution. The code snippets describe the component discussed in this section. For the solution to function in the Jigx app download the full jigx-samples project from GitHub and follow the instructions in Setting up your solution.
Composite Jig without any form of input
This example shows the simplest way in which a Composite Jig can be set up - referencing two separate jigs and displaying them on one without having to filter the content.
Examples:
See the composite jig code example in GitHub. See the location code and country list code examples in GitHub. See the static country datasource code example in GitHub. See the index.jigx code below to add the jig to the Home Hub.
Composite Jig with input
This example shows how a Composite jig can be used to only display certain data based on the input received.
Examples: See the full composite jig input code example in GitHub. See the folder with supporting files in GitHub. See the datasource code sample in GitHub.
See the default.jigx code snippet with the database table defined below.
See also
Last updated
Was this helpful?