Documents and Panels
Documents¶
Documents in the document manager can be configured so that they are accessible from the ribbon of MIKE OPERATIONS.
Create and configure documents from the General Settings page by clicking on the ‘Documents’ button.
The dialog will display the documents configured.
Click on the ‘New’ button to add a new document to the configuration.
Click on the ‘Details’ button to configure the document.
Item | Description |
---|---|
Active Activate the document by checking this field. |
|
Id Id of the document. The id is used as a reference. |
|
Name Name of the document, which will be shown in the ribbon. |
|
Description Description of the document. The description will be shown as a tool tip when hovering over the ribbon item. |
|
Document Path The path to the document in the Document Explorer in MIKE Workbench. The path can be either a path to a document or a path to a document folder. Specifying a path to a document, will create a ribbon item for opening the document with the associated program in Windows. Specifying a document group, will create a dropdown ribbon item, allowing the user to browse for a document in the specified folder. The document can then be opened using the context menu. |
Browsing and opening a document from the ribbon when configuring a document path. |
Ribbon Page Name The name of the ribbon page where the button of the document is shown. |
|
Group Name Group name, sets the group of the document in the ribbon. |
|
Ribbon Item Type Ribbon item type controls the type of control added to the ribbon. A simple check item for selecting or activating the item A check item added to a gallery of items for selecting or activating the item. A menu item added to a menu. The path of the menu is specified in the Group name field, separating each sub menu entry with a vertical bar ‘|’. E.g. “My Group|Menu button name|First parent menu|Second parent menu”. Images of each menu item can be specified by adding Feature Types for each sub menu. A simple item like “Check Item” without “check mark” functionality for executing or opening the item. A menu item like “Menu Check Item” without “check mark” functionality, for executing or opening the item. The item is not shown in the ribbon. This ribbon item type is used when a feature layer should be always visible on the map. |
|
Resource Image Name Resource images are a list of built in images for ribbon items. Clicking on the dropdown, will display the available images. The selected image will be used where the item is displayed, E.g. in the ribbon, in tooltips and the Table View Images with a ‘_32’ postfix have an initial size of 32x32 pixels. Images without a postfix have a size of 16x16 pixels. The initial size has an impact on the quality of the image when displayed in MIKE OPERATIONS. |
|
Document Image Path Document Image Path is for additional user images placed in the Document Manager in MIKE Workbench. Images specified in this path will overwrite the image specified in the Resource Image Path. |
|
Theme Specify the theme where the web link should be shown. If no theme is specified, the web link is shown on all themes. |
|
Show on Web Check this to display the item in MIKE OPERATIONS Web. |
Summary Views¶
Summary Views allows configuring summarized values of time series of the selected Observation Period.
Summary Views are configured from the General Settings page by clicking on the ‘Summary Views’ button.
The dialog will display configured Summary Views.
Click on the ‘New’ button to add a Summary View to the configuration.
Click on the ‘Details’ button to configure the Summary View.
Item | Description |
---|---|
Active Activate the Summary View by checking this field. |
|
Id Id of the Summary View. The id is used as a reference. |
|
Name Name of the Summary View shown in the ribbon. |
|
Description Description of the Summary View. |
|
Calculation Type Specify the calculation type. Display the sum. Display the minimum value. Display the maximum value. Display the average value. |
|
Time Unit The Time Unit of the Value Intervals used for calculation. |
|
Value Intervals The period intervals for the calculations. The periods are separated by a semi colon. The date time the intervals are calculated from depend on the observation period type: Time of Forecast of the selected simulation. The selected reference date. The start date of the observation period. The start date of the observation period. |
|
Observation Time Series Select the observation time series definition to use for the calculation. |
|
Forecast Time Series Select the forecast time series to use for the calculation. |
|
Ribbon Page Name The name of the ribbon page where the button of the summary view is shown. |
|
Group Name Group name sets the group of the summary view in the ribbon. |
|
Ribbon Item Type Ribbon item type controls the type of control added to the ribbon. A simple check item A check item added to a gallery of items. A menu item added to a menu. The path of the menu is specified in the Group name field, separating each sub menu entry with a vertical bar ‘|’. E.g. “My Group|Menu button name|First parent menu|Second parent menu”. Images of each menu item can be specified by adding Feature Types for each sub menu. A simple item like “Check Item” without “check mark” functionality. A menu item like “Menu Check Item” without “check mark” functionality. The script is not shown in the ribbon. |
|
Resource Image Name Resource images are a list of built in images for summary views. Clicking on the dropdown, will display the available images. The selected image will be used where the feature type is displayed, E.g. in the ribbon, in tooltips and the Table View. Images with a ‘_32’ postfix have an initial size of 32x32 pixels. Images without a postfix have a size of 16x16 pixels. The initial size has an impact on the quality of the image when displayed in MIKE OPERATIONS. |
|
Document Image Path Document Image Path is for additional user images placed in the Document Manager in MIKE Workbench. Images specified in this path will overwrite the image specified in the Resource Image Path. |
|
Theme Specify the theme where the summary view should be shown. If no theme is specified, the summary view is shown on all themes. |
|
Show on Web Check this to display the item on MIKE OPERATIONS Web |
Chart Panels¶
A panel constantly showing a pre-set group of plots/charts may be configured in MIKE OPERATIONS. This adds an additional customizable Chart View to the Home page, which may be shown or hidden through the menu.
Chart Panels allows configuring user defined charts with multiple chart areas. Time series Data will show the data of the selected observation period.
Configure Chart Panels from the General Settings page by clicking on the ‘Chart Panels’ button. A list of available Chart Panel configurations is shown.
Click on the ‘New’ button to add a Chart Panel configuration.
Click on the ‘Details’ button to configure properties for the Chart Panel.
Item | Description |
---|---|
Active Activate the Chart Panel by checking this field. |
|
Id Id of the Chart Panel. The id is used as reference. |
|
Name Name of the Chart Panel, shown in the ribbon. |
|
Description Description of the Chart Panel. The description will be shown as a tool tip when hovering the button in the ribbon. |
|
Ribbon Page Name The name of the ribbon page where the button of the Chart Panel is shown. |
|
Group Name Group name sets the group of the Chart Panel in the ribbon. |
|
Ribbon Item Type Ribbon item type controls the type of control added to the ribbon. A simply check item A check item added to a gallery of items. A menu item added to a menu. The path of the menu is specified in the Group name field, separating each sub menu entry with a vertical bar ‘|’. E.g. “My Group|Menu button name|First parent menu|Second parent menu”. Images of each menu item can be specified by adding Feature Types for each sub menu. A simple item like “Check Item” without “check mark” functionality. A menu item like “Menu Check Item” without “check mark” functionality. The script is not shown in the ribbon. |
|
Resource Image Name Resource images are a list of built in images for chart panels. Clicking the dropdown will display the available images. The selected image will be used where the feature type is displayed, E.g. in the ribbon, in tooltips and the Table View Images with a ‘_32’ postfix have an initial size of 32x32 pixels. Images without a postfix have a size of 16x16 pixels. The initial size has an impact on the quality of the image when displayed in MIKE OPERATIONS. |
|
Document Image Path Document Image Path is for additional user images placed in the Document Manager in MIKE Workbench. Images specified in this path will overwrite the image specified in the Resource Image Path. |
|
Theme Specify the theme where the summary view should be shown. If no theme is specified, the summary view is shown on all themes. |
|
Show on Web Check this to display the item on MIKE OPERATIONS Web. |
Time Series¶
Click on the ‘Time Series’ button to configure the time series for the Chart Panel.
Add new time series by clicking on the “New” button.
Click on the ‘Details’ button of the Time Series Setup dialog to configure the Time Series.
Item | Description |
---|---|
Active The Active checkbox is used to enable or disable the time series. Disabling a time series will hide the time series in Charts and Tables. |
|
Id and Name Give the time series an id and a name. Id is used as reference in spreadsheets. The name is used as display name in MIKE OPERATIONS. |
|
Description Description is optional and can contain more lines of text. Description is only for additional information about the time series and will not be display elsewhere. |
|
Themes Specify the theme where the time series is visible. If no theme is selected, the time series is displayed on all themes. |
|
Time Series Path Full path to the time series in the time series manager. The path supports placeholders. This means that selected themes and observation periods can be part of the path to the time series. Use e.g. [ObservationPeriod.Name] to insert the name in the path before fetching the time series. Refer a the section about placeholders for information about available placeholders. |
|
Chart Type The type of the chart in the Chart View. |
|
Color Color is the color of the line or bars (for step accumulated time series) of the time series. |
|
Line Style Line Style is the line style of the time series in the Chart View. |
|
Marker Style The style of the point marker in the Chart View. |
|
Size Size is the line thickness of lines or marker in the Chart View. |
|
Marker Color Style Configure the marker color style. The marker will have the same color as the line. The marker will have the color as the threshold at the time where the marker is placed on the chart. The marker will have a fixed color defined in the “Custom Marker Color” property. |
|
Custom Marker Color Color of the marker when “Custom Marker Color” is selected in “Marker Color Style”. |
|
Chart Area Index The chart area index, defines in what chart area the time series should be displayed. The index will not define the order of the chart areas, as the order is defined by the order of the time series in the list of time series. |
|
Show Vertical Lines Shows vertical lines in the chart for every x-value. The marker color defines the color of the vertical line. Vertical lines are applied when there is only one time series in the chart area. |
|
Use X-Axis Point Labels X-axis labels and a fixed x-axis grid are shown for every x-value of the time series. Additional label lines are added if comments have been specified on the time steps. To have more label lines, the comment of the time step should be separated by a semicolon. Note that vertical lines are applied when there is only one time series in the chart area. |
|
Ensemble¶
Click the Ensemble group to configure how to display ensemble time series for the time series type.
Ensemble time series are defined as time series with more than one member.
Item | Description |
---|---|
Ensemble Extraction Mode Time series will be extracted according to the ‘Ensemble Extraction Mode’. The following modes are supported: |
|
Member selection Comma separated list of members to include in the selection (e.g. ‘1,2,6’). Member selection is only used in mode ‘Extract selection’. |
|
Probability Sets the probability for the quantile statistics option. Probability is a comma separated string with the quantile percent values (e.g. ‘10,25,90’). Percent values must use decimal points. Probability is used for EnsembleExtractionMode = Quantile only. |
|
Exceedance Constant Sets the Exceedance Constant value option. Exceedance Constant is used for Extraction Mode = “Exceedance” and “Non exceedance”. |
Custom data¶
Additional information about stations can be specified. This is done by making custom data types.
Create new custom data types by clicking on the ’New’ button.
Clicking on the ‘Details’ button brings up the Details view of the custom data type.
Item | Description |
---|---|
Active Activate the custom data type by checking this field. |
|
Id Id of the custom data type. The id is used as a reference. |
|
Name Name of the custom data type column. |
|
Description Description of the custom data type. |
|
Parent Type Optional parent custom data type. If a parent custom data type is specified, the custom data type will be shown on the parent custom data type and not in the root. |
Columns¶
Columns of a custom data type is configured by clicking on the “Columns” button of the custom data type.
Create new columns on a custom data type by clicking on the ‘New’ button.
To configure the column, click on the ’Details’ button of the column.
Item | Description |
---|---|
Active Activate the column by checking this field. |
|
Id Id of the column. The id is used as a reference. |
|
Name Name of the custom data column. |
|
Description Description of the column. |
|
Column Type The type of the custom data column. A custom data column can have the following types: A simple string field. A note field is a string filed with more lines. A double value. An integer field. Enum values are specified in the Enum Values field separated by a semicolon. A date field. A time field. An URl shown as a field with a link to web page. A Boolean field shown as a check box. A color field, shown as a field with a color picker control. A calculated expression. The expression is specified in the Expression filed. A link to a spreadsheet. The spreadsheet can be selected and opened. A link to a document. The documents can be selected and opened using an associated program. |
|
Enum Values For columns of type Enum, the Enum values must be specified. Possible values are separated by a semicolon. |
|
Expression Expressions are C# expressions. The expression must return a single object (double, int, bool, string). Columns as placeholders are supported. Use [ColumnName]. The [Parent] placeholder can be used for specifying that a Column placeholder should be taken from the Parent custom data type. Some samples: [MyDoubleColumn]*3 + [MyIntColumn] “[MyStringColumn]” == “Test” ? “Testing” : “Not Testing” [MyIntColumn] > 5 ? “Large value” : “Small value” [Parent.MyCountryColumn] == “Denmark” ? true : false If any placeholder value (column value) is NULL, the expression is not evaluated. If the evaluation fails due to errors, an error message is shown in the field. |
|
Row selection Select if the column should be shown in the ‘Navigation Panel’. Row selection is only supported for column types: integer, double, date and time. The columns will not be shown. The custom data row with the minimum value will be shown. The custom data row with the maximum value will be shown. |
|
Value column Select the column to be displayed instead of the actual column. |