Skip to content

add docs about parameterType to DataType mapping #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DanDits wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add docs about parameterType to DataType mapping #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,6 +456,31 @@ The geometry parameter value will be a Shapely geometry object.
**Note:** Parameters for Analytics Extensions of the type `visual` can currently *not* yet be assigned on the Cadenza side when displaying the result as a Cadenza view.


### Parameter values received from Cadenza

Depending on the `ParameterType` the extension request will get parametrized by Cadenza from the user's input.

The following table shows how parameter values are mapped to Python types:

| ParameterType | DataType | Python Type | Notes |
|----------------|---------------|--------------------|----------------------------------------------------|
| STRING | STRING | `str` | |
| INT64 | INT64 | `int` | Nullable integer |
| FLOAT64 | FLOAT64 | `float` | Nullable float |
| BOOLEAN | STRING | `bool` | _known limitation: DataType BOOLEAN not available_ |
| ZONEDDATETIME | ZONEDDATETIME | `datetime` | Parsed with timezone |
| GEOMETRY | GEOMETRY | `shapely.Geometry` | Parsed from WKT |
| SELECT | STRING | `str` | |

In many scenarios accessing additional parameter metadata, such as DataType, is not needed. However, the information is available as an object via `request.parameters.info('the_param_name')`.
This object exposes the following properties:
- `name`: technical name to identify the parameter within this extension
- `print_name`: Parameter print name as defined in the extension and shown to the user
- `data_type`: DataType of the value, see table above
- `value`: the assigned value, usually directly accessed via `request.parameters['the_param_name']`
- `geometry_type`: available for `GEOMETRY` parameters, describes the geometry type of the value
- `srs`: available for `GEOMETRY` parameters, describes the spatial reference system of the value

## Configuring the Extension

The [`CadenzaAnalyticsExtension`](cadenzaanalytics/cadenza_analytics_extension.html) ties everything together:
Expand Down