Skip to main content
Version: 14

viktor.views

DataStatus​

class viktor.views.DataStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enumeration of statuses to annotate a DataItem.

INFO: DataStatus = 'info'
SUCCESS: DataStatus = 'success'
WARNING: DataStatus = 'warning'
ERROR: DataStatus = 'error'

DataItem​

class viktor.views.DataItem(label, value, subgroup=None, *, prefix='', suffix='', number_of_decimals=None, status=DataStatus.INFO, status_message='', explanation_label='')

Constructs an entry that can be used as input of a DataGroup, to fill the data view with results.

The data view is dynamic, which means that a DataItem itself can consist of another DataGroup as subgroup. Both examples are demonstrated below.

Example single entry:

result = "I am a great result"
item = DataItem('output 1', result)

Example subgroup:

result = "I am a great result"
item = DataItem('output 1', result, subgroup=DataGroup(
    output11=DataItem('output 1.1', "I can also be a numeric result"),
    output12=DataItem('output 1.2', 123)
))

The prefix / suffix can potentially change with every call. However, when the result is used in the Summary, the prefix / suffix of the DataItem should be equal to the prefix / suffix of the SummaryItem to maintain a consistent database.

Parameters:

  • label (str) – Description of the value which is shown. e.g: ‘Uc bending’

  • value (Union[str, float, None]) – Value of the data. e.g: 0.9

  • subgroup (DataGroup) – Optional DataItems grouped together in a DataGroup underneath this DataItem. Maximum depth = 3

  • prefix (str) – E.g: €. Should be equal to the prefix of the SummaryItem if linked.

  • suffix (str) – E.g: N. Should be equal to the suffix of the SummaryItem if linked.

  • number_of_decimals (int) – Number of decimals with which the value is rounded for display.

  • status (DataStatus) –

    Status of value. This controls the formatting of the status_message:

    • status=DataStatus.INFO: black text

    • status=DataStatus.SUCCESS: green text

    • status=DataStatus.WARNING: orange text

    • status=DataStatus.ERROR: red text

  • status_message (str) – Message which will be shown underneath the value. Color can be formatted with status.

  • explanation_label (str) – Optional text which is placed between the label and the value. Could for instance be used for a calculation.

Raises:

TypeError – if number_of_decimals is used on a non-numeric value.

property subgroup: DataGroup

DataGroup​

class viktor.views.DataGroup(*args, **kwargs)

Bases: OrderedDict

Container for DataItems, maximum number = 100. They can be added with or without a keyword argument, but they should be equal for all DataItems in the same DataGroup. Keywords are necessary when you want to use a DataItem in the summary (for lookup).

The following two use cases are valid:

d1 = DataGroup(
    DataItem('item1',0),
    DataItem('item2',1),
)

d2 = DataGroup(
    a=DataItem('item1',0),
    b=DataItem('item2',1),
)
Parameters:

  • args (DataItem) – DataItem entries.

  • kwargs (DataItem) – Keyworded DataItem entries.

Raises:

  • TypeError when positional- and keyword arguments are used together

  • AttributeError when more than 100 DataItems are used

classmethod from_data_groups(groups)

Constructs a combined DataGroup object from a list of individual DataGroup entries.

Note that is not possible to have multiple DataGroups that share a specific key for a DataItem, e.g. the following will result in an error:

d1 = DataGroup(output_a=DataItem(...))
d2 = DataGroup(output_a=DataItem(...))
d3 = DataGroup.from_data_groups([d1, d2])
Return type:

DataGroup

MapEntityLink​

Represents a link between a feature in a MapView and a specific entity.

Example usage:

gef_link = MapEntityLink('GEF x', gef_entity_id)
gef_marker = MapPoint(51.99311570849245, 4.385752379894256, entity_links=[gef_link])
Parameters:

  • label (str) – text which is shown to the user.

  • entity_id (int) – id of the linked entity.

MapFeature​

class viktor.views.MapFeature(*, title=None, description=None, color=Color(39, 45, 51), entity_links=None, identifier=None)

Bases: ABC

Base class for features that can be shown in a MapView. See the documentation of the subclasses for example implementations.

Parameters:

  • title (str) – Title of a clickable map feature.

  • description (str) – Description of a clickable map feature.

  • color (Color) – Specifies the color of the map feature.

  • entity_links (List[MapEntityLink]) – When clicking on the map feature, links towards multiple entities can be shown.

  • identifier (Union[int, str]) – feature identifier

    New in v13.2.0

MapPoint​

class viktor.views.MapPoint(lat, lon, alt=0, *, icon=None, size='medium', **kwargs)

Bases: MapFeature

Represents a point on the Earth’s surface described by a latitude/longitude coordinate pair.

Example usage:

marker = MapPoint(51.99311570849245, 4.385752379894256)
Parameters:

  • lat (float) – Latitude.

  • lon (float) – Longitude.

  • alt (float) – Altitude.

  • icon (str) – icon to be shown (default: “pin”). See below for all possible icons.

  • size (Literal['small', 'medium', 'large']) – size of the marker (“small” | “medium” | “large”)

    New in v14.5.0
    .

  • kwargs (Any) – See MapFeature for possible kwargs.

