Default renderer implementation that can be used for ShapeNodeStyle instances.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.styles.ShapeNodeStyleRenderer
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.
Subclasses which override this method must call the base method.
See Also
This method is called by the framework to create a Visual that will be included into the IRenderContext.
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
Returns the layout bounds as an upper bound for the painting bound.
Remarks
Parameters
A map of options to pass to the method.
- context - ICanvasContext
- the context to calculate the bounds for
Returns
- ↪Rect
- the bounds or
nullto indicate an unbound area
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
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
Returns the intersection for the given line with this shape's geometry.
Returns the aspect ratio with which the shape should be rendered.
Remarks
This method is only called if keepIntrinsicAspectRatio is enabled, otherwise the layout's aspect ratio is used, i.e. width / height.
Must return a value > 0
Returns
- ↪number
- Returns the desired aspect ratio with which the shape should be rendered.
Returns whether the aspect ratio of the shape should be kept.
Remarks
Returns
- ↪boolean
trueit the shape's aspect ratio should be kept.
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
Returns the outline of the shape or null.
Remarks
null is returned callers may assume the canonical outline as result. For nodes this is the node's layout.Returns
- ↪GeneralPath
- The outline or
nullif no outline can be provided.
Implements
Get the shape that is currently used by this renderer.
Remarks
Returns
- ↪ShapeNodeShape
- The shape that is currently used by this renderer.
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
Determines if something has been hit at the given coordinates in the world coordinate system.
Remarks
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
Tests the node using the current style for an intersection with the given box.
Remarks
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 node is considered to be captured by the marquee
Implements
Returns true if the corresponding item is considered to intersect the given path.
Remarks
This method may return false if the item cannot be selected using a lasso selection or optionally if the item is only partially contained within the path.
Implementations should respect the hitTestRadius if lasso selections should behave differently on different zoom levels.
Parameters
A map of options to pass to the method.
- context - IInputModeContext
- the current input mode context
- lassoPath - GeneralPath
- the path describing the lasso selection bounds
Returns
- ↪boolean
trueif the item is considered to be captured by the lasso
Implements
Checks whether the given coordinate is deemed to lie within the shape's geometric bounds.
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
Determines visibility by checking for an intersection with the layout.
Parameters
A map of options to pass to the method.
- context - ICanvasContext
- The context.
- rectangle - Rect
- The current clip
Returns
- ↪boolean
- Whether the layout is visible in the clip.
Implements
Implements the ILookup interface.
Remarks
GetContext. Subclass implementations should make sure to configure this instance before they return this as a result of a successful lookup. This implementation will check if type.IsInstanceOfType(this) and will call configure on success and return this.Type Parameters
- T: any
Parameters
A map of options to pass to the method.
- type - Class<T>
- The type to query for.
Returns
- ↪T
- An implementation or
null.
See Also
Implements
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.