Skip to main content
Light Dark System

Split

<et2-split> | Et2Split
Since 23.1

Properties

Name Description Reflects Type Default
accesskey Accesskey provides a hint for generating a keyboard shortcut for the current element. The attribute value must consist of a single printable character. string -
align Used by Et2Box to determine alignment. Allowed values are left, right string -
class CSS Class. This class is applied to the outside, on the web component itself. Due to how WebComponents work, this might not change anything inside the component. string -
data Set the dataset from a CSV string -
deferredProperties
Any attribute that refers to row content cannot be resolved immediately, but some like booleans cannot stay a string because it’s a boolean attribute. We store them for later, and parse when they’re fully in their row. If you are creating a widget that can go in a nextmatch row, and it has boolean attributes that can change for each row, add those attributes into deferredProperties - -
disabled Defines whether this widget is visibly disabled. The widget is still visible, but clearly cannot be interacted with. Widgets disabled in the template will not return a value to the application code, even if re-enabled via javascript before submitting. To allow a disabled widget to be re-enabled and return a value, disable via javascript in the app’s et2_ready() instead of an attribute in the template file. boolean false
dom_id
Get the actual DOM ID, which has been prefixed to make sure it’s unique. string -
hidden The widget is not visible. As far as the user is concerned, the widget does not exist. Widgets hidden with an attribute in the template may not be created in the DOM, and will not return a value. Widgets can be hidden after creation, and they may return a value if hidden this way. boolean -
id
Get the ID of the widget string -
label The label of the widget This is usually displayed in some way. It’s also important for accessability. This is defined in the parent somewhere, and re-defining it causes labels to disappear string -
noLang Disable any translations for the widget boolean -
parentId Parent is different than what is specified in the template / hierarchy. Widget ID of another node to insert this node into instead of the normal location string -
position The current position of the divider from the primary panel’s edge as a percentage 0–100. Defaults to 50% of the container’s initial size - -
positionInPixels
position-in-pixels
The current position of the divider from the primary panel’s edge in pixels. number -
primary If no primary panel is designated, both panels will resize proportionally and docking is disabled “start” | “end” | undefined - -
snap One or more space-separated values at which the divider should snap. Values can be in pixels or percentages, e.g. "100px 50%". string | undefined -
snapThreshold
snap-threshold
How close the divider must be to a snap point until snapping occurs. number 12
statustext Tooltip which is shown for this element on hover string -
styles
WebComponent * - -
vertical Draws the split panel in a vertical orientation with the start and end panels stacked. boolean false
options
Get property-values as object
use widget methods
object -
orientation Set the orientation of the splitter “h” for the splitter bar to be horizontal (children are stacked vertically) “v” for the splitter bar to be vertical (children are side by side horizontally)
use vertical=true|false instead
- -
supportedWidgetClasses
et2_widget compatability
Legacy compatability. Some legacy widgets check their parent to see whats allowed
array []
updateComplete A read-only promise that resolves when the component has finished updating.

Learn more about attributes and properties.

Methods

Name Description Arguments
checkCreateNamespace() Checks whether a namespace exists for this element in the content array. If yes, an own perspective of the content array is created. If not, the parent content manager is used. Constructor attributes are passed in case a child needs to make decisions -
clone() Creates a copy of this widget. _parent: et2_widget
createElementFromNode() Create a et2_widget from an XML node. First the type and attributes are read from the node. Then the readonly & modifications arrays are checked for changes specific to the loaded data. Then the appropriate constructor is called. After the constructor returns, the widget has a chance to further initialize itself from the XML node when the widget’s loadFromXML() method is called with the node. _node: , _name:
getArrayMgr() Returns the array manager object for the given part managed_array_type: string
getArrayMgrs() Returns an associative array containing the top-most array managers. _mgrs: object
getChildren() Get child widgets Use .children to get web component children -
getInstanceManager() Returns the instance manager -
getPath() Returns the path into the data array. By default, array manager takes care of this, but some extensions need to override this -
getRoot() Returns the base widget Usually this is the same as getInstanceManager().widgetContainer -
handlePositionChange() Override parent to avoid resizing when not visible, as that breaks size calculations -
handleResize() Override parent to avoid resizing when not visible, as that breaks size calculations entries:
isDocked() Determine if the splitter is docked -
loadFromXML() Loads the widget tree from an XML node Overridden here to auto-assign slots if not set _node:
loadingFinished() Needed for legacy compatability. promises: Promise[]
parseXMLAttrs() The parseXMLAttrs function takes an XML DOM attributes object and adds the given attributes to the _target associative array. This function also parses the legacyOptions. N.B. This is only used for legacy widgets. WebComponents use transformAttributes() and do their own handling of attributes. _attrsObj: , _target: object, _proto: et2_widget
set_label() NOT the setter, since we cannot add to the DOM before connectedCallback() TODO: This is not best practice. Should just set property, DOM modification should be done in render https://lit-element.polymer-project.org/guide/templates#design-a-performant-template value: string
setArrayMgr() Sets the array manager for the given part _part: string, _mgr: object
setArrayMgrs() Sets all array manager objects - this function can be used to set the root array managers of the container object. _mgrs: object
setInstanceManager() Set the instance manager Normally this is not needed as it’s set on the top-level container, and we just return that reference manager: etemplate2
toggleDock() Toggle docked or not dock: boolean
updated() A property has changed, and we want to make adjustments to other things based on that changedProperties: PropertyValues
_handleClick() Click handler calling custom handler set via onclick attribute to this.onclick _ev: MouseEvent
_handleDoubleClick() Handle doubleclick (on splitter bar) to dock e:
_handleMouseDown() Hide child iframes, they screw up sizing e:
_handleMouseUp() Show any hidden children e:
_handleResize() Handle a resize This includes notifying any manually resizing widgets, and updating preference if needed e: , timeout:
_handleTemplate() HTML template for split handle -
_loadPreference() Load user’s size preference -
_savePreference() Save the current position to user preference -
_set_label() Do some fancy stuff on the label, splitting it up if there’s a %s in it Normally called from updated(), the “normal” setter stuff has already been run before this is called. We only override our special cases (%s) because the normal label has been set by the parent value: string
destroy() et2_widget compatability
true
-
set_class() Set the widget class
Use this.class or this.classList instead
new_class: string
set_disabled() Wrapper on this.disabled because legacy had it.
Use widget.disabled for visually disabled, widget.hidden for visually hidden. Widgets that are hidden from the server via attribute or $readonlys will not be created. Widgets that are disabled from the server will not return a value to the application code.
value: boolean
set_statustext() supports legacy set_statustext
use this.statustext
value: string

Learn more about methods.