Connector pane - Revision history

Logmanoriginal: /* Index of Terminals */ Use Template:ConnectorPane

2025-01-04T12:04:01Z

Index of Terminals: Use Template:ConnectorPane

← Older revision		Revision as of 12:04, 4 January 2025
Line 42:		Line 42:
	When using [[VI Scripting]] to access a Connector Pane (for example: [[ConnectorPane class/Controls() property\|ConnectorPane class/Controls[] property]]), the terminals by defaultare ordered from Right to Left, Bottom to Top. This changes if the pattern is rotated or flipped. Therefore, for a standard 4x2x2x4 pattern the terminals are indexed as follows:		When using [[VI Scripting]] to access a Connector Pane (for example: [[ConnectorPane class/Controls() property\|ConnectorPane class/Controls[] property]]), the terminals by defaultare ordered from Right to Left, Bottom to Top. This changes if the pattern is rotated or flipped. Therefore, for a standard 4x2x2x4 pattern the terminals are indexed as follows:

	~~[[File:4x2x2x4-Default.png~~\|~~Default~~ 4x2x2x4]]		{{ConnectorPane\|pattern=4x2x2x4}}

	To see other patterns, see [[Connector pane patterns\|Connector Pane Patterns]].		To see other patterns, see [[Connector pane patterns\|Connector Pane Patterns]].

Thoric: typo fix

2024-05-29T14:50:27Z

typo fix

← Older revision		Revision as of 14:50, 29 May 2024
Line 32:		Line 32:
	* '''Disconnet This Terminal''' - to disconnect just the terminal that was clicked on		* '''Disconnet This Terminal''' - to disconnect just the terminal that was clicked on

	== ~~Requierment~~ Level ==		== Requirement Level ==
	Right-clicking a terminal and selection '''This Connection Is''' presents four different options. The terminals can be set to:		Right-clicking a terminal and selection '''This Connection Is''' presents four different options. The terminals can be set to:
	# '''Required''' - sets the input as required. If the input is not wired, the program will not run, see [[Broken Run Arrow]].		# '''Required''' - sets the input as required. If the input is not wired, the program will not run, see [[Broken Run Arrow]].

Q: /* Index of Terminals */

2021-10-06T16:33:21Z

Index of Terminals

← Older revision		Revision as of 16:33, 6 October 2021
Line 44:		Line 44:
	[[File:4x2x2x4-Default.png\|Default 4x2x2x4]]		[[File:4x2x2x4-Default.png\|Default 4x2x2x4]]

	To see ~~the~~ other patterns ~~and orientations~~, ~~find the ''~~Connector Pane ~~Pattern Reference.vi'' located in the [[NI Example Finder~~]].		To see other patterns, see [[Connector pane patterns\|Connector Pane Patterns]].

	== Best Practices ==		== Best Practices ==

Q: /* Index of Terminals */

2020-11-27T00:46:36Z

Index of Terminals

← Older revision		Revision as of 00:46, 27 November 2020
Line 40:		Line 40:

	== Index of Terminals ==		== Index of Terminals ==
	When using [[VI Scripting]] to access a Connector Pane (for example: [[ConnectorPane class/Controls() property\|ConnectorPane class/Controls[] property]]), the terminals by defaultare ordered from Right to Left, Bottom to Top. This changes if the ~~patter~~ is rotated or flipped. Therefore, for a standard 4x2x2x4 pattern the terminals are indexed as follows:		When using [[VI Scripting]] to access a Connector Pane (for example: [[ConnectorPane class/Controls() property\|ConnectorPane class/Controls[] property]]), the terminals by defaultare ordered from Right to Left, Bottom to Top. This changes if the pattern is rotated or flipped. Therefore, for a standard 4x2x2x4 pattern the terminals are indexed as follows:

	[[File:4x2x2x4-Default.png\|Default 4x2x2x4]]		[[File:4x2x2x4-Default.png\|Default 4x2x2x4]]

Q: Added more detail in the History for changes in LabVIEW 2011