List of icons:

  • arrow-down: arrow-down

  • arrow-left: arrow-left

  • arrow-right: arrow-right

  • arrow-up: arrow-up

  • chevron-down: chevron-down

  • chevron-left: chevron-left

  • chevron-right: chevron-right

  • chevron-up: chevron-up

  • circle: circle

  • circle-filled: circle-filled

  • cross: cross

  • diamond: diamond

  • diamond-horizontal: diamond-horizontal

  • drop: drop

  • exclamation-circle: exclamation-circle

  • exclamation-circle-filled: exclamation-circle-filled

  • message: message

  • minus: minus

  • minus-circle: minus-circle

  • minus-circle-filled: minus-circle-filled

  • pin: pin

  • pin-add: pin-add

  • pin-edit: pin-edit

  • plus: plus

  • plus-circle: plus-circle

  • plus-circle-filled: plus-circle-filled

  • plus-thick: plus-thick

  • question-circle: question-circle

  • question-circle-filled: question-circle-filled

  • square: square

  • square-filled: square-filled

  • star: star

  • triangle: triangle

  • triangle-down: triangle-down

  • triangle-down-filled: triangle-down-filled

  • triangle-filled: triangle-filled

  • triangle-left: triangle-left

  • triangle-left-filled: triangle-left-filled

  • triangle-right: triangle-right

  • triangle-right-filled: triangle-right-filled

  • viktor: viktor

  • warning: warning

  • warning-filled: warning-filled

  • wye: wye

classmethod from_geo_point(point, *, icon=None, size='medium', **kwargs)

Instantiates a MapPoint from the provided GeoPoint.

Parameters:

  • point (GeoPoint) – GeoPoint.

  • icon (str) – icon to be shown (default: “pin”). For a complete list of all available markers, see __init__()

  • size (Literal['small', 'medium', 'large']) – size of the marker (“small” | “medium” | “large”)

    New in v14.5.0
    .

  • kwargs (Any) – See MapFeature for possible kwargs.

Return type:

MapPoint

property lat: float
property lon: float
property alt: float

MapPolyline​

class viktor.views.MapPolyline(*points, **kwargs)

Bases: MapFeature

Represents a polyline on the earth’s surface between several latitude/longitude pairs.

Example usage:

 line = MapPolyline(
    MapPoint(51.99311570849245, 4.385752379894256),
    MapPoint(52.40912125231122, 5.031738281255681),
    ...
)
Parameters:

  • points (MapPoint) – MapPoints with latitude and longitude pair.

  • kwargs (Any) – See MapFeature for possible kwargs.

classmethod from_geo_polyline(polyline, **kwargs)

Instantiates a MapPolyline from the provided GeoPolyline.

Parameters:
Return type:

MapPolyline

property points: List[MapPoint]

MapLine​

class viktor.views.MapLine(start_point, end_point, **kwargs)

Bases: MapPolyline

Represents a line on the earth’s surface between two latitude/longitude pairs.

In case multiple line segments are to be created, a MapPolyline may be preferred.

Example usage:

 line = MapLine(
    MapPoint(51.99311570849245, 4.385752379894256),
    MapPoint(52.40912125231122, 5.031738281255681)
)
Parameters:

  • start_point (MapPoint) – Map point with latitude and longitude pair.

  • end_point (MapPoint) – Map point with latitude and longitude pair.

  • kwargs (Any) – See MapFeature for possible kwargs.

property start_point: MapPoint
property end_point: MapPoint

MapPolygon​

class viktor.views.MapPolygon(points, *, holes=None, **kwargs)

Bases: MapFeature

Represents a polygon on the earth’s surface formed by a set of latitude/longitude pairs.

Example usage:

polygon = MapPolygon([
    MapPoint(52.373922404495474, 5.2459716796875),
    MapPoint(52.10313118589299, 5.3997802734375),
    MapPoint(52.373922404495474, 5.57281494140625),
])
Parameters:

  • points (List[MapPoint]) – Map points with latitude and longitude pair. The profile is automatically closed, so it is not necessary to add the start point at the end.

  • holes (List[MapPolygon]) – List of interior polygons which form holes in the exterior polygon.

  • kwargs (Any) – See MapFeature for possible kwargs.

classmethod from_geo_polygon(polygon, **kwargs)

Instantiates a MapPolygon from the provided GeoPolygon.

Parameters:
Return type:

MapPolygon

property points: List[MapPoint]
property holes: List[MapPolygon]

MapLegend​

class viktor.views.MapLegend(entries)

A legend which is placed as an overlay on a map view.

Example usage:

legend = MapLegend([
    (Color.from_hex('#0016FF'), "I'm blue"),
    (Color.from_hex('#FF0000'), "I'm red"),
    ...
])
Parameters:

entries (List[Tuple[Color, str]]) – Items in the legend, defined by color and label.

MapLabel​

class viktor.views.MapLabel(lat, lon, text, scale, *, fixed_size=False)

Text which is placed as an overlay on the map.

Scale 0-5 is approximately the scale for countries:

/_images/map_label_scale_0_5.png

Scale 6-10 is approximately the scale for cities:

/_images/map_label_scale_6_11.png

Scale 11-15 is approximately the scale for neighborhoods and streets

/_images/map_label_scale_11_15.png

Scale 16-18 is approximately for individual houses.

/_images/map_label_scale_14_19.png
Parameters:

  • lat (float) – Latitude of text in degrees.

  • lon (float) – Longitude of text in degrees.

  • text (str) – Text with is displayed on the map.

  • scale (float) – Size of the text on an exponential scale. See example in class docstring for estimate.

  • fixed_size (bool) – When True, the size of the text is fixed regardless of zoom level (default: False).

Label​

class viktor.views.Label(point, *text, size_factor=1, color=Color(0, 0, 0))

Text label

Parameters:

  • point (Point) – Position of the label.

  • text (str) – Text to show; multiple text arguments will each be shown on a new line.

  • size_factor (float) – Factor to be applied to the font size (0 < size_factor <= 10).

  • color (Color) – Color of the text.

property point: Point
property text: str | Tuple[str, ...]
serialize()
Return type:

dict

TableCell​

class viktor.views.TableCell(value, *, text_color=None, background_color=None, text_style=None)

TableHeader​

class viktor.views.TableHeader(title, *, align=None, num_decimals=None)

Header object that can be used in TableResult to set styling.

