getPluginData()
The function returns the properties of a specific plugin.
Synopsis
mapping getPluginData(string plugin)
Parameter
Parameter | Description |
---|---|
plugin | Name of the plugin |
Description
The function returns a mapping containing the properties and corresponding values of the stated plugin.
A list of the available plugins can be found using the Widget property renderPlugins.
The returned mapping contains following keys:
- name
- description
- version
- enabled
- visible
- userCheckable
- settings
- renderType
The plugin specific properties are contained within the key "settings" as a separate mapping. Following example represents the plugin data for the "coordinate-grid" plugin.
Example
[mapping 8 items
"renderType" : "unknown"
"description" : "A plugin that shows a coordinate grid."
"settings" : mapping 7 items
"tropicsColor" : "#ffff00"
"primaryLabels" : TRUE
"equatorColor" : "#ffff00"
"visible" : TRUE
"secondaryLabels" : TRUE
"enabled" : TRUE
"gridColor" : "#ffffff"
"name" : "Coordinate Grid"
"visible" : TRUE
"userCheckable" : TRUE
"enabled" : TRUE
"version" : "1.0"
Assignment
See also