documentationfor yFiles for HTML 3.0.0.3

Properties

wrappedParameterin CompositeLabelModelParameterGets the wrapped parameter that was provided in addParameter.
layoutParameterin FoldingLabelDefaultsGets or sets the ILabelModelParameter to use when initializing the folding labels.
layoutParameterin FoldingLabelStateGets or sets the ILabelModelParameter used to describe the label's layout.
layoutParameterin ILabelGets the label model's parameter that determines the positioning of this label.
layoutParameterin ILabelDefaultsGets or sets the label model parameter to use for labels.
layoutParameterin LabelDefaults
wrappedParameterin NodeLabelModelStripeLabelModelAdapterParameterGets the wrapped parameter of a ILabelModel that supports nodes.
layoutParameterin SimpleLabelGets or sets the label model's parameter that determines the positioning of this label.
parameterin LabelCandidateRenderTagGets the layout parameter of the label candidate.
layoutParameterin LabelEditingEventArgsGets or sets the layoutParameter of the label to add.
labelEndParameterin LayoutExecutorAsyncGets a mapping from labels in the LayoutGraph to their new layout parameters, after the results are in.
buttonPlacementin CollapsibleNodeStyleDecoratorGets or sets an ILabelModelParameter that determines the placement of the button for toggling the expanded state.
iconPlacementin IconLabelStyleGets or sets the parameter that specifies the icon placement.

Method Return Values

getLayoutParameter (TDataItem)in LabelCreatorObtains a layoutParameter instance or null by resolving layoutParameterProvider on the data item.
getUpdatedLayoutParameter (IGraph, ILabel, TDataItem)in LabelCreatorResolves the layoutParameterProvider on the given data item.
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.
copyLabelLayoutParameter (IGraph, ILabel)in ClipboardGraphCopierCopies a ILabelModelParameter for a given label.
findBestParameter (ILabel, IOrientedRectangle)in CompositeLabelModelTries to find a parameter that best matches the given layout for the provided label instance.
getParameters (ILabel)in CompositeLabelModelReturns an enumerator over a set of possible ILabelModelParameter instances that can be used for the given label and model.
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.
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.
getLabelLayoutParameter (ClipboardGraphCopier, IGraph, ILabel, ILabelOwner)in GraphClipboardGets an ILabelModelParameter for the given sourceLabel to be placed at the given newTargetOwner.
copyLabelLayoutParameter (IGraph, ILabel)in GraphCopierCopies a ILabelModelParameter for a given label.
createDefaultLabelLayoutParameter (ILabelOwner)in IGraphCreates the label layout parameter for a given ILabelOwner.
getLayoutParameterInstance (ILabelOwner)in ILabelDefaultsFactory method that returns a label model parameter instance for use with newly created labels.
findBestParameter (IOrientedRectangle)in ILabelModelParameterFinderTries to find a parameter that best matches the given layout for the label instance whose lookup returned this finder.
getParameters ()in ILabelModelParameterProviderReturns an enumerator over a set of possible ILabelModelParameter instances that can be used for the label whose lookup returned this provider.
createLabelLayoutParameter (IStripe)in ITableCreates the label model parameter for a given ILabelOwner.
getLayoutParameterInstance (ILabelOwner)in LabelDefaults
findBestParameter (ILabel, IOrientedRectangle)in SmartEdgeLabelModelTries to find a parameter that best matches the given layout for the provided label instance.
getLabelParameter (IInputModeContext, ILabelOwner)in EditLabelHelperDetermines the label model parameter to use for the label, depending on the owner.
getNewLabelModelParameter (ILabelOwner, ILabel, Point)in LabelDropInputModeDetermines the ILabelModelParameter the label should have if it was dropped at dragLocation over owner.
getParameterCandidates (ILabel)in LabelPositionHandlerGets the candidates for the given label.

Method Parameters

