Module commonapi.uiparameter
UI Paramater creating
Info:
- Copyright: 2017-2018
- Author: Oskar Eisemuth
UI Parameter interface
| createTrackCatenary ([o]) | Create a track and catenary selector uiparamater |
| createTrack ([o]) | Create a track selector uiparamater |
| createStreet ([o]) | Create a street selector uiparamater |
| createRailBridge ([o]) | Create a rail bridge selector uiparamater |
| createRoadBridge ([o]) | Create a road bridge selector uiparamater |
| modifyTrackCatenary (params[, o]) | Modify a track and catenary ui paramater |
| modifyRailBridge (params[, o]) | Modify a rail bridge ui paramater |
| replace (params, newparams) | Replaces ui parameters with new parameters |
Class UITypeSelector
| UITypeSelector:new ([o]) | Constructor |
| UITypeSelector:addFilter (filter) | Adds a new filter to the filter list |
| UITypeSelector:getEntries () | Returns a filtered list of items in the repository |
| UITypeSelector:createUIParams (params) | Creates ui params |
| UITypeSelector:getSelection (params) | Get result from user selection |
| UITypeSelector.filters | Default filter list |
Class TrackSelector
| TrackSelector.key | Param key |
| TrackSelector.caption | Caption |
Class TrackCatenarySelector
| TrackCatenarySelector:createUIParams (params) | Creates ui params including catenary |
| TrackCatenarySelector:getCatenarySelection (params) | Get result from user selection (catenary). |
| TrackCatenarySelector:getSelection (params) | Get result from user selection (track) |
| TrackCatenarySelector.key | Param key |
| TrackCatenarySelector.caption | Caption |
| TrackCatenarySelector.catenary_key | Key to be used for catenary |
| TrackCatenarySelector.catenary_caption | Caption to be used for catenary |
Class StreetSelector
| StreetSelector.key | Param key |
| StreetSelector.caption | Caption |
Class BridgeSelector
| BridgeSelector.key | Param key |
| BridgeSelector.caption | Caption |
Class RailBridgeSelector
| RailBridgeSelector.key | Param key |
| RailBridgeSelector.caption | Caption |
| RailBridgeSelector.filters | Default filter list, only selects bridges that carries rail |
Class RoadBridgeSelector
| RoadBridgeSelector.key | Param key |
| RoadBridgeSelector.caption | Caption |
| RoadBridgeSelector.filters | Default filters for only selects bridges that carries road. |
UI Parameter interface
- createTrackCatenary ([o])
-
Create a track and catenary selector uiparamater
Parameters:
- o object (optional)
Returns:
- createTrack ([o])
-
Create a track selector uiparamater
Parameters:
- o object (optional)
Returns:
- createStreet ([o])
-
Create a street selector uiparamater
Parameters:
- o object (optional)
Returns:
- createRailBridge ([o])
-
Create a rail bridge selector uiparamater
Parameters:
- o object (optional)
Returns:
- createRoadBridge ([o])
-
Create a road bridge selector uiparamater
Parameters:
- o object (optional)
Returns:
- modifyTrackCatenary (params[, o])
-
Modify a track and catenary ui paramater
Parameters:
- params reference to parameters
- o object (use key "selectionlist" for overwriting a target list of filenames ) (optional)
Returns:
- modifyRailBridge (params[, o])
-
Modify a rail bridge ui paramater
Parameters:
- params reference to parameters
- o object (use key "selectionlist" for overwriting a target list of filenames ) (optional)
Returns:
- replace (params, newparams)
-
Replaces ui parameters with new parameters
Parameters:
Returns:
-
table
params reference
Class UITypeSelector
Base ui parameter Object
- UITypeSelector:new ([o])
-
Constructor
Parameters:
- o object (optional)
- UITypeSelector:addFilter (filter)
-
Adds a new filter to the filter list
Parameters:
- filter function
- UITypeSelector:getEntries ()
-
Returns a filtered list of items in the repository
Returns:
-
{commonapi.repos.repoentry,...}
Entries
See also:
- UITypeSelector:createUIParams (params)
-
Creates ui params
Parameters:
- params table Parameter table reference
- UITypeSelector:getSelection (params)
-
Get result from user selection
Parameters:
- params table Parameter table of updateFn
Returns:
-
commonapi.repos.repoentry
A repository entry
- UITypeSelector.filters
- Default filter list
Class TrackSelector
TrackSelector Class
- TrackSelector.key
-
Param key
- key string Key of catenary (default "trackType")
- TrackSelector.caption
-
Caption
- caption string Caption Text (default "Translated Track type")
Class TrackCatenarySelector
Track and Catenary Selector
- TrackCatenarySelector:createUIParams (params)
-
Creates ui params including catenary
Parameters:
- params
- TrackCatenarySelector:getCatenarySelection (params)
-
Get result from user selection (catenary).
Parameters:
- params
- TrackCatenarySelector:getSelection (params)
-
Get result from user selection (track)
Parameters:
- params table Parameter table of updateFn
Returns:
-
commonapi.repos.repoentry
A repository entry
- TrackCatenarySelector.key
-
Param key
- key string Key of param (default "trackType")
- TrackCatenarySelector.caption
-
Caption
- caption string Caption Text (default "Translated Track type")
- TrackCatenarySelector.catenary_key
-
Key to be used for catenary
- catenary_key string Key of catenary (default "catenary")
- TrackCatenarySelector.catenary_caption
-
Caption to be used for catenary
- catenary_caption string Text of catenary (default "Translated Catenary")
Class StreetSelector
StreetSelector
- StreetSelector.key
-
Param key
- key string Key of param (default "streetType")
- StreetSelector.caption
-
Caption
- caption string Caption Text (default "Translated Street")
Class BridgeSelector
BridgeSelector
- BridgeSelector.key
-
Param key
- key string Key of catenary (default "bridgeType")
- BridgeSelector.caption
-
Caption
- caption string Caption Text (default "Translated Bridge")
Class RailBridgeSelector
RailBridgeSelector
Rail bridge selector
- RailBridgeSelector.key
-
Param key
- key string Key of catenary (default "bridgeType")
- RailBridgeSelector.caption
-
Caption
- caption string Caption Text (default "Translated Bridge")
- RailBridgeSelector.filters
-
Default filter list, only selects bridges that carries rail
Fields:
- filter
- filter
Class RoadBridgeSelector
RoadBridgeSelector
Road bridge selector