INodeStyleRenderer implementation that can be used in conjunction with CollapsibleNodeStyleDecorator instances.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.styles.CollapsibleNodeStyleDecoratorRenderer
See Also
Constructors
Initializes a new instance of the CollapsibleNodeStyleDecoratorRenderer class.
Properties
Gets the layout of the node this renderer is currently configured for.
Remarks
Node.Layout.Gets or sets the currently configured node.
Gets or sets the currently configured style.
Methods
Prepares this instance for subsequent calls after the style and node have been initialized.
Remarks
Upon invocation the style and node properties have been populated by the getVisualCreator, getBoundsProvider, getHitTestable, or getMarqueeTestable methods.
This is an empty implementation. Subclasses might have to override this method.
Creates the button visual.
Remarks
This method is called from createVisual to create the button. Custom implementations can override this method to use a custom button visualization.
This implementation adds the TOGGLE_EXPANSION_STATE command to the button. The created button is automatically unchecked if the group node is expanded and vice versa.
Parameters
A map of options to pass to the method.
- context - IRenderContext
- The context.
- expanded - boolean
- Specifies whether the button visual is created for the expanded or the collapsed state.
- size - Size
- The button size.
See Also
Creates the visual for the given context.
Remarks
Parameters
A map of options to pass to the method.
- context - IRenderContext
- The context that describes where the visual will be used.
Returns
- ↪Visual
- The visual to include in the canvas object visual tree. This may be
null.
See Also
Implements
Delegates to the getWrappedStyle and takes the button into account.
Parameters
A map of options to pass to the method.
- context - ICanvasContext
- the context to calculate the bounds for
Returns
Implements
Configures the style and node parameters, calls configure and returns this.
Parameters
A map of options to pass to the method.
- node - INode
- The node to retrieve the bounds provider for. The value will be stored in the node property.
- style - INodeStyle
- The style to associate with the node. The value will be stored in the style property.
Returns
- ↪IBoundsProvider
this
See Also
Implements
Yields the buttonPlacement for the current style
Configures the style and node parameters, does not call configure and returns this.
Remarks
this or an instance that depends on a correctly configured this.Parameters
A map of options to pass to the method.
- node - INode
- The node to query the context for. The value will be stored in the node property.
- style - INodeStyle
- The style to associate with the node. The value will be stored in the style property.
Returns
- ↪ILookup
this
See Also
Implements
Configures the style and node parameters, calls configure and returns this.
Parameters
A map of options to pass to the method.
- node - INode
- The node to query hit test with. The value will be stored in the node property.
- style - INodeStyle
- The style to associate with the node. The value will be stored in the style property.
Returns
- ↪IHitTestable
this
See Also
Implements
Delegates to the getWrappedStyle.
Configures the style and node parameters, calls configure and returns this.
Parameters
A map of options to pass to the method.
- node - INode
- The node to query marquee intersection tests. The value will be stored in the node property.
- style - INodeStyle
- The style to associate with the node. The value will be stored in the style property.
Returns
- ↪IMarqueeTestable
this
See Also
Implements
Delegates to the getWrappedStyle.
Configures the style and node properties, calls configure and returns this.
Parameters
A map of options to pass to the method.
- node - INode
- The node to retrieve the shape geometry for. The value will be stored in the node property.
- style - INodeStyle
- The style to associate with the node. The value will be stored in the style property.
Returns
- ↪IShapeGeometry
this
See Also
Implements
Configures the style and node parameters, does not call configure and returns this.
Remarks
Configure in isVisible.Parameters
A map of options to pass to the method.
- node - INode
- The node to query visibility tests. The value will be stored in the node property.
- style - INodeStyle
- The style to associate with the node. The value will be stored in the style property.
Returns
- ↪IVisibilityTestable
this
See Also
Implements
Configures the style and node parameters, calls configure and returns this.
Parameters
A map of options to pass to the method.
- node - INode
- The node to retrieve the IVisualCreator for. The value will be stored in the node property.
- style - INodeStyle
- The style to associate with the node. The value will be stored in the style property.
Returns
- ↪IVisualCreator
this
See Also
Implements
Delegates to the getWrappedStyle and checks the button.
Parameters
A map of options to pass to the method.
- context - IInputModeContext
- the context the hit test is performed in
- location - Point
- the coordinates in world coordinate system
Returns
- ↪boolean
- whether something has been hit
Implements
Delegates to the getWrappedStyle.
Parameters
A map of options to pass to the method.
- context - IInputModeContext
- the current input mode context
- rectangle - Rect
- the box describing the marquee's bounds
Returns
- ↪boolean
trueif the item is considered to be captured by the marquee
Implements
Delegates to the getWrappedStyle.
Parameters
A map of options to pass to the method.
- location - Point
- The point to test.
Returns
- ↪boolean
- True if the point lies within the shape.
Implements
Delegates to the getWrappedStyle.
Parameters
A map of options to pass to the method.
- context - ICanvasContext
- The context to determine the visibility for.
- rectangle - Rect
- The visible region clip.
Returns
- ↪boolean
falseif and only if it is safe not to paint the element because it would not affect the given clipping region.
Implements
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 reobtained for subsequent use.Type Parameters
- T: any
Parameters
A map of options to pass to the method.
- type - Class<T>
- The type for which an instance shall be returned.
Returns
- ↪T
- an instance that is assignable to type or
null
See Also
Implements
Updates the button visual.
Remarks
Parameters
A map of options to pass to the method.
- context - IRenderContext
- The context.
- expanded - boolean
- Specifies whether the button visual is updated for the expanded or the collapsed state.
- size - Size
- The button size.
- oldButton - Visual
- The old button visual.
This method updates or replaces a previously created Visual for inclusion in the IRenderContext.
Remarks
The CanvasComponent uses this method to give implementations a chance to update an existing Visual that has previously been created by the same instance during a call to createVisual. Implementation may update the oldVisual and return that same reference, or create a new visual and return the new instance or null.
I most cases oldVisual is a visual instance that has been returned by the createVisual method of this instance. This is, however, not guaranteed. Implementations have to be aware of this.
Parameters
A map of options to pass to the method.
- context - IRenderContext
- The context that describes where the visual will be used in.
- oldVisual - Visual
- The visual instance to be updated.
Returns
- ↪Visual
oldVisual, if this instance modified the visual, or a new visual that should replace the existing one in the canvas object visual tree.
See Also
Implements
Static Methods
Adds the toggle expansion state command to the given button visual.
Remarks
Parameters
A map of options to pass to the method.
- button - SvgVisual
- The button visual to add the event listeners to.
- currentNode - INode
- The group node whose state is to be toggled.
- context - IRenderContext
- The context.