addLabelCore (IGraph, ILabelOwner, string, ILabelModelParameter, ILabelStyle, Size, ILabel['tag'])in LabelCreatorCalled from addLabel and performs the actual label creation in the graph.
getGeometry (ILabel, ILabelModelParameter)in BezierEdgePathLabelModel
getGeometry (ILabel, ILabelModelParameter)in BezierEdgeSegmentLabelModel
addModel (ILabelModelParameter, number?)in CompositeLabelModelAdds the model of the labelModelParameter to this model's collection of label models and returns the labelModelParameter wrapped in a CompositeLabelModelParameter.
addParameter (ILabelModelParameter, number?)in CompositeLabelModelAdds another parameter to this model's collection of parameters.
getGeometry (ILabel, ILabelModelParameter)in CompositeLabelModel
getGeometry (ILabel, ILabelModelParameter)in EdgePathLabelModel
getGeometry (ILabel, ILabelModelParameter)in EdgeSegmentLabelModel
getGeometry (ILabel, ILabelModelParameter)in ExteriorNodeLabelModel
addLabel (string, ILabelModelParameter?, ILabelStyle?, Size?, ILabel['tag']?)in FolderNodeState
addLabel (string, ILabelModelParameter?, ILabelStyle?, Size?, ILabel['tag']?)in FoldingEdgeState
FoldingLabelDefaults (ILabelDefaults?, )in FoldingLabelDefaultsCreates a new instance of this type, optionally configuring the values from the given ILabelDefaults object.
addLabel (FoldingLabelOwnerState, ILabel, string, ILabelModelParameter, ILabelStyle, Size, any)in FoldingLabelDefaultsSimple callback method that delegates to addLabel
addLabel (string, ILabelModelParameter?, ILabelStyle?, Size?, ILabel['tag']?)in FoldingLabelOwnerStateAdds a FoldingLabelState to this state.
getGeometry (ILabel, ILabelModelParameter)in FreeEdgeLabelModel
getGeometry (ILabel, ILabelModelParameter)in FreeLabelModel
getGeometry (ILabel, ILabelModelParameter)in FreeNodeLabelModel
getGeometry (ILabel, ILabelModelParameter)in FreePortLabelModel
addLabel (ILabelOwner, string, ILabelModelParameter?, ILabelStyle?, Size?, ILabel['tag']?)in Graph
createUndoUnitForLabelModelParameterChange (ILabel, ILabelModelParameter)in GraphCreates the undo unit for changing the layout parameter of the given label.
onChangingLabelLayoutParameter (ILabel, ILabelModelParameter)in GraphCalled before the layoutParameter of a label is being changed.
onLabelLayoutParameterChanged (ILabel, ILabelModelParameter)in GraphCalled after a label model parameter has changed.
setLabelLayoutParameter (ILabel, ILabelModelParameter)in Graph
addLabel (ILabelOwner, string, ILabelModelParameter?, ILabelStyle?, Size?, ILabel['tag']?)in GraphWrapperBase
onLabelLayoutParameterChanged (ItemChangedEventArgs<ILabel,ILabelModelParameter>)in GraphWrapperBaseRaises the label-layout-parameter-changed event.
setLabelLayoutParameter (ILabel, ILabelModelParameter)in GraphWrapperBase
getGeometry (ILabel, ILabelModelParameter)in GroupNodeLabelModel
addLabel (ILabelOwner, string, ILabelModelParameter?, ILabelStyle?, Size?, ILabel['tag']?)in IGraphAdd a label to the given node or edge using the text as the initial label text and label model parameter, style, and tag.
calculateLabelPreferredSize (ILabelOwner, string, ILabelModelParameter?, ILabelStyle?, ILabel['tag']?)in IGraphCalculates the preferred size of a label with the given properties.
setLabelLayoutParameter (ILabel, ILabelModelParameter)in IGraphSets the label model parameter for the given label.
getGeometry (ILabel, ILabelModelParameter)in ILabelModelCalculates the geometry of the given label using the given model parameter.
addLabel (IStripe, string, ILabelModelParameter?, ILabelStyle?, Size?, ILabel['tag']?)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, ILabel['tag'])in ITableCalculates the preferred size of a label with the given properties.
setLabelLayoutParameter (ILabel, ILabelModelParameter)in ITableSets the label model parameter for the given label.
getGeometry (ILabel, ILabelModelParameter)in InsideOutsidePortLabelModel
getGeometry (ILabel, ILabelModelParameter)in InteriorNodeLabelModel
getMinimumNodeSize (ILabel, ILabelModelParameter)in InteriorNodeLabelModelReturns the minimum size this model would require for the node owner of the label if the given label were used with the provided parameter.
getNodePadding (ILabel, ILabelModelParameter)in InteriorNodeLabelModelReturns the padding this model would require for the node owner of the label if the given label were used with the provided parameter.
LabelDefaults ()in LabelDefaultsInitializes a new instance of the LabelDefaults class using a trivial parameter.
getGeometry (ILabel, ILabelModelParameter)in NinePositionsEdgeLabelModel
createParameter (ILabelModelParameter)in NodeLabelModelStripeLabelModelAdapterCreates a parameter that delegates to the given parameter of an ILabelModel for nodes.
getGeometry (ILabel, ILabelModelParameter)in NodeLabelModelStripeLabelModelAdapter
SimpleLabel (ILabelOwner?, string?, ILabelModelParameter?, )in SimpleLabelCreates an instance of the SimpleLabel class with default lookup, VOID_LABEL_STYLE as style, and the given parameter, text, and owner.
getGeometry (ILabel, ILabelModelParameter)in SmartEdgeLabelModel
getGeometry (ILabel, ILabelModelParameter)in StretchNodeLabelModel
getMinimumNodeSize (ILabel, ILabelModelParameter)in StretchNodeLabelModelReturns the minimum size this model would require for the node owner of the label if the given label was used with the provided parameter.
getNodePadding (ILabel, ILabelModelParameter)in StretchNodeLabelModelReturns the padding this model would require for the node owner of the label if the given label were used with the provided parameter.
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.
addLabel (IStripe, string, ILabelModelParameter?, ILabelStyle?, Size?, ILabel['tag']?)in Table
setLabelLayoutParameter (ILabel, ILabelModelParameter)in TableSets the label model parameter for the given label.
createLabel (IInputModeContext, IGraph, ILabel, ILabelOwner, ILabelModelParameter)in LabelDropInputModeCreates the label in the graph after it's been dropped.
setLayoutParameter (ILabel, ILabelModelParameter)in LabelPositionHandlerActually applies the given parameter at the end of the gesture.
fromParameter (ILabelModelParameter)in EdgeLabelPreferredPlacementReturns an EdgeLabelPreferredPlacement which matches the given parameter best.
createEdgeLabelCandidate (ILabel, ILabel, ILabelModelParameter, LayoutEdgeLabel)in LayoutGraphAdapterCreates the LabelCandidate for a given label and ILabelModelParameter combination.
createNodeLabelCandidate (ILabel, ILabel, ILabelModelParameter, LayoutNodeLabel)in LayoutGraphAdapterCreates a LabelCandidate for a given label and ILabelModelParameter combination.
CollapsibleNodeStyleDecorator (INodeStyle?, )in CollapsibleNodeStyleDecoratorInitializes a new instance of the CollapsibleNodeStyleDecorator class using the provided style for the wrappedStyle property.
IconLabelStyle ()in IconLabelStyleCreates a new instance.
createGraphAnimation (IGraph, IMapper<INode,IRectangle>?, IMapper<IEdge,yfiles.geometry.IPoint[]>?, IMapper<IPort,IPortLocationModelParameter>?, IMapper<ILabel,ILabelModelParameter>?, TimeSpan?)in IAnimationCreates a new IAnimation that animates the given layout of all types of graph items.
createLabelAnimation (IGraph, ILabel, ILabelModelParameter, TimeSpan)in IAnimationCreates a new IAnimation that animates the given label from its current layout linearly to the layout given by the targetLayoutParameter.

