Class ManageSubcategoriesAndIndicators

constructor

• new ManageSubcategoriesAndIndicators(
      tab: string,
      user_role: string,
  ): ManageSubcategoriesAndIndicators

  constructor of the class ManageSubcategoriesAndIndicators

  Parameters

  • tab: string

    tab from which the class is instantiated
  • user_role: string

    the role when logged in: 'mdg', 'mus', 'com', 'syc'

  Returns ManageSubcategoriesAndIndicators

btn_save_new_indicator

btn_save_new_subcategory

btn_save_toc_order

btn_save_toc_order_subcategories

config_indicators

container_indicators

container_regex_errors

container_subcategories

dropdown_category

dropdown_subcategory

dropdown_unit

edit_mode

input_indicator_data_source

input_indicator_infotext_en

input_indicator_infotext_fr

input_indicator_name

input_indicator_toc_en

input_indicator_toc_fr

input_indicator_unit

input_subcategory_info_title

input_subcategory_name

input_subcategory_toc_en

input_subcategory_toc_fr

lang

tab

user_country_code

checkForEmptyInputs

• checkForEmptyInputs(
      shortcut: string,
  ): "input-errors-detected" | "no-input-errors-detected"

  checks whether all input elements have been populated can be used for creation and edits of subcategories and indicators

  Parameters

  • shortcut: string

    'subcategory' or 'indicator'

  Returns "input-errors-detected" | "no-input-errors-detected"

  input-errors-detected or no-input-errors-detected

checkNameValidity

• checkNameValidity(
      string_to_test: string,
      subcategory_or_indicator: string,
  ): boolean

  checks a string against a regex for subcategories AND indicators:

  • only lowercase letters from a-z or underscores are included (this also rejects spaces)
  • cannot start with an underscore
  • cannot end with an underscore
  • an underscore is never followed by another underscore for indicators ONLY:
  • can contain a number at the end

  Parameters

  • string_to_test: string

    the string to be tested against the regex
  • subcategory_or_indicator: string

    whether testing for a subcategory or indicator name

  Returns boolean

  isValid

disableInputs

• disableInputs(disable_true_false: boolean): void

  disables or enables all user inputs

  Parameters

  • disable_true_false: boolean

    true = disable, false = enable

  Returns void

dropdownChangeCategories_ManageIndicators

• dropdownChangeCategories_ManageIndicators(): void

  when the category dropdown in the Manage Indicators tab is changed:

  • populate subcategory dopdown with all subcategories of that category

  Returns void

dropdownChangeCategories_ManageSubcategories

• dropdownChangeCategories_ManageSubcategories(): void

  when the category dropdown in the Manage Subcategories tab is changed:

  • show list of all available subcategories for that category
  • show input fields: subcategory name code, TOC text FR, TOC text EN
  • show save button

  Returns void

dropdownChangeSubcategories_ManageIndicators

• dropdownChangeSubcategories_ManageIndicators(): void

  when the subcategory dropdown in the Manage Indicators tab is changed:

  • show list of all available indicators for that subcategory
  • show input fields: indicator name code, TOC text FR, TOC text EN
  • show save button

  Returns void

onConfigLoaded

• onConfigLoaded(config: any): void

  logic to be executed when the config has finished loading

  Parameters

  • config: any

    the config

  Returns void

onUnitDropdownChange

• onUnitDropdownChange(): void

  when a unit is selected in the units dropdown, copy the unit into the unit text input

  Returns void

onUnitInputChange

• onUnitInputChange(event: any): void

  triggers when a new character is added to unit input

  Parameters

  • event: any

    input change event

  Returns void

populateDropdownCategories

• populateDropdownCategories(): void

  used for both tabs Manage Subcategories and Manage Indicators

  Returns void

populateDropdownUnits

• populateDropdownUnits(): void

  populates the units dropdown with available units

  Returns void

saveDataset

• saveDataset(dataObject: any): void

  creates or edits a subcategory creates or edits an indicator

  Parameters

  • dataObject: any

    the data to be sent to the server

  Returns void

saveTocOrder

• saveTocOrder(): void

  saves the indicators TOC order

  Returns void

saveTocOrderSubcategories

• saveTocOrderSubcategories(): void

  saves the subcategories TOC order

  Returns void

tocOrderDown

• tocOrderDown(event: any): void

  moves an item down in the indicators list

  Parameters

  • event: any

    the click event

  Returns void

tocOrderSubcategoriesDown

• tocOrderSubcategoriesDown(event: any): void

  moves an item down in the subcategories list

  Parameters

  • event: any

    the click event

  Returns void

tocOrderSubcategoriesUp

• tocOrderSubcategoriesUp(event: any): void

  moves an item up the subcategories list

  Parameters

  • event: any

    the click event

  Returns void

tocOrderUp

• tocOrderUp(event: any): void

  moves an item up in the indicators list

  Parameters

  • event: any

    the click event

  Returns void

triggerEditIndicator

• triggerEditIndicator(event: any): void

  triggered on click of Edit button (pen icon) copies the indicator name code, TOC text FR, TOC text EN into the input fields

  Parameters

  • event: any

    click event, used to know which indicator was clicked

  Returns void

triggerEditSubcategory

• triggerEditSubcategory(event: any): void

  triggered on click of Edit button (pen icon) copies the subcategory code, TOC text FR, TOC text EN into the input fields

  Parameters

  • event: any

    click event, used to know which subcategory was clicked

  Returns void

triggerSaveNewIndicator

• triggerSaveNewIndicator(): void

  reads the inputs checks for indicator name validity builds dataObject calls server request function

  Returns void

triggerSaveNewSubcategory

• triggerSaveNewSubcategory(): void

  reads the inputs checks for subcategory name validity builds dataObject calls server request function

  Returns void