Parameters:

  • title (str) – Title that will be shown in the header.

  • align (Optional[Literal['center', 'left', 'right']]) – Visual alignment of the corresponding row/column values within the table

  • num_decimals (Optional[int]) – Number of decimals that is shown for the row/column values (requires corresponding row/column to contain only numbers).

GeometryResult​

class viktor.views.GeometryResult(geometry, labels=None, *, geometry_type='gltf')

Bases: _ViewResult

Container with the results that should be visualized in a GeometryView. This consists of three-dimensional geometry object(s) and optional text labels.

To enable a geometric object for interaction, the object must be named using the ‘identifier’ argument. In case of a glTF/GLB-file, the objects name can be provided on the “name” key within a node. If none of the objects in the GeometryResult have a name assigned, default names are assigned to all of them (enabling them for interaction). Note: if there are multiple objects with the same name, a number will automatically be appended to enforce uniqueness.

Example viktor.geometry TransformableObject(s):

geometry = Sphere(Point(0, 0), 10, identifier="MySphere")
GeometryResult(geometry)  # or [obj1, obj2, ...] in case of multiple objects

By specifying the geometry_type you can render 3D geometry files either by providing a path, URL, or dynamically created (e.g. using trimesh). Currently supported geometry types are: “gltf”, “3dm”.

Example static geometry file from path:

geometry = File.from_path(Path(__file__).parent / "my_model.gltf")
GeometryResult(geometry, geometry_type="gltf")

Example static geometry file from a URL:

geometry = File.from_url("https://github.com/KhronosGroup/glTF-Sample-Models/tree/main/2.0/CesiumMilkTruck/glTF-Binary/CesiumMilkTruck.glb")
GeometryResult(geometry, geometry_type="gltf")

Example dynamic geometry file (e.g. using trimesh):

sphere = trimesh.creation.uv_sphere(10)
scene = trimesh.Scene(geometry={'sphere': sphere})
geometry = File()
with geometry.open_binary() as w:
    w.write(trimesh.exchange.gltf.export_glb(scene))
GeometryResult(geometry, geometry_type="gltf")
Parameters:

  • geometry (Union[TransformableObject, Sequence[TransformableObject], File]) – TransformableObject(s) that contain the geometric objects, or a geometry file such as glTF/GLB (v2.0) (https://en.wikipedia.org/wiki/GlTF).

  • geometry_type (str) – Type of loader that should be used to render the geometry (“gltf”, “3dm”)

    New in v14.4.0
    .

  • labels (List[Label]) – Text labels that can be used to provide additional information.

GeometryAndDataResult​

class viktor.views.GeometryAndDataResult(geometry, data, labels=None, *, geometry_type='gltf')

Bases: _ViewResult

Container with the results that should be visualized in a GeometryAndDataView. This consists of three-dimensional geometry object(s) with optional text labels and data.

Please have a look at GeometryResult for examples.

Parameters:

  • geometry (Union[TransformableObject, Sequence[TransformableObject], File]) – TransformableObject(s) that contain the geometric objects, or a geometry file such as glTF/GLB (v2.0) (https://en.wikipedia.org/wiki/GlTF).

  • geometry_type (str) – Type of loader that should be used to render the geometry (“gltf”, “3dm”)

    New in v14.4.0
    .

  • data (DataGroup) – Result data.

  • labels (List[Label]) – Text labels that can be used to provide additional information.

DataResult​

class viktor.views.DataResult(data)

Bases: _ViewResult

Container with the data that should be shown in a DataView. This data can be nested up to three levels deep.

Parameters:

data (DataGroup) – Result data.

ImageResult​

class viktor.views.ImageResult(image)

Bases: _ViewResult

New in v13.7.0

Image to be visualized in an ImageView.

Supported image types are ‘svg’, ‘jpeg’, ‘png’, ‘gif’.

Parameters:

image (Union[StringIO, BytesIO, File]) – image file.

classmethod from_path(file_path)

Use file path to construct the image result.

Parameters:

file_path (Union[str, bytes, PathLike]) – Path to the image.

Return type:

ImageResult

ImageAndDataResult​

class viktor.views.ImageAndDataResult(image, data)

Bases: _ViewResult

New in v13.7.0

Container with the image and result data that should be visualized in a ImageAndDataView.

Supported image types are ‘svg’, ‘jpeg’, ‘png’, ‘gif’.

Parameters:

  • image (Union[StringIO, BytesIO, File]) – image file.

  • data (DataGroup) – Result data.

GeoJSONResult​

class viktor.views.GeoJSONResult(geojson, labels=None, legend=None, *, interaction_groups=None)

Bases: _ViewResult

Container with the GeoJSON data that should be visualized in a GeoJSONView. Optionally a legend and map labels can be included.

The following geojson properties are supported that can be used for styling of the map elements:

  • icon (geometry type ‘Point’ only): icon to be shown (default: “pin”). For a complete list of all available markers, see MapPoint

  • marker-color: the color of a marker [*]

  • description: text to show when this item is clicked

  • stroke: the color of a line as part of a polygon, polyline, or multigeometry *

  • fill: the color of the interior of a polygon *

To enable interaction, the map feature identifiers can be defined within the geojson dict by adding an “id” attribute to a feature as follows:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": ...,
      "geometry": ...
      "id": "my identifier",
      ...
Parameters:

  • geojson (dict) – GeoJSON dictionary.

  • labels (List[MapLabel]) – Labels that should be placed on the map.

  • legend (MapLegend) – Map legend.

  • interaction_groups (Dict[str, Sequence[Union[int, str, MapFeature]]]) – create named groups that can be referred to in a map interaction

    New in v13.2.0

property geojson: dict

GeoJSONAndDataResult​

class viktor.views.GeoJSONAndDataResult(geojson, data, labels=None, legend=None, *, interaction_groups=None)

Bases: _ViewResult

Container with the GeoJSON data and result data that should be visualized in a GeoJSONAndDataView. Optionally a legend and map labels can be included.

Parameters:

  • geojson (dict) – GeoJSON dictionary.

  • data (DataGroup) – Result data.

  • labels (List[MapLabel]) – Labels that should be placed on the map.

  • legend (MapLegend) – Map legend.

  • interaction_groups (Dict[str, Sequence[Union[int, str, MapFeature]]]) – create named groups that can be referred to in a map interaction

    New in v13.2.0

property geojson: dict

MapResult​

class viktor.views.MapResult(features, labels=None, legend=None, *, interaction_groups=None)

Bases: GeoJSONResult

Container with the Map data that should be visualized in a MapView. Optionally a legend and map labels can be included.

Parameters:

  • features (List[MapFeature]) – List that contains the map objects.

  • labels (List[MapLabel]) – Labels that should be placed on the map.

  • legend (MapLegend) – Map legend.

  • interaction_groups (Dict[str, Sequence[Union[int, str, MapFeature]]]) – create named groups that can be referred to in a map interaction

    New in v13.2.0

property features: List[MapFeature]
property geojson: dict

MapAndDataResult​

class viktor.views.MapAndDataResult(features, data, labels=None, legend=None, *, interaction_groups=None)

Bases: GeoJSONAndDataResult

Container with the Map data and result data that should be visualized in a MapAndDataView. Optionally a legend and map labels can be included.

Parameters:

  • features (List[MapFeature]) – List that contains the map objects.

  • data (DataGroup) – Result data.

  • labels (List[MapLabel]) – Labels that should be placed on the map.

  • legend (MapLegend) – Map legend.

  • interaction_groups (Dict[str, Sequence[Union[int, str, MapFeature]]]) – create named groups that can be referred to in a map interaction

    New in v13.2.0

property features: List[MapFeature]
property geojson: dict

WebResult​

class viktor.views.WebResult(*, html=None, url=None)

Bases: _ViewResult

Container with the data that should be visualized in a WebView. There are two options, which should not be used together:

  • url: to serve a URL (takes precedence if both are defined)

  • html: for serving a single html page

Parameters:

  • html (Union[StringIO, File, str]) – HTML formatted content.

  • url (str) – Direct URL.

classmethod from_path(file_path)
Return type:

WebResult

WebAndDataResult​

class viktor.views.WebAndDataResult(*, html=None, url=None, data=None)

Bases: _ViewResult

Container with the web data and result data that should be visualized in a WebAndDataView.

The Web part can be constructed in two ways, which should not be used together:

  • url: to serve a URL (takes precedence if both are defined)

  • html: for serving a single html page

Parameters:

  • html (Union[StringIO, File, str]) – HTML formatted content.

  • url (str) – Direct URL.

  • data (DataGroup) – Result data.

PlotlyResult​

class viktor.views.PlotlyResult(figure)

Bases: _ViewResult

Plotly figure to be visualized in a PlotlyView. The figure can be provided in json-string or dict format.

Example usages:

@PlotlyView("Plotly view", duration_guess=1)
def get_plotly_view(self, params, **kwargs):
    fig = go.Figure(
        data=[go.Bar(x=[1, 2, 3], y=[1, 3, 2])],
        layout=go.Layout(title=go.layout.Title(text="A Figure Specified By A Graph Object"))
    )
    return PlotlyResult(fig.to_json())

@PlotlyView("Plotly view", duration_guess=1)
def get_plotly_view(self, params, **kwargs):
    fig = {
        "data": [{"type": "bar", "x": [1, 2, 3], "y": [1, 3, 2]}],
        "layout": {"title": {"text": "A Figure Specified By Python Dictionary"}}
    }
    return PlotlyResult(fig)
Parameters:

figure (Union[str, dict]) – Plotly figure in str (json) or dict format

PlotlyAndDataResult​

class viktor.views.PlotlyAndDataResult(figure, data)

Bases: _ViewResult

Plotly figure to be visualized in a PlotlyAndDataView. The figure can be provided in json-string or dict format.

Example usage:

@PlotlyAndDataView("Plotly and data view", duration_guess=1)
def get_plotly_and_data_view(self, params, **kwargs):
    data_group = ...

    fig = go.Figure(
        data=[go.Bar(x=[1, 2, 3], y=[1, 3, 2])],
        layout=go.Layout(title=go.layout.Title(text="A Figure Specified By A Graph Object"))
    )
    return PlotlyAndDataResult(fig.to_json(), data_group)
Parameters:

  • figure (Union[str, dict]) – Plotly figure in json-str or dict format

  • data (DataGroup) – result data

PDFResult​

class viktor.views.PDFResult(*, file=None, url=None)

Bases: _ViewResult

PDF document to be visualized in a PDFView. Can be defined from a File object or from a URL (direct-sharing). If both file and url are defined, url takes precedence.

In case of URL: the hosting website must allow for direct accessing for the document to be shown. If this is forbidden (undefined CORS-headers), the document can alternatively be shown via the file argument with a File.from_url(…), in which it is downloaded first and viewed subsequently (indirect-sharing).

Example usages:

From URL (direct-sharing):

PDFResult(url="https://www...")

From URL (indirect-sharing):

f = File.from_url("https://www...")
PDFResult(file=f)

From path:

file_path = Path(__file__).parent / 'sample.pdf'
PDFResult.from_path(file_path)  # or ...
PDFResult(File.from_path(file_path))
Parameters:

  • file (File) – PDF document to view

  • url (str) – URL of PDF document to view. If accessing the PDF directly from the URL is not allowed by the host website (undefined CORS-headers), this will result in the document not showing up in the view (as an alternative one can use File.from_url).

classmethod from_path(file_path)

Create the PDFResult from a path to the PDF file.

Parameters:

file_path (Union[str, bytes, PathLike]) – file path to a PDF file

Return type:

PDFResult

IFCResult​

class viktor.views.IFCResult(ifc)

Bases: _ViewResult

New in v14.6.0

IFC to be visualized in an IFCView.

Example static geometry file from path:

ifc = File.from_path(Path(__file__).parent / 'sample.ifc')
IFCResult(ifc)

Example static geometry file from a URL:

ifc = File.from_url("https://github.com/IFCjs/test-ifc-files/raw/main/Others/haus.ifc")
IFCResult(ifc)

(new in v14.6.1) In order to improve performance it is possible to use the value of a FileField (i.e. FileResource) directly:

IFCResult(params.file_field)
Parameters:

ifc (Union[File, FileResource]) – IFC geometry file.

IFCAndDataResult​

class viktor.views.IFCAndDataResult(ifc, data)

Bases: _ViewResult

New in v14.6.0

Container with the results that should be visualized in an IFCAndDataView.

Please have a look at IFCResult for examples.

Parameters:

TableResult​

class viktor.views.TableResult(data, *, column_headers=None, row_headers=None, enable_sorting_and_filtering=None)

Bases: _ViewResult

New in v14.13.0

Data to be visualized in an TableView.

Example of a simple TableResult:

data = [
    [1.5, "Square"],
    [3.1, "Circle"],
]
TableResult(data)

Example of a simple TableResult with column header titles:

data = [
    [1.5, "Square"],
    [3.1, "Circle"],
]
TableResult(data, column_headers=["Area [m²]", "Shape"])

Example of a more complex TableResult with column and cell styling:

data = [
    [1.5, "Square"],
    [
        TableCell(3.1, text_color=Color.green()),
        TableCell("Circle", background_color=Color(211, 211, 211), text_style='italic')
    ],
]
TableResult(data, column_headers=[
    TableHeader("Area [m²]", num_decimals=2),
    TableHeader("Shape", align='center')
]))

Example of a transposed table:

data = [
    [1.5, "Square"],
    [3.1, "Circle"],
]
transposed_data = [list(i) for i in zip(*data)]
TableResult(
    transposed_data,
    row_headers=[
        TableColumn("Area [m²]", num_decimals=2),
        TableHeader("Area [m²]", num_decimals=2),
        TableHeader("Shape", align='center')
    ],
    column_headers=["Object 1", "Object 2"]
))

