@iapps/ngx-dhis2-org-unit-filter
v1.1.37
Published
Organisation unit selection filter module for DHIS2 applications based on angular 6+
Downloads
74
Maintainers
Keywords
Readme
DHIS2 Organisation unit selection filter
Organisation unit selection filter module for DHIS2 applications based on angular 6+
installation
npm install @iapps/ngx-dhis2-org-unit-filter
Usage
If the module is to be imported in the app.module or any other feature module, then import as
import { NgxDhis2OrgUnitFilterModule } from '@iapps/ngx-dhis2-org-unit-filter';
then add this in the imports
imports: [
...
NgxDhis2OrgUnitFilterModule,
...
]
Once imported, orgunitfilter can be called in as
<ngx-dhis2-org-unit-filter
[orgUnitFilterConfig]="orgUnitFilterConfig"
[selectedOrgUnitItems]="selectedOrgUnitItems"
(orgUnitUpdate)="onOrgUnitUpdate($event, 'UPDATE')"
(orgUnitClose)="onOrgUnitUpdate($event, 'CLOSE')">
</ngx-dhis2-org-unit-filter>
Inputs
| Input | Description | | -------------------- | --------------------------------------------------------------------------------- | | selectedOrgUnitItems | This is a list of selected organisation units, groups, or levels | | orgUnitFilterConfig | This when passed overrides default configuration for the organisation unit filter |
Input models
selectedOrgUnitItems
| Item | Description | | ---------------- | ----------------------------------------------------------------------------------------------------------------- | | id | Organisation unit identifier | | name (optional) | Organisation unit name | | level (optional) | Level of organisation unit in the hierarchy eg. 1, 2 | | type (optional) | Type of organisation unit eg. USER_ORGANISATIONUNIT, ORGANISATION_LEVEL, ORGANISATIONUNIT_GROUP, ORGANISATIONUNIT |
orgUnitFilterConfig
| Item | Description | Default value | | ------------------------- | --------------------------------------------------------------------- | ------------- | | singleSelection | Specify whether org unit selection is single or multiple | true | | reportUse (optional) | Tells whether org units should be used for reports or data entry | true | | minLevel (optional) | Specify minimum level for org units | none | | updateOnSelect (optional) | Specify whether to update on select or unselect or on button click | false | | closeOnDestroy (optional) | Call on closeOrgUnit Method when component get destroyed, if set true | true |
Outputs
| Output | Description | | ------------- | --------------------------------------------- | | orgUnitUpdate | This is emitted when UPDATE button is clicked | | orgUnitClose | This is emitted when CLOSE button is clicked |
Sample output
{
"dimension": "ou",
"items": [
{
"id": "PMa2VCrupOd",
"name": "Kambia",
"level": 2,
"type": "ORGANISATION_UNIT"
},
{
"id": "at6UHUQatSo",
"name": "Western Area",
"level": 2,
"type": "ORGANISATION_UNIT"
},
{
"id": "TEQlaapDQoK",
"name": "Port Loko",
"level": 2,
"type": "ORGANISATION_UNIT"
}
]
}