Components that open other components based on user interaction, such as the System Tree or Context List, allow for the location of new windows to be defined programmatically using the Component Location property. The Web UI Special Referenceweb/redirect(...) also accepts a Component Location parameter to control the location of a dashboard opened from a redirect.
The helper functions Create Component Location for Grid, Create Component Location for Absolute, and Create Component Location for Dockable from the Utilities Context can be used to conveniently create a properly formatted data table for the Component Location variable.
The Path parameter indicates in which container the component should be opened, and parameters for Absolute, Grid, and Dockable layouts determine the location and size of the component when it is opened.
Variable Name:
componentLocation
Records:
1
Permissions:
Readable at Observer permission level, writable at Manager permission level
String indicating the path to a target dashboard or container. Uses the caret symbol “^” for navigating to parent dashboards, in the case of subdashboards. Similar to context paths, except the path is composed of dashboard components rather than contexts.
Default value is Null, indicating that component location will not be used.
An empty string "" will always refer to the root dashboard.
Usage
A single caret ^ indicates the root of the current dashboard. That is, the dashboard where the component generation is initiated.
A single caret and one or more component names ^.container0.container1 indicates a container located in the current dashboard.
Each caret after the first indicates moving from the current dashboard to the parent dashboard, in the case where the current dashboard is a subdashboard rendered in a parent dashboard. For example, suppose a parent dashboard has a subdashboard component and a component “sidebar0”, and the current dashboard is the subdashboard . Use ^.^.sidebar0 in order to move up to the parent dashboard and create the new component in the “sidebar0” component.
For multiple nested sub dashboards, use multiple carets, e.g. ^.^.^.^.<target component>.
grid
Data Table
Row. The grid row in which to create the top right corner of the component.
Column. The grid column in which to create the top right corner of the component.
Row Span. The number of grid rows for the component to span, analogous to width.
Column Span. Number of columns for the component to span, analogous to height.
absolute
Data Table
X. The X coordinate, in pixels, where the top right corner of the component will be created
Y. The Y coordinate, in pixels, where the top right corner of the component will be created
Width. Component width in pixels.
Height. Component height in pixels.
Z Index. Controls the visual ordering of components in the case that components overlap. A component with a higher Z Index will obscure components with a lower Z Index.
dockable
Data Table
X. The X coordinate, in pixels, where the top right corner of the component will be created in the case of a floating window.
Y. The Y coordinate, in pixels, where the top right corner of the component will be created in the case of a floating window.
Width. Component width in pixels in the case of a floating window.
Height. Component height in pixels in the case of a floating window.
Position.Controls whether the component will be created by splitting the dock with the component indicated by the Path, as a tab in the component indicated by the Path, or as a floating window. Options are as follows.
Left, Right, Top, Bottom - Indicate that the component will split the space occupied by the component indicated by Path.
Tab - Create the component as a tab in the indicated component.
Floating - Create the component as a floating window.
Position Attribute. Applied when Position is selected as one of Left, Right, Top, or Bottom. The component can be created as Inner, in which case the the component will split the area currently in use by the component defined by Path. Otherwise, Outer will create the new component and split the container in which it’s being created.
Tab Position. Indicates where the tabs will be located if Position is selected as tab. Can be one of Left, Right, Top, or Bottom.
Target Id. Indicates the name of the existing component where the new component should be created, if Position indicates a split.
Tab Index. Indicates where in the list of tabs the component should be created if Position is set to tab. Leaving this value blank will result in the component being created as the last tab.
Preferred Width. Indicates the desired width of the new component when split into another component or a dashboard.
Preferred Height. Indicates the desired height of the new component when split into another component or a dashboard.
Minimum Width. Indicates the minimum width of the new component when split into another component or a dashboard. Overridden when the viewscreen does not have sufficient space for the minimum width.
Minimum Height. Indicates the minimum height of the new component when split into another component or a dashboard. Overridden when the viewscreen does not have sufficient space for the minimum height.
Movable. Boolean indicating that the new component can be moved.
Closable. Boolean indicating that the new component can be closed.
Resizable. Boolean indicating that the new component can be resized.
Collapsible. Boolean indicating that the new component can be collapsed.
Maximizable. Boolean indicating that the new component can be maximized.
Floatable. Boolean indicating that the new component can be set to be a floating window.
Collapsed. Boolean indicating that the new component will be created collapsed.
Show Header. Boolean indicating that the header should be displayed.
