External module properties

The properties you define in the package.json file can be accessed with the piweb.properties module. To enable type checking, there is one function for each available datatype.

Definition of a property in the package.json file:

{
    "name": "myplot",
     ...
    "piweb_extension": {
         ...
        "propertygrid": {
            "categories": {
                "general": {
                    "name": "General",
                    "priority": 0
                }
            },
            "entries": {
                "myproperty": {
                    "name": "Do it right",
                    "description": "Determines whether to do it right",
                    "type": "boolean",
                    "default_value": false,
                    "category": "general"
                }
         }
        }
    }
}

For a complete reference of the package format, including the definition of properties, please read the chapter 'package definition'.

---

Access the property in your script:

import * as piweb from 'piweb';
import properties = piweb.properties;

properties.getBooleanProperty('myPropertyName')

see

package definition