Example of a pandas Dataframe object:

df = pandas.DataFrame([[1, 4], [2, 3]])
TableResult(df)

Example of a pandas Styler object:

df = pandas.DataFrame([[1, 4], [2, 3]])
styler = df.style.highlight_min(color="red")
TableResult(styler)

Result to be shown in a TableView.

In case the data is a pandas Styler object, the following properties will be inherited:

  • background_color (per cell)

  • text_color (per cell)

  • text_style (per cell, bold or italic)

  • align (per column/row, only if all cells in a row/column have the same alignment)

Parameters:

  • data (Union[Sequence[Sequence[Union[str, float, int, bool, datetime, date, None, TableCell]]], DataFrame, Styler]) – Table content. Can also be a pandas DataFrame or Styler object.

  • column_headers (Optional[Sequence[Union[str, TableHeader]]]) – Headers shown above the columns. Can be used for custom titles and styling. In case the data is a pandas Styler object, this can be set explicitly to overwrite the generated titles and styling.

  • row_headers (Optional[Sequence[Union[str, TableHeader]]]) – Headers shown next to the rows. Can be used for custom titles and styling. In case the data is a pandas Styler object, this can be set explicitly to overwrite the generated titles and styling.

  • enable_sorting_and_filtering (Optional[bool]) – Enable sorting and filtering on columns. If set to None (default), sorting and filtering will be enabled if each of the columns in data is of homogeneous type, and disabled otherwise. If sorting and filtering is enabled explicitly, each column must be of homogeneous type.

SummaryItem​

class viktor.views.SummaryItem(label, item_type, source, value_path, *, suffix='', prefix='')

A summary consists of SummaryItem objects, that define which input / result values should be displayed.

Suppose we have a data view with a controller method ‘data_view’, which returns a DataItem with key ‘output_item_1’. The following summary item can be constructed to refer to this result:

item_1 = SummaryItem('Label', float, 'data_view', 'output_item_1', suffix='N')

Suppose we have a parametrization with a certain parameter defined as geometry.input.length, this can be converted to a summary item by doing:

item_2 = SummaryItem('Length', float, 'parametrization', 'geometry.input.length', suffix='m')
Parameters:

  • label (str) – Text label of the item.

  • item_type (Type[Union[str, float]]) – Type of value, options are ‘str’ | ‘float’.

  • source (str) – Source from which the input / output should be extracted.

  • value_path (str) – Dotted path of value in parametrization / data structure of view. e.g: level1.level2.value

  • suffix (str) – A prefix will be put behind the value to provide additional information such as units.

  • prefix (str) – A prefix will be put in front of the value to provide info such as a dollar sign.

Summary​

class viktor.views.Summary(**items)

Bases: OrderedDict

Summary of resulting data items, which can be used in the summary view of an entity.

Example usage:

class Controller:
    ...
    summary = Summary(
        item_1=SummaryItem(...),
        item_2=SummaryItem(...),
        item_3=SummaryItem(...)
    )
Parameters:

items (SummaryItem) – Items that are shown in the summary, with a maximum of 6 items per summary.

View​

class viktor.views.View(label, duration_guess, *, description=None, update_label=None, **kwargs)

Bases: ABC

Warning

Do not use this class directly in an application.

Base-class of a function decorator that can be used to specify the desired view to be returned. See the subclasses for specific examples of each type of view.