Implementing Types

AbsoluteFreeLabelModelParameterAn ILabelModelParameter created by FreeLabelModel's createAbsolute method.
AnchoredFreeLabelModelParameterAn ILabelModelParameter created by FreeLabelModel's createAnchored method.
BezierEdgePathLabelModelParameterA parameter created by the BezierEdgePathLabelModel.
BezierEdgeSegmentLabelModelParameterAn ILabelModelParameter created by BezierEdgeSegmentLabelModel.
CompositeLabelModelParameterAn ILabelModelParameter created by CompositeLabelModel.
DynamicFreeLabelModelParameterAn ILabelModelParameter created by FreeLabelModel's createDynamic method.
EdgePathLabelModelParameterAn ILabelModelParameter created by EdgePathLabelModel.
EdgeSegmentLabelModelParameterAn ILabelModelParameter created by EdgeSegmentLabelModel.
ExteriorNodeLabelModelParameterAn ILabelModelParameter created by ExteriorNodeLabelModel.
FreeEdgeLabelModelParameterAn ILabelModelParameter created by FreeEdgeLabelModel.
FreeNodeLabelModelParameterAn ILabelModelParameter created by FreeNodeLabelModel.
FreePortLabelModelParameterAn ILabelModelParameter created by FreePortLabelModel.
GroupNodeLabelModelParameterAn ILabelModelParameter created by GroupNodeLabelModel.
InsideOutsidePortLabelModelParameterAn ILabelModelParameter created by InsideOutsidePortLabelModel.
InteriorNodeLabelModelParameterAn ILabelModelParameter created by InteriorNodeLabelModel.
NinePositionsEdgeLabelModelParameterAn ILabelModelParameter created by NinePositionsEdgeLabelModel.
NodeLabelModelStripeLabelModelAdapterParameterAn ILabelModelParameter created by NodeLabelModelStripeLabelModelAdapter.
SmartEdgeLabelModelParameterThe parameter for the SmartEdgeLabelModel.
StretchNodeLabelModelParameterAn ILabelModelParameter created by StretchNodeLabelModel.
StretchStripeLabelModelParameterAn ILabelModelParameter created by StretchStripeLabelModel.
StripeLabelModelParameterAn ILabelModelParameter created by StripeLabelModel.