documentationfor yFiles for HTML 3.0.0.3

Properties

rectanglein DynamicFreeLabelModelParameterGets the oriented rectangle to dynamically retrieve the values from.
layoutin ILabelGets a snapshot of the current layout of the label.
layoutin LabelCandidateRenderTagGets the layout of the label candidate.
layoutin LabelCandidateGets the oriented box of this candidate.
layoutin LayoutEdgeLabelGets or sets a snapshot of the bounds of the edge label as an IOrientedRectangle.
labelEndBoundsin LayoutExecutorAsyncGets a mapping from labels in the LayoutGraph to their new layout, after the results are in.
layoutin LayoutNodeLabelGets or sets a snapshot of the bounds of the node label.

Fields

EMPTYin IOrientedRectangleAn immutable empty IOrientedRectangle with width and height of -1.

Method Return Values

createImmutable (number, number, number, number, number, number)in OrientedRectangleCreates an immutable IOrientedRectangle with the given values.
toImmutableOrientedRectangle ()in OrientedRectangleCreates an immutable IOrientedRectangle from a given OrientedRectangle.
getGeometry (ILabel, ILabelModelParameter)in BezierEdgePathLabelModel
getGeometry (ILabel, ILabelModelParameter)in BezierEdgeSegmentLabelModel
getGeometry (ILabel, ILabelModelParameter)in CompositeLabelModel
getGeometry (ILabel, ILabelModelParameter)in EdgePathLabelModel
getGeometry (ILabel, ILabelModelParameter)in EdgeSegmentLabelModel
getGeometry (ILabel, ILabelModelParameter)in ExteriorNodeLabelModel
getGeometry (ILabel, ILabelModelParameter)in FreeEdgeLabelModel
getGeometry (ILabel, ILabelModelParameter)in FreeLabelModel
getGeometry (ILabel, ILabelModelParameter)in FreeNodeLabelModel
getGeometry (ILabel, ILabelModelParameter)in FreePortLabelModel
getGeometry (ILabel, ILabelModelParameter)in GroupNodeLabelModel
getGeometry (ILabel, ILabelModelParameter)in ILabelModelCalculates the geometry of the given label using the given model parameter.
getGeometry (ILabel, ILabelModelParameter)in InsideOutsidePortLabelModel
getGeometry (ILabel, ILabelModelParameter)in InteriorNodeLabelModel
getGeometry (ILabel, ILabelModelParameter)in NinePositionsEdgeLabelModel
getGeometry (ILabel, ILabelModelParameter)in NodeLabelModelStripeLabelModelAdapter
getGeometry (ILabel, ILabelModelParameter)in SmartEdgeLabelModel
getGeometry (ILabel, ILabelModelParameter)in StretchNodeLabelModel
getGeometry (ILabel, ILabelModelParameter)in StretchStripeLabelModelCalculates the geometry in the form of an IOrientedRectangle for a given label using the given model parameter.
getGeometry (ILabel, ILabelModelParameter)in StripeLabelModelCalculates the geometry in the form of an IOrientedRectangle for a given label using the given model parameter.
getLabelLayout (Point, ILabel)in LabelDropInputModeGet the layout the dragged label currently has.

Method Parameters

