Split Pane
Last updated
Was this helpful?
Last updated
Was this helpful?
(part of package 'Servoy Extra Components') Extends designtime/SolutionModel: JSWebComponent Extends runtime: RuntimeWebComponent
A component that provides a split pane container for displaying two forms side by side or one on top of the other.
This is a reference page; many components have detailed usage guides here.
Sets the initial splitter div location, between 0 and 1 is a percentange, more than 1 is a value in pixels. Type: Number Default Value: -1
Size of the splitter div - in pixels. Type: Number Default Value: 5
Flag indicating whether the split pane is enabled for user interaction. Type: Default Value: true
The left or top pane object. Type: CustomType<servoyextra-splitpane.pane>
Minimum size (in pixels) allowed for the left or top pane. Type: Number Default Value: 30
The right or bottom pane object. Type: CustomType<servoyextra-splitpane.pane>
Minimum size (in pixels) allowed for the right or bottom pane. Type: Number Default Value: 30
An array of pane objects. (Deprecated: use pane1 and pane2 instead.) Type: Array<CustomType<servoyextra-splitpane.pane>>
Specifies how extra space is distributed between the two panes. A value of 0 means the right/bottom pane gets all extra space; 1 means the left/top pane gets it. Type: Number Default Value: 0
Minimum height of the splitpane, set only in responsive forms. Type: Number Default Value: 300
Determines the split type. Typically, 0 represents horizontal splitting and 1 represents vertical splitting. Type: Number Default Value: 0
Called when the split pane changes (for example, when the divider is moved).
Parameters:
Gets the divider location in pixels.
Example:
Returns: Number The size in pixels
Gets the divider size in pixels.
Example:
Returns: Number The size in pixels
Returns the left form of the split pane.
Example:
Gets left form minimum size in pixels.
Example:
Returns: Number The minimum size in pixels for the left form panel.
Gets the divider location in percentage when the component is visible.
Example:
Returns: Number The location in percentage
Gets the resize weight, which specifies how to distribute extra space when the size of the split pane changes. A value of 0, the default, indicates the right/bottom component gets all the extra space (the left/top component acts fixed), where as a value of 1 specifies the left/top component gets all the extra space (the right/bottom component acts fixed). Specifically, the left/top component gets (weight * diff) extra space and the right/bottom component gets (1 - weight) * diff extra space
Example:
Returns: Number The resize weight value, indicating how the extra space is distributed between the left/top and right/bottom components of the split pane.
Returns the right form of the split pane.
Example:
Gets right form minimum size in pixels.
Example:
Returns: Number The minimum size in pixels for the right form panel.
Sets divider location. If location is less then 1 then the location will be considered at (location * 100) percent of the split pane from left, otherwise it will represent the pixels from left.
Example:
Parameters:
{Number} location The location of the divider.
Sets divider size in pixels.
Example:
Parameters:
{Number} size The size of the divider in pixels.
Set a relationless or related form as left panel.
Example:
Parameters:
Returns: Boolean Value indicating if pane was successfully added
Sets left form minimum size in pixels.
Example:
Parameters:
{Number} minSize The minimum size in pixels for the left form panel.
Sets the resize weight, which specifies how to distribute extra space when the size of the split pane changes. A value of 0, the default, indicates the right/bottom component gets all the extra space (the left/top component acts fixed), where as a value of 1 specifies the left/top component gets all the extra space (the right/bottom component acts fixed). Specifically, the left/top component gets (weight * diff) extra space and the right/bottom component gets (1 - weight) * diff extra space
Example:
Parameters:
{Number} resizeWeight The weight value (between 0 and 1) specifying how to distribute extra space between the left/top and right/bottom components of the split pane.
Set a relationless or related form as right panel.
Example:
Parameters:
Returns: Boolean Value indicating if pane was successfully added
Sets right form minimum size in pixels.
Example:
Parameters:
{Number} minSize The minimum size in pixels for the right form panel.
Represents a pane within the split pane. scripting type: CustomType<servoyextra-splitpane.pane>
containsFormId
The form contained in this pane.
relationName
The relation name used to link the pane's form to the main datasource.
Flag indicating whether the split pane is read-only. Type:
CSS style classes applied to the split pane component. Type:
Tab sequence order for keyboard navigation. Type:
Flag indicating whether the split pane is visible. Type:
Returns: Left form of the split pane
Returns: Right form of the split pane
Type:
Type: