reenact.reenact.views#
Module for rendering HTML pages and API endpoints.
MainView
#
Bases: TemplateView
Render HTML for main page.
get_context_data(**kwargs)
#
Get context data for main page.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
**kwargs
|
Additional keyword arguments. |
{}
|
Returns:
| Name | Type | Description |
|---|---|---|
dict |
Context data for rendering the main page. |
MapView
#
Bases: TemplateView, MapEngineMixin
Render HTML for map.
get_context_data(**kwargs)
#
Get context data for map and update layer colors.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
**kwargs
|
Additional keyword arguments. |
{}
|
Returns:
| Name | Type | Description |
|---|---|---|
dict |
dict
|
Context data for rendering the map. |
PotentialsView
#
Bases: TemplateView
Render HTML for potentials.
get_context_data(**kwargs)
#
Get context data for potentials.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
**kwargs
|
Additional keyword arguments. |
{}
|
Returns:
| Name | Type | Description |
|---|---|---|
dict |
Context data containing potentials. |
ResultBoxView
#
Bases: TemplateView
Render HTML for result boxes.
get_context_data(**kwargs)
#
Get context data for result boxes.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
**kwargs
|
Additional keyword arguments. |
{}
|
Returns:
| Name | Type | Description |
|---|---|---|
dict |
Context data containing results. |
chart(request)
#
Return chart data as JSON from simulation or user input.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
The HTTP request object. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
JsonResponse |
JsonResponse
|
Chart data in JSON format. |
get_sliders_from_scenario(request, scenario_id)
#
Return slider values for given scenario ID.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
The HTTP request object. |
required | |
scenario_id
|
int
|
The ID of the scenario. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
HTTPResponse |
HttpResponse
|
Load main view which redirects to myplan if slider values are set. |
scenario_chart(request, scenario_id, *, simulated=False)
#
Return echart options as JSON.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
The HTTP request object. |
required | |
scenario_id
|
int
|
The ID of the scenario. |
required |
simulated
|
bool
|
If True, return simulated electricity chart data. Defaults to False. |
False
|
Returns:
| Type | Description |
|---|---|
JsonResponse | HttpResponse
|
JsonResponse | HttpResponse: Echart options in JSON format or 405 error. |