Parameters:

  • label (str) – Name which is shown on tab in interface. e.g: ‘3D Representation’

  • duration_guess (int) – Estimation of view calculation in seconds. This will be used to add a manual refresh button for long-running tasks (larger than 3s). This estimation does not need to be very precise, but the performance will be better if this is close to the real maximum computation time.

  • description (str) – Show more information to the user through a tooltip on hover (max. 200 characters).

  • update_label (str) – Name which is shown on the update button in case of a slow view (max. 30 characters).

GeometryView​

class viktor.views.GeometryView(label, duration_guess, *, description=None, update_label=None, view_mode='3D', default_shadow=False, up_axis='Z', x_axis_to_right=None)

Bases: View

Function decorator to instruct the controller method to return a geometry view (2D / 3D).

Example usage:

@GeometryView("3D model", duration_guess=2)
def get_geometry_view(self, params, **kwargs):
    ...
    return GeometryResult(...)

@GeometryView("2D model", duration_guess=2, view_mode='2D')
def get_geometry_view_2d(self, params, **kwargs):
    ...
    return GeometryResult(...)

See GeometryResult for example implementations.

Parameters:

  • label (str) – See View.

  • duration_guess (int) – See View.

  • description (str) – See View.

  • update_label (str) – See View.

  • view_mode (Literal['2D', '3D']) –

    Sets the view mode:

    • ’3D’: Camera is free to move and user can choose between orthographic and perspective view.

    • ’2D’: Camera is fixed on the xy-plane and view is orthographic.

  • default_shadow (bool) – Show shadow when editor is opened. User can still switch it off.

  • up_axis (Literal['Y', 'Z']) – (view_mode=’3D’ only) Upwards pointing axis. Possible options: ‘Y’, ‘Z’ (default: ‘Z’)

  • x_axis_to_right (bool) – (view_mode=’3D’ and up_axis=’Y’ only) X-axis pointing to the right in the initial view

    New in v14.8.0

DataView​

class viktor.views.DataView(label, duration_guess, *, description=None, update_label=None, **kwargs)

Bases: View

Function decorator to instruct the controller method to return a data view that contains calculation result.

Example usage:

@DataView("Cost breakdown", duration_guess=2)
def get_data_view(self, params, **kwargs):
    # calculate data
    ...
    return DataResult(data_group)
Parameters:

  • label (str) – Name which is shown on tab in interface. e.g: ‘3D Representation’

  • duration_guess (int) – Estimation of view calculation in seconds. This will be used to add a manual refresh button for long-running tasks (larger than 3s). This estimation does not need to be very precise, but the performance will be better if this is close to the real maximum computation time.

  • description (str) – Show more information to the user through a tooltip on hover (max. 200 characters).

  • update_label (str) – Name which is shown on the update button in case of a slow view (max. 30 characters).

GeometryAndDataView​

class viktor.views.GeometryAndDataView(label, duration_guess, *, description=None, update_label=None, view_mode='3D', default_shadow=False, up_axis='Z', x_axis_to_right=None)

Bases: View

Function decorator to instruct the controller method to return a combined view consisting of geometries and data.

Example usage:

@GeometryAndDataView("Model / Cost", duration_guess=2)
def get_geometry_data_view(self, params, **kwargs):
    ...
    return GeometryAndDataResult(...)
Parameters:

  • label (str) – See View.

  • duration_guess (int) – See View.

  • description (str) – See View.

  • update_label (str) – See View.

  • view_mode (Literal['2D', '3D']) –

    Sets the view mode:

    • ’3D’: Camera is free to move and user can choose between orthographic and perspective view.

    • ’2D’: Camera is fixed on the xy-plane and view is orthographic.

  • default_shadow (bool) – Show shadow when editor is opened. User can still switch it off.

  • up_axis (Literal['Y', 'Z']) – (view_mode=’3D’ only) Upwards pointing axis. Possible options: ‘Y’, ‘Z’ (default: ‘Z’)

  • x_axis_to_right (bool) – (view_mode=’3D’ and up_axis=’Y’ only) X-axis pointing to the right in the initial view

    New in v14.8.0

GeoJSONView​

class viktor.views.GeoJSONView(label, duration_guess, *, description=None, update_label=None, **kwargs)

Bases: View

Function decorator to instruct the controller method to return a GeoJSON (geographic data) view.

Example usage:

@GeoJSONView("Map", duration_guess=2)
def get_geojson_view(self, params, **kwargs):
    ...
    return GeoJSONResult(...)
Parameters:

  • label (str) – Name which is shown on tab in interface. e.g: ‘3D Representation’

  • duration_guess (int) – Estimation of view calculation in seconds. This will be used to add a manual refresh button for long-running tasks (larger than 3s). This estimation does not need to be very precise, but the performance will be better if this is close to the real maximum computation time.

  • description (str) – Show more information to the user through a tooltip on hover (max. 200 characters).

  • update_label (str) – Name which is shown on the update button in case of a slow view (max. 30 characters).

GeoJSONAndDataView​

class viktor.views.GeoJSONAndDataView(label, duration_guess, *, description=None, update_label=None, **kwargs)

Bases: View

Function decorator to instruct the controller method to return a combined view consisting of a GeoJSON and data.

Example usage:

@GeoJSONAndDataView("Map / Data", duration_guess=2)
def get_geojson_data_view(self, params, **kwargs):
    ...
    return GeoJSONAndDataResult(...)
Parameters:

  • label (str) – Name which is shown on tab in interface. e.g: ‘3D Representation’

  • duration_guess (int) – Estimation of view calculation in seconds. This will be used to add a manual refresh button for long-running tasks (larger than 3s). This estimation does not need to be very precise, but the performance will be better if this is close to the real maximum computation time.

  • description (str) – Show more information to the user through a tooltip on hover (max. 200 characters).

  • update_label (str) – Name which is shown on the update button in case of a slow view (max. 30 characters).

MapView​

class viktor.views.MapView(label, duration_guess, *, description=None, update_label=None, **kwargs)

