This interface defines a child element of a table or a table element container.
Type Details
- yFiles module
- view
See Also
Properties
Returns the actual minimum size a stripe can acquire.
Remarks
The current actual dimension of the stripe.
Remarks
See Also
Gets the direct children of stripe in a table hierarchy.
Remarks
See Also
Returns a collection of all descendants of stripe.
Remarks
Gets the index of stripe in its parentStripe collection of childStripes.
Checks whether stripe is the root item of a stripe hierarchy.
See Also
Gets a collection of labels that are owned by this instance.
Remarks
This gives access to a read-only live view of the labels, i.e. the collection can change over time, as well as the labels contained in it. If a snapshot of the current state is needed, one needs to copy the collection and its contents.
To modify the label collection for instances of the default implementations that were created via the factory methods on IGraph, use addLabel and remove.
Examples
// add label with given text, default style, and default placement
// and determine the preferred size automatically
const label1 = graph.addLabel(node, 'Some Label')
// add label with given text, placement, style, size, and tag (user object)
const label2 = graph.addLabel(
node,
'Some Label',
InteriorNodeLabelModel.CENTER,
new LabelStyle(),
new Size(10, 150),
userObject,
)
// add label with given text and style but default placement
// and determine the preferred size automatically
const label3 = graph.addLabel({
owner: node,
text: 'Some Label',
style: new LabelStyle(),
})for (const label of node.labels) {
// ...
}graph.remove(label)See Also
Defined in
Gets a live view of the relative layout of the stripe.
Remarks
See Also
Returns a collection of all descendants of stripe that are leaves and therefore don't have any child stripes.
Gets the minimal permissible value for size.
Remarks
Gets the padding for this stripe.
Remarks
Gets the parent of stripe in a table hierarchy.
Remarks
See Also
Gets the root of the stripe hierarchy of stripe in a table hierarchy.
Remarks
null is returned.See Also
Gets the style for this stripe.
Gets or sets the tag object associated with this item instance.
Remarks
Property Value
Examples
owner.tag = newTagconst tag = owner.tagSee Also
Implements
Gets the padding that is currently in effect for this stripe.
Remarks
See Also
Methods
Returns the layout of stripe in absolute coordinates.
Remarks
node node to calculate the absolute layout.Parameters
A map of options to pass to the method.
- node - INode
- The node relative to which the stripe layout is calculated. This should be the same node where table for
stripeis associated to.
Returns
- ↪Rect
- The layout of the supplied stripe in absolute coordinates.
Returns an instance that implements the given type or null.
Remarks
null implementations for the types, nor does it have to return the same instance any time. Also, it depends on the type and context whether the instance returned stays up to date or needs to be re-obtained for further use.Type Parameters
- T
Parameters
A map of options to pass to the method.
- type - Constructor<T>
- the type for which an instance shall be returned
Returns
- ↪T?
- an instance that is assignable to the type or
null