permalinkEmbed a graph in a Workshop module

Graphs, graph templates, and diagrams can be embedded in Workshop modules.

Graph templates can also be passed parameter values directly from Workshop variables.

There are three main steps to embed a template in a Workshop module:

1. Add a Vertex graph widget in Workshop
2. Choose a resource
3. Configure the widget

permalinkAdd a Vertex graph widget in Workshop

In a section of your choice in the Workshop module, click the + icon or the +Add widget button to open the widget menu, and search for the Vertex Graph widget.

permalinkChoose a resource

In the widget editor, choose the graph, graph template or diagram resource you want to embed by clicking Select. Only compatible resources will show in the resource selector.

permalinkConfigure the widget

For the Vertex graph widget, the core configuration options are the following:

• Input
  • Resource
    • Static: When this resource mode is selected, a single input resource is chosen using a resource picker. If the chosen resource is a graph template, an optional Override graph RID can be provided. If provided, this graph will be displayed instead of the default behavior of generating a graph using the template and its parameters. This allows, for example, loading an existing graph from an RID saved in a property on an object.
    • Variable: When this resource mode is selected, the input resource is provided by a string variable which should contain a graph, graph pointer or graph template RID.
  • Parameters: When embedding a graph template, supply values for template parameters using Workshop variables.
  • Sub-graph: When embedding a graph or diagram resource with multiple sub-graphs, you can choose which sub-graph to display by selecting an object set variable from Workshop that contains any object from that sub-graph.
  • Refresh key: Whenever this variable's value changes, the widget will perform a complete reload of the graph.
  • Load data from scenario: Enable this toggle to load the given resource using a scenario instead of the base Ontology.
  • Regenerate graph after applying scenario: When set, the graph will be refreshed after each scenario modification.
• Interaction
  • Selected objects: This option outputs an object set of the currently selected object(s). This object set can the be used in downstream widgets within the current module.
  • On selected objects change: Configure Workshop events to trigger when the selected objects on the graphs change (for example, the trigger could open a drawer with a more detailed view of the selected objects).
  • Zoom to object set: Sets the viewport to display the objects in the given object set whenever the inputs change.
• Time configuration
  • Selected time: When enabled, this setting controls the selected time on the graph using a Workshop variable of type Timestamp or Date.
  • Time window: When enabled, this setting controls the time window used on the graph, using two Workshop variables of type Timestamp or Date.
• Capabilities
  • Read-only mode: Turning on read-only mode removes editing capabilities and hides the toolbar. Learn more about read-only mode.
  • Enable transition to Vertex Application: Enable to display a button allowing users to open the Vertex Application with their current state.
  • Enable export as PNG Enable to allow exporting the current graph as a PNG for users with frontend export permissions on the embedded resource.
  • Saving settings Enable to allow the user to save the current graph.
    • When the embedded resource is a graph template, saving will create a new graph.
      • This graph will be given the name specified by Default resource name and be placed in the folder given by Default folder. If Show resource dialog is enabled, the user will be prompted to pick a resource name and location, with the configured name and folder being shown as a starting point in the resource dialog.
      • If a graph is successfully created, the events and/or ontology Action defined in On create new graph will be triggered. Only the the initial save that created the graph will trigger this Action, not subsequent saves. If you wish to use the created graph RID as an input to an Action parameter, use the special Saved graph RID option in the parameter input picker. All required parameters must be configured with a defined default value since an Action form will not be shown to the user.
    • When the embedded resource is a graph, saving will simply update the embedded graph resource, rather than create a new resource.
• Interface
  • Legends/objects panel: When enabled, this toggle will display the layers, objects, and current selection on the left.
  • Time selection panel: When enabled, this toggle will display the time scrubber on the right.
  • Series panel: When enabled, this toggle will display the series panel on the bottom.
  • Incomplete inputs message When a graph template cannot run due to missing required inputs, this message is displayed to the user in a dialog.