documentationfor yFiles for HTML 2.6

Properties

descriptorin DescriptorWrapperLabelModelGets or sets the descriptor.
descriptorin ExtendedEdgeLabelCandidateGets the label candidate descriptor.
descriptorin ExtendedNodeLabelCandidateGets the label candidate descriptor.

Fields

EXTERNAL_DESCRIPTORin LabelCandidateDescriptorA sharable immutable implementation of the ILabelCandidateDescriptor interface that has penalties of 1.0d and a profit of 1.0d and yields true for the externalCandidate property.
INTERNAL_DESCRIPTORin LabelCandidateDescriptorA sharable immutable implementation of the ILabelCandidateDescriptor interface that has penalties of 1.0d and a profit of 1.0d and yields false for the externalCandidate property.

Method Return Values

getDescriptor (ILabel, ILabelModelParameter)in ConstantLabelCandidateDescriptorProviderAlways yields the parameter that has been passed to the constructor.
getDescriptor (ILabel, ILabelModelParameter)in DescriptorWrapperLabelModel
getDescriptor (ILabel, ILabelModelParameter)in GenericLabelModelYields the ILabelCandidateDescriptor that has been associated with the instance during addParameter.
getDescriptor (ILabel, ILabelModelParameter)in ILabelCandidateDescriptorProviderGets the descriptor for a given pair of a label and a ILabelModelParameter.
getLabelCandidateDescriptor (ILabel, ILabel, ILabelModelParameter)in LayoutGraphAdapterCallback that retrieves the label candidate descriptor for the given label and parameter.

Method Parameters

ConstantLabelCandidateDescriptorProvider (ILabelCandidateDescriptor)in ConstantLabelCandidateDescriptorProviderInitializes a new instance of the ConstantLabelCandidateDescriptorProvider class that always yields descriptor in getDescriptor.
DescriptorWrapperLabelModel (ILabelModel?, )in DescriptorWrapperLabelModelInitializes a new instance of the DescriptorWrapperLabelModel class.
GenericLabelModel (ILabelModelParameter, ILabelCandidateDescriptor?)in GenericLabelModelCreate a new generic label model using the provided parameter as the default parameter.
addParameter (ILabelModelParameter, ILabelCandidateDescriptor?)in GenericLabelModelAdds another parameter to this models collection of parameters.
ExtendedEdgeLabelCandidate (YPoint, YDimension, Object, IEdgeLabelLayout, ILabelCandidateDescriptor)in ExtendedEdgeLabelCandidateReturns a new instance of ExtendedEdgeLabelCandidate.
ExtendedEdgeLabelCandidate (YOrientedRectangle, Object, IEdgeLabelLayout, boolean, ILabelCandidateDescriptor)in ExtendedEdgeLabelCandidateReturns a new instance of ExtendedEdgeLabelCandidate.
ExtendedEdgeLabelCandidate (YPoint, YDimension, Object, IEdgeLabelLayout, boolean, ILabelCandidateDescriptor)in ExtendedEdgeLabelCandidateReturns a new instance of ExtendedEdgeLabelCandidate.
ExtendedNodeLabelCandidate (YPoint, YDimension, Object, INodeLabelLayout, ILabelCandidateDescriptor)in ExtendedNodeLabelCandidateReturns a new instance of ExtendedNodeLabelCandidate.
ExtendedNodeLabelCandidate (YOrientedRectangle, Object, INodeLabelLayout, boolean, ILabelCandidateDescriptor)in ExtendedNodeLabelCandidateReturns a new instance of ExtendedNodeLabelCandidate.
ExtendedNodeLabelCandidate (YPoint, YDimension, Object, INodeLabelLayout, boolean, ILabelCandidateDescriptor)in ExtendedNodeLabelCandidateReturns a new instance of ExtendedNodeLabelCandidate.

Implementing Types

LabelCandidateDescriptorA mutable implementation of the ILabelCandidateDescriptor interface.