documentationfor yFiles for HTML 2.6

Usages of IStripe

Properties

childStripesin IStripeGets the direct children of stripe in a table hierarchy.
descendantsin IStripeReturns a collection of all descendants of stripe.
leavesin IStripeReturns a collection of all descendants of stripe that are leaves and therefore don't have any child stripes.
parentStripein IStripeGets the parent of stripe in a table hierarchy.
rootin IStripeGets the root of the stripe hierarchy of stripe in a table hierarchy.
parentStripein StripeEventArgsGets the parent of the stripe that owned the stripe before the event happened.
movedStripein ReparentStripePositionHandlerGets the moved stripe.
draggedItemin StripeDropInputModeGets the currently dragged IModelItem instance.
stripein StripeSubregionGets the stripe that this instance describes.
stripein TemplateStripeStyleRendererGets or sets the currently configured stripe.

Method Return Values

findStripes (INode, Point, StripeTypes, function(IStripe):boolean?)in ITableFinds all stripes underneath a certain point.
createStripe (IInputModeContext, IStripe, IStripe)in StripeDropInputModeCreate a new stripe as the result of a drag and drop gesture.
insertChild (IStripe, number, number?)in TableEditorInputModeInserts a new stripe as child of owner
getEnumerator ()in StripeSelection

Method Parameters