Bases: View

Function decorator to instruct the controller method to return a Map (geographic data) view.

Example usage:

@MapView("Map", duration_guess=2)
def get_map_view(self, params, **kwargs):
    ...
    return MapResult(...)
Parameters:

  • label (str) – Name which is shown on tab in interface. e.g: ‘3D Representation’

  • duration_guess (int) – Estimation of view calculation in seconds. This will be used to add a manual refresh button for long-running tasks (larger than 3s). This estimation does not need to be very precise, but the performance will be better if this is close to the real maximum computation time.

  • description (str) – Show more information to the user through a tooltip on hover (max. 200 characters).

  • update_label (str) – Name which is shown on the update button in case of a slow view (max. 30 characters).

MapAndDataView​

class viktor.views.MapAndDataView(label, duration_guess, *, description=None, update_label=None, **kwargs)

Bases: View

Function decorator to instruct the controller method to return a combined view consisting of a Map and data.

Example usage:

@MapAndDataView("Map / Data", duration_guess=2)
def get_map_data_view(self, params, **kwargs):
    ...
    return MapAndDataResult(...)
Parameters:

  • label (str) – Name which is shown on tab in interface. e.g: ‘3D Representation’

  • duration_guess (int) – Estimation of view calculation in seconds. This will be used to add a manual refresh button for long-running tasks (larger than 3s). This estimation does not need to be very precise, but the performance will be better if this is close to the real maximum computation time.

  • description (str) – Show more information to the user through a tooltip on hover (max. 200 characters).

  • update_label (str) – Name which is shown on the update button in case of a slow view (max. 30 characters).

ImageView​

class viktor.views.ImageView(label, duration_guess, *, description=None, update_label=None, **kwargs)

Bases: View

New in v13.7.0

Function decorator to instruct the controller method to return an ImageView.

Supported image types are ‘svg’, ‘jpeg’, ‘png’, ‘gif’.

Example usage:

@ImageView("Image View", duration_guess=1)
def get_image_view(self, params, **kwargs):
    file_path = Path(__file__).parent / 'sample.png'
    return ImageResult(File.from_path(file_path))  # or `ImageResult.from_path(file_path)`
Parameters:

  • label (str) – Name which is shown on tab in interface. e.g: ‘3D Representation’

  • duration_guess (int) – Estimation of view calculation in seconds. This will be used to add a manual refresh button for long-running tasks (larger than 3s). This estimation does not need to be very precise, but the performance will be better if this is close to the real maximum computation time.

  • description (str) – Show more information to the user through a tooltip on hover (max. 200 characters).

  • update_label (str) – Name which is shown on the update button in case of a slow view (max. 30 characters).

ImageAndDataView​

class viktor.views.ImageAndDataView(label, duration_guess, *, description=None, update_label=None, **kwargs)

Bases: View

New in v13.7.0

Function decorator to instruct the controller method to return a combined view consisting of an image and data.

Supported image types are ‘svg’, ‘jpeg’, ‘png’, ‘gif’.

Example usage:

@ImageAndDataView("Image View", duration_guess=1)
def get_image_data_view(self, params, **kwargs):
    ...
    return ImageAndDataResult(image, data_group)
Parameters:

  • label (str) – Name which is shown on tab in interface. e.g: ‘3D Representation’

  • duration_guess (int) – Estimation of view calculation in seconds. This will be used to add a manual refresh button for long-running tasks (larger than 3s). This estimation does not need to be very precise, but the performance will be better if this is close to the real maximum computation time.

  • description (str) – Show more information to the user through a tooltip on hover (max. 200 characters).

  • update_label (str) – Name which is shown on the update button in case of a slow view (max. 30 characters).

WebView​

class viktor.views.WebView(label, duration_guess, *, description=None, update_label=None, **kwargs)

Bases: View

Function decorator to instruct the controller method to return a web-content view.

Example usage:

@WebView("Hello world", duration_guess=1)
def get_web_view(self, params, **kwargs):
    return WebResult(html="<html>Hello world</html>")
Parameters:

  • label (str) – Name which is shown on tab in interface. e.g: ‘3D Representation’

  • duration_guess (int) – Estimation of view calculation in seconds. This will be used to add a manual refresh button for long-running tasks (larger than 3s). This estimation does not need to be very precise, but the performance will be better if this is close to the real maximum computation time.

  • description (str) – Show more information to the user through a tooltip on hover (max. 200 characters).

  • update_label (str) – Name which is shown on the update button in case of a slow view (max. 30 characters).

WebAndDataView​

class viktor.views.WebAndDataView(label, duration_guess, *, description=None, update_label=None, **kwargs)

Bases: View

Function decorator to instruct the controller method to return a combined view consisting of web-content and data.

Example usage:

@WebAndDataView("Web / Data", duration_guess=1)
def get_web_data_view(self, params, **kwargs):
    # calculate data
    ...
    return WebAndDataResult(html="<html>Hello world</html>", data=data_group)
Parameters:

  • label (str) – Name which is shown on tab in interface. e.g: ‘3D Representation’

  • duration_guess (int) – Estimation of view calculation in seconds. This will be used to add a manual refresh button for long-running tasks (larger than 3s). This estimation does not need to be very precise, but the performance will be better if this is close to the real maximum computation time.

  • description (str) – Show more information to the user through a tooltip on hover (max. 200 characters).

  • update_label (str) – Name which is shown on the update button in case of a slow view (max. 30 characters).

PlotlyView​

class viktor.views.PlotlyView(label, duration_guess, *, description=None, update_label=None, **kwargs)

Bases: View

Function decorator to instruct the controller method to return a PlotlyView.

Example usage:

@PlotlyView("Plotly view", duration_guess=1)
def get_plotly_view(self, params, **kwargs):
    ...
    return PlotlyResult(figure)