2020-05-19T18:15:11Z

Added more detail in the History for changes in LabVIEW 2011

← Older revision		Revision as of 18:15, 19 May 2020
Line 65:		Line 65:
	\|[[File:LV8-2013.png\|frameless\|border\|64x64px\|LabVIEW 2011\|link=LabVIEW 2011]]		\|[[File:LV8-2013.png\|frameless\|border\|64x64px\|LabVIEW 2011\|link=LabVIEW 2011]]
	\|In [[LabVIEW 2011]] the Connector Pane was changed to always be visible on the [[Front Panel]] window next to the [[VI Icon]]. [[LabVIEW 2010]] and earlier only the Connector Pane or the [[VI Icon]] was visible at a time and they were toggled between via a right-click menu ('''Show Connector''' or '''Show Icon''').		\|In [[LabVIEW 2011]] the Connector Pane was changed to always be visible on the [[Front Panel]] window next to the [[VI Icon]]. [[LabVIEW 2010]] and earlier only the Connector Pane or the [[VI Icon]] was visible at a time and they were toggled between via a right-click menu ('''Show Connector''' or '''Show Icon''').

			Also, previously to [[LabVIEW 2011]], when creating a SubVI from a selection, the SubVI would be created with a varying pattern with just the number of inputs or outputs needed. In [[LabVIEW 2011]] and later, the new SubVI will default to the 4x2x2x4 pattern, if the input/output count fits, and the errors will default to the bottom corners.
	\|}		\|}

Q at 13:28, 13 May 2020

2020-05-13T13:28:39Z

← Older revision		Revision as of 13:28, 13 May 2020
Line 14:		Line 14:
	Right-clicking the Connector Pane and selecting '''Add Terminal''' or '''Remove Terminal''' effectively moves the pattern up or down one.		Right-clicking the Connector Pane and selecting '''Add Terminal''' or '''Remove Terminal''' effectively moves the pattern up or down one.

	=== ~~Rotate 90 Degrees, Flip Horizontal, Flip Vertical~~ ===		=== Changing Orientation ===
	Right-clicking the Connector Pane and selecting '''Rotate 90 Degrees''', '''Flip Horizontal''', or '''Flip Vertical''' keeps the same pattern but changes the orientation.		Right-clicking the Connector Pane and selecting '''Rotate 90 Degrees''', '''Flip Horizontal''', or '''Flip Vertical''' keeps the same pattern but changes the orientation.

Q: /* Terminal Organization */ Updated link to point to Method (object-oriented programming)

2020-05-13T11:14:02Z

Terminal Organization: Updated link to point to Method (object-oriented programming)

← Older revision		Revision as of 11:14, 13 May 2020
Line 52:		Line 52:
	* Put inputs on the left side of the Connector Pane and outputs on the right.		* Put inputs on the left side of the Connector Pane and outputs on the right.
	* Use the bottom corners for ''[[Error Cluster data type\|error in]]'' and ''[[Error Cluster data type\|error out]]''.		* Use the bottom corners for ''[[Error Cluster data type\|error in]]'' and ''[[Error Cluster data type\|error out]]''.
	* If the [[VI]] is a [[Method\|method]] in a [[Class (object-oriented programming)\|class]], use the top corners as the class object input and output.		* If the [[VI]] is a [[Method (object-oriented programming)\|method]] in a [[Class (object-oriented programming)\|class]], use the top corners as the class object input and output.

	=== Require by Default ===		=== Require by Default ===

Q: Typo

2020-05-12T19:27:37Z

Typo