appendOrientedRectangle (IOrientedRectangle, boolean)in GeneralPathAppends an IOrientedRectangle to this path instance.
intersects (IOrientedRectangle, number)in IOrientedRectangleDetermines whether an OrientedRectangle intersects another one.
createTransform (IOrientedRectangle)in MatrixCreates a transformation matrix that can be used to transform points that are in the local coordinate system of the oriented rectangle if the top-left corner is the origin.
OrientedRectangle (IOrientedRectangle)in OrientedRectangleCreates a new instance using the provided values to initialize.
setShape (IOrientedRectangle)in OrientedRectangleApplies the values provided by the given instance to the values of this instance.
intersects (IOrientedRectangle, number?)in RectDetermines whether this rectangle intersects an IOrientedRectangle, given an epsilon.
findBestParameter (ILabel, IOrientedRectangle)in BezierEdgePathLabelModelTries to find a parameter that best matches the given layout for the provided label instance.
findBestParameter (ILabel, IOrientedRectangle)in BezierEdgeSegmentLabelModelTries to find a parameter that best matches the given layout for the provided label instance.
findBestParameter (ILabel, IOrientedRectangle)in CompositeLabelModelTries to find a parameter that best matches the given layout for the provided label instance.
findBestParameter (ILabel, IOrientedRectangle)in EdgePathLabelModelTries to find a parameter that best matches the given layout for the provided label instance.
findBestParameter (ILabel, IOrientedRectangle)in EdgeSegmentLabelModelTries to find a parameter that best matches the given layout for the provided label instance.
findBestParameter (ILabel, IOrientedRectangle)in FreeEdgeLabelModelTries to find a parameter that best matches the given layout for the provided label instance.
createDynamic (IOrientedRectangle)in FreeLabelModelCreates a new label model parameter that dynamically reads the label layout from the provided instance.
createParameterForLayouts (Rect, IOrientedRectangle, Point?)in FreeNodeLabelModelCreates a parameter instance that anchors the labelLayout relative to the nodeLayout.
findBestParameter (ILabel, IOrientedRectangle)in FreeNodeLabelModelTries to find a parameter that best matches the given layout for the provided label instance.
findBestParameter (ILabel, IOrientedRectangle)in FreePortLabelModelTries to find a parameter that best matches the given layout for the provided label instance.
create (function(IOrientedRectangle):ILabelModelParameter)in ILabelModelParameterFinder
findBestParameter (IOrientedRectangle)in ILabelModelParameterFinderTries to find a parameter that best matches the given layout for the label instance whose lookup returned this finder.
findBestParameter (ILabel, IOrientedRectangle)in SmartEdgeLabelModelTries to find a parameter that best matches the given layout for the provided label instance.
collectSnapResults (GraphSnapContext, CollectSnapResultsEventArgs, IOrientedRectangle, ILabel)in ILabelSnapResultProviderCalled when the given label is dragged to add SnapResults for the SnapReferences provided by the context.
create (function(GraphSnapContext, CollectSnapResultsEventArgs, IOrientedRectangle, ILabel):void)in ILabelSnapResultProvider
fromOrientedRectangle (IOrientedRectangle)in ILassoTestableCreates an implementation of the ILassoTestable interface that tests if the orientedRectangle intersects the area of the lasso path.
getDistance (IOrientedRectangle, Point)in LabelPositionHandlerCalculates a distance value between a candidate rectangle and the mouse location.
collectOrthogonalLineSnapResults (GraphSnapContext, CollectSnapResultsEventArgs, OrthogonalSnapLine, IOrientedRectangle, ILabel)in LabelSnapResultProviderCollects snap results that snap the center or any border of the bounds of the label to the given snapLine.
collectSnapLineResults (GraphSnapContext, CollectSnapResultsEventArgs, SnapLine, IOrientedRectangle, ILabel)in LabelSnapResultProviderCollect snap results that snap the center of the label to the given snapLine.
collectSnapResults (GraphSnapContext, CollectSnapResultsEventArgs, IOrientedRectangle, ILabel)in LabelSnapResultProvider
addFixedCandidate (IOrientedRectangle, number?)in EdgeLabelCandidatesAdds a candidate that describes a label placement at a single fixed position.
LabelCandidate (IOrientedRectangle, number?)in LabelCandidateCreates a new instance of LabelCandidate described by its boundary.
addFixedCandidate (IOrientedRectangle, number?)in NodeLabelCandidatesAdds a candidate that describes a label placement at a single fixed position.
addLabel (LayoutNode, IOrientedRectangle)in LayoutGraphCreates a new label for the specified node with the given layout.
addLabel (LayoutEdge, IOrientedRectangle)in LayoutGraphCreates a new label for the specified edge with the given layout.
createLayoutTransform (IRenderContext, IOrientedRectangle, boolean)in LabelStyleBaseCreates a transform matrix that can be applied to a Visual to arrange it according to the given layout and autoFlip rule.
createLayoutTransform (IOrientedRectangle, boolean)in LabelStyleBaseCreates a transform matrix that can be applied to a Visual to arrange it according to the given layout and autoFlip rule.

Implementing Types

OrientedRectangleA mutable oriented rectangle in 2D coordinate space with double precision values stored in an instance of IMutablePoint and IMutableSize as well as two doubles for the up vector components.