Parameters:

  • label (str) – Name which is shown on tab in interface. e.g: ‘3D Representation’

  • duration_guess (int) – Estimation of view calculation in seconds. This will be used to add a manual refresh button for long-running tasks (larger than 3s). This estimation does not need to be very precise, but the performance will be better if this is close to the real maximum computation time.

  • description (str) – Show more information to the user through a tooltip on hover (max. 200 characters).

  • update_label (str) – Name which is shown on the update button in case of a slow view (max. 30 characters).

PlotlyAndDataView​

class viktor.views.PlotlyAndDataView(label, duration_guess, *, description=None, update_label=None, **kwargs)

Bases: View

Function decorator to instruct the controller method to return a combined view consisting of a PlotlyView and a DataView.

Example usage:

@PlotlyAndDataView("Plotly and data view", duration_guess=1)
def get_plotly_and_data_view(self, params, **kwargs):
    ...
    return PlotlyAndDataResult(figure, data_group)
Parameters:

  • label (str) – Name which is shown on tab in interface. e.g: ‘3D Representation’

  • duration_guess (int) – Estimation of view calculation in seconds. This will be used to add a manual refresh button for long-running tasks (larger than 3s). This estimation does not need to be very precise, but the performance will be better if this is close to the real maximum computation time.

  • description (str) – Show more information to the user through a tooltip on hover (max. 200 characters).

  • update_label (str) – Name which is shown on the update button in case of a slow view (max. 30 characters).

PDFView​

class viktor.views.PDFView(label, duration_guess, *, description=None, update_label=None, **kwargs)

Bases: View

Function decorator to instruct the controller method to return a PDFView.

Example usage:

@PDFView("PDF View", duration_guess=1)
def get_pdf_view(self, params, **kwargs):
    file_path = Path(__file__).parent / 'sample.pdf'
    return PDFResult(File.from_path(file_path))  # or `PDFResult.from_path(file_path)`
Parameters:

  • label (str) – Name which is shown on tab in interface. e.g: ‘3D Representation’

  • duration_guess (int) – Estimation of view calculation in seconds. This will be used to add a manual refresh button for long-running tasks (larger than 3s). This estimation does not need to be very precise, but the performance will be better if this is close to the real maximum computation time.

  • description (str) – Show more information to the user through a tooltip on hover (max. 200 characters).

  • update_label (str) – Name which is shown on the update button in case of a slow view (max. 30 characters).

IFCView​

class viktor.views.IFCView(label, duration_guess, *, description=None, update_label=None, **kwargs)

Bases: View

New in v14.6.0

Function decorator to instruct the controller method to return an IFCView.

Example usage:

@IFCView("IFC view", duration_guess=1)
def get_ifc_view(self, params, **kwargs):
    ifc = File.from_path(Path(__file__).parent / 'sample.ifc')
    return IFCResult(ifc)
Parameters:

  • label (str) – Name which is shown on tab in interface. e.g: ‘3D Representation’

  • duration_guess (int) – Estimation of view calculation in seconds. This will be used to add a manual refresh button for long-running tasks (larger than 3s). This estimation does not need to be very precise, but the performance will be better if this is close to the real maximum computation time.

  • description (str) – Show more information to the user through a tooltip on hover (max. 200 characters).

  • update_label (str) – Name which is shown on the update button in case of a slow view (max. 30 characters).

IFCAndDataView​

class viktor.views.IFCAndDataView(label, duration_guess, *, description=None, update_label=None, **kwargs)

Bases: View

New in v14.6.0

Function decorator to instruct the controller method to return a combined view consisting of an IFCView and a DataView.

Example usage:

@IFCAndDataView("IFC and data view", duration_guess=1)
def get_ifc_and_data_view(self, params, **kwargs):
    ifc = File.from_path(Path(__file__).parent / 'sample.ifc')
    data = ...
    return IFCAndDataResult(ifc, data)
Parameters:

  • label (str) – Name which is shown on tab in interface. e.g: ‘3D Representation’

  • duration_guess (int) – Estimation of view calculation in seconds. This will be used to add a manual refresh button for long-running tasks (larger than 3s). This estimation does not need to be very precise, but the performance will be better if this is close to the real maximum computation time.

  • description (str) – Show more information to the user through a tooltip on hover (max. 200 characters).

  • update_label (str) – Name which is shown on the update button in case of a slow view (max. 30 characters).

TableView​

class viktor.views.TableView(label, duration_guess, *, description=None, update_label=None, **kwargs)

Bases: View

New in v14.13.0

Function decorator to instruct the controller method to return an TableView.

Example usage:

@TableView("Table view", duration_guess=1)
def get_table_view(self, params, **kwargs):
    data = [
        [2.5, 7, "Square"],
        [1.5, 8, "Circle"],
    ]
    return TableResult(data, column_headers=["Width", "Height", "Shape"])
Parameters:

  • label (str) – Name which is shown on tab in interface. e.g: ‘3D Representation’

  • duration_guess (int) – Estimation of view calculation in seconds. This will be used to add a manual refresh button for long-running tasks (larger than 3s). This estimation does not need to be very precise, but the performance will be better if this is close to the real maximum computation time.

  • description (str) – Show more information to the user through a tooltip on hover (max. 200 characters).

  • update_label (str) – Name which is shown on the update button in case of a slow view (max. 30 characters).

InteractionEvent​

class viktor.views.InteractionEvent(event_type, value)

Event triggered by the user as a consequence of an viktor.parametrization.Interaction.

Warning

Do not instantiate this class directly, it is returned as ‘event’ in the method of the button with the corresponding interaction.

Parameters:

  • event_type (str) – type of the event (‘map_select’)

  • value (Any) –

    value of the user performed interaction. Type depends on event_type:

    • map_select: List[Union[str, int]] = identifier of selected features