addLabel (IStripe, string, ILabelModelParameter?, ILabelStyle?, Size?, Object?)in ITableAdd a label to the given owner using the text as the initial label text and label model parameter and style.
calculateLabelPreferredSize (IStripe, ILabelStyle, ILabelModelParameter, string, Object)in ITableCalculates the preferred size of a label with the given properties.
createLabelLayoutParameter (IStripe)in ITableCreates the label model parameter for a given ILabelOwner.
createLabelStyle (IStripe)in ITableCreates an instance of the default label style for the given stripe.
findColumn (INode, Point, function(IStripe):boolean?)in ITableFinds a column underneath a certain point.
findRow (INode, Point, function(IStripe):boolean?)in ITableFinds a row underneath a certain point.
findStripes (INode, Point, StripeTypes, function(IStripe):boolean?)in ITableFinds all stripes underneath a certain point.
remove (IStripe)in ITableRemoves stripe from its parent container.
removeRecursively (IStripe)in ITableRemoves stripe and all of its descendants from table.
removeRecursivelyWithResize (IStripe)in ITableRemoves the given stripe and all of its descendants from table and resizes all affected stripes so that the table size does not change if possible.
removeWithResize (IStripe)in ITableRemoves stripe from table and resizes all affected stripes so that the table size does not change if possible.
setMinimumSize (IStripe, number)in ITableSets the minimum size of stripe.
setSize (IStripe, number)in ITableSets the actual size of stripe.
setStripeInsets (IStripe, Insets)in ITableSets the insets of stripe.
setStyle (IStripe, IStripeStyle)in ITableSets the style of stripe.
StripeEventArgs (IStripe, IStripe, ITable)in StripeEventArgsInitializes a new instance of the StripeEventArgs class.
addLabel (IStripe, string, ILabelModelParameter?, ILabelStyle?, Size?, Object?)in Table
onStripeChanged (IStripe, IStripe, ITable)in TableCalled after a stripe has changed.
onStripeCreated (IStripe)in TableCalled after a stripe has been created and added to a table.
onStripeRemoved (IStripe, IStripe)in TableCalled after a stripe has been removed from its owner.
remove (IStripe)in Table
setMinimumSize (IStripe, number)in Table
setSize (IStripe, number)in Table
setStripeInsets (IStripe, Insets)in Table
setStyle (IStripe, IStripeStyle)in Table
DefaultStripeInputVisualizationHelper (IStripe)in DefaultStripeInputVisualizationHelperDefault constructor
create ()in IReparentStripeHandlerCreates an implementation of the interface IReparentStripeHandler from the given definition.
isValidParent (IInputModeContext, IStripe, IStripe, number, StripeReparentPolicy)in IReparentStripeHandlerDetermines whether the provided node may be reparented to a newParent.
reparent (IInputModeContext, IStripe, IStripe, number, StripeReparentPolicy)in IReparentStripeHandlerPerforms the actual reparenting after the reparent gesture has been finalized.
shouldReparent (IInputModeContext, IStripe)in IReparentStripeHandlerDetermines whether the user may detach the given stripe from its current parent in order to reparent it.
adjustSize (IInputModeContext, IStripe, IStripe, StripeReparentPolicy, number, number, number)in ReparentStripeHandlerAdjust the size of the source or the target stripe.
isValidParent (IInputModeContext, IStripe, IStripe, number, StripeReparentPolicy)in ReparentStripeHandlerChecks the constraints imposed by maxRowLevel or maxColumnLevel for a valid gesture.
reparent (IInputModeContext, IStripe, IStripe, number, StripeReparentPolicy)in ReparentStripeHandlerPerforms the actual reparenting after the reparent gesture has been finalized.
shouldReparent (IInputModeContext, IStripe)in ReparentStripeHandlerDetermines whether the user may detach the given stripe from its current parent in order to reparent it.
ReparentStripePositionHandler (IStripe)in ReparentStripePositionHandlerCreates a new instance of this position handler which moves movedStripe
createTargetGhost (IInputModeContext, IStripe)in ReparentStripePositionHandlerCreate a ghost visualization for the target region of the reparent gesture.
determineGesture (IInputModeContext, IPoint, IStripe, StripeSubregion, Rect)in ReparentStripePositionHandlerDetermine the reparent gesture that would result from the given parameters.
updateSourceGhost (IInputModeContext, ICanvasObject, IStripe, StripeReparentPolicy)in ReparentStripePositionHandlerUpdates the source ghost visualization after a drag.
updateTargetGhost (IInputModeContext, ICanvasObject, IStripe, StripeReparentPolicy, Rect)in ReparentStripePositionHandlerModifies the target ghost visualization after a drag.
updateTargetGhostBounds (Rect, StripeReparentPolicy, IStripe)in ReparentStripePositionHandlerUpdates the visualization bounds for the target visualization depending on the provided values.
createStripe (IInputModeContext, IStripe, IStripe)in StripeDropInputModeCreate a new stripe as the result of a drag and drop gesture.
onStripeCreated (ItemEventArgs<IStripe>)in StripeDropInputModeCalled whenever a new stripe is created
startDrag (HTMLElement | SVGElement, IStripe, DragDropEffects?, boolean?, HTMLElement | SVGElement?)in StripeDropInputModeStarts a drag and drop operation for an IStripe.
StripeSubregion (StripeSubregionTypes, IStripe)in StripeSubregionCreate a new instance that describes the specific subregion.
createLabel (IStripe)in TableEditorInputModeInteractively creates a new label for the provided stripe.
deleteStripe (IStripe)in TableEditorInputModeDeletes a single stripe
insertChild (IStripe, number, number?)in TableEditorInputModeInserts a new stripe as child of owner
onDeletedSelection (SelectionEventArgs<IStripe>)in TableEditorInputModeRaises the DeletedSelection event.
onDeletingSelection (SelectionEventArgs<IStripe>)in TableEditorInputModeRaises the DeletingSelection event.
shouldDelete (IStripe)in TableEditorInputModeDetermines whether the given item should be deleted during deleteSelection.
getContext (IStripe, IStripeStyle)in IStripeStyleRendererGets a temporary context instance that can be used to query additional information for the stripe's style.
getVisualCreator (IStripe, IStripeStyle)in IStripeStyleRendererGets an implementation of the IVisualCreator interface that can handle the provided stripe and its associated style.
createVisual (IRenderContext, IStripe)in StripeStyleBaseCreates the visual.
lookup (IStripe, Class)in StripeStyleBasePerforms the lookup operation for the getContext that has been queried from the renderer.
updateVisual (IRenderContext, TVisual, IStripe)in StripeStyleBaseUpdates the visual previously created by createVisual.
createTemplate (IRenderContext, IStripe)in TemplateStripeStyleBaseFactory method that is called by the TemplateStripeStyleRenderer to create the visual that will be used for the display of the stripe.
getContext (IStripe, IStripeStyle)in TemplateStripeStyleRendererConfigures the style and stripe parameters, does not call configure and returns this.
getVisualCreator (IStripe, IStripeStyle)in TemplateStripeStyleRendererConfigures the style and stripe parameters, calls configure and returns this.
getContext (IStripe, IStripeStyle)in VoidStripeStyleRendererYields the EMPTY that will not yield anything.
getVisualCreator (IStripe, IStripeStyle)in VoidStripeStyleRendererYields the INSTANCE that will do nothing.
isSelected (IStripe)in StripeSelectionReturn whether stripe is currently selected
onItemSelectionChanged (ItemSelectionChangedEventArgs<IStripe>)in StripeSelectionRaises the ItemSelectionChanged event
setSelected (IStripe, boolean)in StripeSelection
createStripeAnimation (IStripe, number)in TableAnimationCreate the animation for a single IStripe

Extending Types

StripeEventArgsA specialized subclass of the ItemEventArgs<T> class that is bound to the IStripe type and carries additional owner information.
StripeDropInputModeAn ItemDropInputMode<T> specialized to the drag and drop of IStripes.

Implementing Types

IColumnInterface that describes a column in a ITable instance.
IRowInterface that describes a row in a ITable instance.
IStripeSelectionManages the selection state of items in an ITable instance.