← Older revision		Revision as of 19:27, 12 May 2020
Line 64:		Line 64:
	\|-		\|-
	\|[[File:LV8-2013.png\|frameless\|border\|64x64px\|LabVIEW 2011\|link=LabVIEW 2011]]		\|[[File:LV8-2013.png\|frameless\|border\|64x64px\|LabVIEW 2011\|link=LabVIEW 2011]]
	\|In [[LabVIEW 2011]] the Connector Pane was changed to always be visible on the [[Front Panel]] window next to the [[VI Icon]]. [[LabVIEW 2010]] and earlier only the Connector Pane or the [[VI Icon]] was visible at a time and they were ~~googled~~ between via a right-click menu ('''Show Connector''' or '''Show Icon''').		\|In [[LabVIEW 2011]] the Connector Pane was changed to always be visible on the [[Front Panel]] window next to the [[VI Icon]]. [[LabVIEW 2010]] and earlier only the Connector Pane or the [[VI Icon]] was visible at a time and they were toggled between via a right-click menu ('''Show Connector''' or '''Show Icon''').
	\|}		\|}

Q: Added details

2020-05-12T19:26:03Z

Added details

← Older revision		Revision as of 19:26, 12 May 2020
Line 1:		Line 1:
	~~{{underconstruction}}~~
	{{TOCright}}		{{TOCright}}
	The '''Connector Pane''' is used to pass data to and from a [[SubVI]]. The Connector Pane is available in the [[Front Panel]] window's upper right corner next to the [[VI Icon]].		The '''Connector Pane''' is used to pass data to and from a [[SubVI]]. The Connector Pane is available in the [[Front Panel]] window's upper right corner next to the [[VI Icon]].

	== Patterns ==		== Patterns ==
	Right-click on the Connector Pane ~~and~~ choose a pattern ~~for you subVI's connector pane~~.		Right-click on the Connector Pane to choose a pattern.

	[[Image:Connector Pane Patterns.png\|thumb\|center\|300px\|How to select a connector pane pattern]]		[[Image:Connector Pane Patterns.png\|thumb\|center\|300px\|How to select a connector pane pattern]]

	It is considered good practice to choose a pattern that has more inputs/outputs than you need when writing the VI so that new inputs or outputs can be added without changing the connector pane and causing the VI's that link to your subVI to recompile.		It is considered good practice to choose a pattern that has more inputs/outputs than you need when writing the VI so that new inputs or outputs can be added without changing the connector pane and causing the VI's that link to your subVI to recompile. The 4x2x2x4 pattern highlighted above is the most commonly used for NI primitives. In [[LabVIEW 8]] and above the connector pane is defaulted to the 4x2x2x4 pattern. To customize the default connector pane used for new VIs, set the defaultConPane variable in your [[LabVIEW configuration file]] (see [[LabVIEW configuration file/Miscellaneous#defaultConPane\|Miscellaneous>defaultConPane]]).

	~~The 4x2x2x4 pattern highlighted above is the most commonly used for NI primitives. In~~ [[~~LabVIEW 8~~]] ~~and above the connector pane is defaulted to the 4x2x2x4 pattern.~~		[[Image:ConPane.png\|center\|Connector pane values]]

	~~To customize~~ the ~~default connector pane used for new VIs, set~~ the ~~defaultConPane variable in your [[LabVIEW configuration file]] (see [[LabVIEW configuration file/Miscellaneous#defaultConPane\|Miscellaneous>defaultConPane]])~~.		=== Increase/Decrease Terminals ===
			Right-clicking the Connector Pane and selecting '''Add Terminal''' or '''Remove Terminal''' effectively moves the pattern up or down one.

	~~[[Image:ConPane~~.~~png\|center\|Connector pane values]]~~		=== Rotate 90 Degrees, Flip Horizontal, Flip Vertical ===
			Right-clicking the Connector Pane and selecting '''Rotate 90 Degrees''', '''Flip Horizontal''', or '''Flip Vertical''' keeps the same pattern but changes the orientation.

	== Connecting Controls and Indicators ==		== Connecting Controls and Indicators ==
			To connect a control or an indicator to a terminal on the Connector Pane:
			# Select the control or indicator
			# Click on the desired terminal on the Connector Pane

	== Switching Terminal Positions ==		== Switching Terminal Positions ==
			To switch or move a control or indicator to a different terminal:
			# Click on the terminal to move on the Connector Pane
			# Hold-down ''Ctrl'' and click on a different terminal. This will switch the two terminals, whether connected to something or empty.

			== Disconnecting a Terminal ==
			Right-click on the Connector Pane and select either:
			* '''Disconnect All Terminals''' - to disconnect all terminals
			* '''Disconnet This Terminal''' - to disconnect just the terminal that was clicked on

			== Requierment Level ==
			Right-clicking a terminal and selection '''This Connection Is''' presents four different options. The terminals can be set to:
			# '''Required''' - sets the input as required. If the input is not wired, the program will not run, see [[Broken Run Arrow]].
			# '''Recommended''' - sets the input as recommended. If the input is not wired, the program will still run and the default value for control is used.
			# '''Optional''' - sets the input as optional which is the same as recommended but the terminal will not appear in the [[Context Help]].
			# '''Dynamic Dispatch Input (Required)''' or '''Dynamic Dispatch Output (Recommended)''' - Greyed out except for [[Class (object-oriented programming)\|class]] inputs and outputs. Sets the [[VI]] as [[Dynamic dispatch]].

			== Index of Terminals ==
			When using [[VI Scripting]] to access a Connector Pane (for example: [[ConnectorPane class/Controls() property\|ConnectorPane class/Controls[] property]]), the terminals by defaultare ordered from Right to Left, Bottom to Top. This changes if the patter is rotated or flipped. Therefore, for a standard 4x2x2x4 pattern the terminals are indexed as follows:

			[[File:4x2x2x4-Default.png\|Default 4x2x2x4]]

			To see the other patterns and orientations, find the ''Connector Pane Pattern Reference.vi'' located in the [[NI Example Finder]].

	== Best Practices ==		== Best Practices ==

	== ~~See Also~~ ==		=== Terminal Organization ===
			* Use the 4x2x2x4 pattern even if it leaves empty spaces. Only go to patterns with more terminals if necessary. However, before switching to more terminals, consider [[Bundle\|bundling]] inputs or outputs into [[Cluster data type\|Clusters]].
			* Put inputs on the left side of the Connector Pane and outputs on the right.
			* Use the bottom corners for ''[[Error Cluster data type\|error in]]'' and ''[[Error Cluster data type\|error out]]''.
			* If the [[VI]] is a [[Method\|method]] in a [[Class (object-oriented programming)\|class]], use the top corners as the class object input and output.

			=== Require by Default ===
			* Turn the flag in the [[Options dialog]] on which will require all inputs by default, except the ''error in''. This makes it so inputs to [[SubVI]]s don't get accidentally forgotten.

	== History ==		== History ==
Line 35:		Line 66:
	\|In [[LabVIEW 2011]] the Connector Pane was changed to always be visible on the [[Front Panel]] window next to the [[VI Icon]]. [[LabVIEW 2010]] and earlier only the Connector Pane or the [[VI Icon]] was visible at a time and they were googled between via a right-click menu ('''Show Connector''' or '''Show Icon''').		\|In [[LabVIEW 2011]] the Connector Pane was changed to always be visible on the [[Front Panel]] window next to the [[VI Icon]]. [[LabVIEW 2010]] and earlier only the Connector Pane or the [[VI Icon]] was visible at a time and they were googled between via a right-click menu ('''Show Connector''' or '''Show Icon''').
	\|}		\|}

			== See Also ==
			* [[Front Panel]]
			* [[Block Diagram]]
			* [[VI Icon]]

	[[Category:Calling a VI]]		[[Category:Calling a VI]]
	[[Category:Connector Pane]]		[[Category:Connector Pane]]

Q: Added details

2020-05-12T16:06:42Z

Added details

← Older revision		Revision as of 16:06, 12 May 2020
Line 1:		Line 1:
	== Connector ~~Panes ==~~		{{underconstruction}}
			{{TOCright}}
			The '''Connector Pane''' is used to pass data to and from a [[SubVI]]. The Connector Pane is available in the [[Front Panel]] window's upper right corner next to the [[VI Icon]].

	Connector panes are used in subVI's to pass parameters to and from the subVI. The connector pane is selected by right clicking on the VI icon in the upper right hand corner of your VI, then choosing the '''Show Connector''' menu item.		== Patterns ==
			Right-click on the Connector Pane and choose a pattern for you subVI's connector pane.
	~~[[Image:Show connector selection.png\|thumb\|center\|300px\|How to view the connector pane in a VI]]~~

	Right-click ~~again~~ on the ~~VI icon~~ and choose a pattern for you subVI's connector pane.

	[[Image:Connector Pane Patterns.png\|thumb\|center\|300px\|How to select a connector pane pattern]]		[[Image:Connector Pane Patterns.png\|thumb\|center\|300px\|How to select a connector pane pattern]]
Line 11:		Line 10:
	It is considered good practice to choose a pattern that has more inputs/outputs than you need when writing the VI so that new inputs or outputs can be added without changing the connector pane and causing the VI's that link to your subVI to recompile.		It is considered good practice to choose a pattern that has more inputs/outputs than you need when writing the VI so that new inputs or outputs can be added without changing the connector pane and causing the VI's that link to your subVI to recompile.

	The 4x2x2x4 pattern highlighted above is the most commonly used for NI primitives. In ~~LabView~~ 8 and above the connector pane is defaulted to the 4x2x2x4 pattern.		The 4x2x2x4 pattern highlighted above is the most commonly used for NI primitives. In [[LabVIEW 8]] and above the connector pane is defaulted to the 4x2x2x4 pattern.

	To customize the default connector pane used for new VIs, set the defaultConPane variable in your [[LabVIEW configuration file]] (see [[LabVIEW configuration file/Miscellaneous#defaultConPane\|Miscellaneous>defaultConPane]]).		To customize the default connector pane used for new VIs, set the defaultConPane variable in your [[LabVIEW configuration file]] (see [[LabVIEW configuration file/Miscellaneous#defaultConPane\|Miscellaneous>defaultConPane]]).

	[[Image:ConPane.png\|center\|Connector pane values]]		[[Image:ConPane.png\|center\|Connector pane values]]

			== Connecting Controls and Indicators ==

			== Switching Terminal Positions ==

			== Best Practices ==

			== See Also ==



			== History ==

			{\| class="wikitable"
			! Version
			! Change(s)
			\|-
			\|[[File:LV8-2013.png\|frameless\|border\|64x64px\|LabVIEW 2011\|link=LabVIEW 2011]]
			\|In [[LabVIEW 2011]] the Connector Pane was changed to always be visible on the [[Front Panel]] window next to the [[VI Icon]]. [[LabVIEW 2010]] and earlier only the Connector Pane or the [[VI Icon]] was visible at a time and they were googled between via a right-click menu ('''Show Connector''' or '''Show Icon''').
			\|}

	[[Category:Calling a VI]]		[[Category:Calling a VI]]
	[[Category:Connector Pane]]		[[Category:Connector Pane]]

← Older revision		Revision as of 12:04, 4 January 2025
Line 42:		Line 42:
	When using [[VI Scripting]] to access a Connector Pane (for example: [[ConnectorPane class/Controls() property\|ConnectorPane class/Controls[] property]]), the terminals by defaultare ordered from Right to Left, Bottom to Top. This changes if the pattern is rotated or flipped. Therefore, for a standard 4x2x2x4 pattern the terminals are indexed as follows:		When using [[VI Scripting]] to access a Connector Pane (for example: [[ConnectorPane class/Controls() property\|ConnectorPane class/Controls[] property]]), the terminals by defaultare ordered from Right to Left, Bottom to Top. This changes if the pattern is rotated or flipped. Therefore, for a standard 4x2x2x4 pattern the terminals are indexed as follows:

	~~[[File:4x2x2x4-Default.png~~\|~~Default~~ 4x2x2x4]]		{{ConnectorPane\|pattern=4x2x2x4}}

	To see other patterns, see [[Connector pane patterns\|Connector Pane Patterns]].		To see other patterns, see [[Connector pane patterns\|Connector Pane Patterns]].