documentationfor yFiles for HTML 3.0.0.3

Usages of Size

Properties

sizein IRectangleGets the current size of the rectangle as Size.
sizein FolderNodeDefaultsSets the initial size of the layout of the collapsed group node that will be assigned during the creation of the appearance of the collapsed group node.
preferredSizein FoldingLabelStateGets or sets the preferred size of the label.
preferredSizein ILabelGets the preferred size of the label with respect to its current contents and the implementation of the visualization.
sizein INodeDefaultsGets or sets the default node size.
sizein NodeDefaults
preferredSizein SimpleLabelGets or sets the preferred size of the label with respect to its current contents and the implementation of the visualization.
preferredSizein LabelEditingEventArgsGets or sets the preferredSize of the label to add.
sizeChangeFactorin ReshapeRectangleContextGets the factor by which the size of the node layout changes when the handle is dragged.
mouseHoverSizein ToolTipInputModeGets or sets the amount the mouse pointer has to move in order to hide the tooltip.
preferredSizein ComponentLayoutGets or sets the preferred size of the layout.
defaultMinimumNodeSizein GroupBoundsCalculatorGets or sets the default minimum size (width and height) for group nodes.
edgePortNodeSizein LayoutExecutorAsyncGets or sets the size of the nodes that are inserted for the ports that are created for IEdges that are connected at other IEdges.
edgePortNodeSizein LayoutGraphAdapterGets or sets the size of the nodes that are inserted for the ports that are created for IEdges that are connected at other IEdges.
sizein NodeLayoutGets or sets the size of the node layout.
minimumSizein TemporaryGroupDescriptorGets or sets the minimum size of this temporary group.
maximumPageSizein MultiPageLayoutGets or sets the maximum size of a single page.
buttonSizein CollapsibleNodeStyleDecoratorGets or sets the size of the button.
minimumContentAreaSizein GroupNodeStyleGets or sets the minimum size of the content area.
iconSizein IconLabelStyleGets or sets the size of the icon to render for the label.
maximumSizein LabelStyleGets or sets the maximum preferred size allowed for the label.
minimumSizein LabelStyleGets or sets the minimum preferred size allowed for the label.
maximumSizein MarkupLabelStyleGets or sets the maximum preferred size allowed for the label.
minimumSizein MarkupLabelStyleGets or sets the minimum preferred size allowed for the label.
renderSizein NodeStylePortStyleAdapterGets or sets the size of the port's visualization.
renderSizein ShapePortStyleGets or sets the size of the port's visualization.
minimumNodeSizein TreeMapLayoutGets or sets the minimum size (height and width) a node in the tree map must have.
preferredSizein TreeMapLayoutGets or sets the desired dimension of the root rectangle into which all nodes are placed.
innerSizein CanvasComponentGets the size of the usable area in which the graph will be displayed.
sizein CanvasComponentReturns the size of the HTML element.
sizein PatternFillGets or sets the size of this pattern brush.
pointerSizein PointerEventArgsThe width and the height of the pointer's contact area.
oldSizein SizeChangedEventArgsGets or sets the old size of the control.
minimumViewportContentRatioin ViewportLimiterGets or sets the percentage of the width and height of the viewport that should be reserved *at least* when viewportContentMargins are defined.

Fields

EMPTYin SizeThe "empty" size that has width and height set to -1.0d.
INFINITEin SizeThe "infinite" size that has width and height set to Number.POSITIVE_INFINITY.
ZEROin SizeThe "zero" size that has width and height set to 0.0d.
MINIMUM_GROUP_NODE_SIZE_DATA_KEYin LayoutKeysGets a NodeDataKey<TValue> used for specifying the minimum size of group nodes.

Method Return Values

getPreferredSize (TDataItem)in LabelCreatorObtains a preferredSize or null by resolving the preferredSizeProvider on the data item.
getUpdatedPreferredSize (IGraph, ILabel, TDataItem)in LabelCreatorResolves the preferredSizeProvider and then applies the preferred size bindings.
from (Size)in ISizeCreates a Size instance from the given size-like object by performing automatic type conversion.
toSize ()in ISizeCreates a new Size instance with the current values of this size.
convertToSizeD (MutableSize)in MutableSizePerforms an implicit conversion from MutableSize to Size.
toSize ()in RectCreates a new Size instance with the values of width and height.
from (Size)in SizeCreates a Size instance from the given size-like object by performing automatic type conversion.
max (Size, Size)in SizeReturns a size whose width and height are the respective maximum of the two provided Size instances.
min (Size, Size)in SizeReturns a size whose width and height are the respective minimum of the two provided Size instances.
multiply (number)in SizeMultiplies the width and height by the given factor and returns the result.
calculateLabelPreferredSize (ILabelOwner, string, ILabelModelParameter?, ILabelStyle?, ILabel['tag']?)in IGraphCalculates the preferred size of a label with the given properties.
calculateLabelPreferredSize (IStripe, ILabelStyle, ILabelModelParameter, string, ILabel['tag'])in ITableCalculates the preferred size of a label with the given properties.
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.
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.
getPreferredSize (IInputModeContext, ILabel)in EditLabelHelperGets the preferred size for the label.
getMaximumSize ()in INodeSizeConstraintProviderReturns the maximum size allowed for the node whose lookup returned this provider.
getMinimumSize ()in INodeSizeConstraintProviderReturns the minimum size allowed for the node whose lookup returned this provider.
getMaximumSize ()in NodeSizeConstraintProvider
getMinimumSize ()in NodeSizeConstraintProvider
calculateMaxTextBoxSize ()in TextEditorInputModeCalculates the maximum size for this instance.
getDefaultNodeSize (MultiPageLayoutContext, any, MultiPageNodeType)in MultiPageElementFactoryReturns the default size for nodes created by this factory.
getPreferredSize (ILabel)in CompositeLabelStyleGets the size from the first style as the reference.
getPreferredSize (ILabel)in DelegatingLabelStyleGets the preferred size of the label from getLabel with the style from getStyle.
getPreferredSize (ILabel, ILabelStyle)in ILabelStyleRendererCalculates the preferredSize of a given label using the associated style.
getPreferredSize (ILabel)in LabelStyleBaseReturns the preferred size of the label.
measureText (string, Font, Size?, TextWrapping?, TextMeasurePolicy?)in TextRenderSupportCalculates the width and height required to render the provided text using the provided Font, taking text-wrapping into account.

Method Parameters

addLabelCore (IGraph, ILabelOwner, string, ILabelModelParameter, ILabelStyle, Size, ILabel['tag'])in LabelCreatorCalled from addLabel and performs the actual label creation in the graph.
from (Size)in ISizeCreates a Size instance from the given size-like object by performing automatic type conversion.
MutableRectangle (Point, Size)in MutableRectangleCreates a new instance using the provided values to initialize the position and size.
convertFrom (Size)in MutableSizePerforms an explicit conversion from Size to MutableSize.
Rect (Point, Size)in RectCreates a new instance using the given location as x and y, and the given size as width and height.
from (Size)in SizeCreates a Size instance from the given size-like object by performing automatic type conversion.
max (Size, Size)in SizeReturns a size whose width and height are the respective maximum of the two provided Size instances.
min (Size, Size)in SizeReturns a size whose width and height are the respective minimum of the two provided Size instances.
FolderNodeDefaults (INodeDefaults?, )in FolderNodeDefaultsCreates a new instance, optionally using all relevant values from the provided nodeDefaults objects.
addLabel (string, ILabelModelParameter?, ILabelStyle?, Size?, ILabel['tag']?)in FolderNodeState
addLabel (string, ILabelModelParameter?, ILabelStyle?, Size?, ILabel['tag']?)in FoldingEdgeState
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.
addLabel (ILabelOwner, string, ILabelModelParameter?, ILabelStyle?, Size?, ILabel['tag']?)in Graph
createUndoUnitForPreferredSizeChange (ILabel, Size)in GraphCreates the undo unit for changing the preferred size of the given label.
onChangingLabelPreferredSize (ILabel, Size)in GraphCalled before the preferred size of a label is being changed.
onLabelPreferredSizeChanged (ILabel, Size)in GraphCalled after the preferred size of a label has changed.
setLabelPreferredSize (ILabel, Size)in Graph
addLabel (ILabelOwner, string, ILabelModelParameter?, ILabelStyle?, Size?, ILabel['tag']?)in GraphWrapperBase
onLabelPreferredSizeChanged (ItemChangedEventArgs<ILabel,Size>)in GraphWrapperBaseRaises the label-preferred-size-changed event.
setLabelPreferredSize (ILabel, Size)in GraphWrapperBase
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.
setLabelPreferredSize (ILabel, Size)in IGraphSets the preferred size of the label.
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.
setLabelPreferredSize (ILabel, Size)in ITableSets the preferred size of the label.
NodeDefaults ()in NodeDefaultsInitializes a new instance of the NodeDefaults class using default properties.
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.
addLabel (IStripe, string, ILabelModelParameter?, ILabelStyle?, Size?, ILabel['tag']?)in Table
setLabelPreferredSize (ILabel, Size)in TableSets the preferred size of the label.
getNodeLayout (Point, Size)in NodeDropInputModeCalculates the layout of the new node.
ReshapeRectangleContext (Rect, ISize, ISize, IRectangle, IRectangle, HandlePositions, Point, Point, Size, ReshapePolicy, number)in ReshapeRectangleContextInitializes a new instance of the ReshapeRectangleContext class.
getPreviewTableLayout (Point, Size)in StripeDropInputModeCalculates the layout of the new table.
adjustSize (Size)in TextEditorInputModeAdjusts the size of the text box in the editorContainer.
ToolTipInputMode ()in ToolTipInputModeCreates a new instance using the provided optional text provider.
LabelCandidate (Point, Size, number?)in LabelCandidateCreates a new instance of LabelCandidate describing a paraxial rectangle with the given location and size.
ComponentLayout (ILayoutAlgorithm?, )in ComponentLayoutInitializes a new instance of the ComponentLayout class with an optional coreLayout.
LayoutExecutorAsync (function(object):Promise<object>, GraphComponent, LayoutDescriptor?, LayoutData<INode,IEdge,ILabel,ILabel>?, )in LayoutExecutorAsyncCreates a new instance of a layout execution helper that will asynchronously perform the calculations and optionally animate the layout on the given graphComponent.
LayoutExecutorAsync (function(object):Promise<object>, IGraph, LayoutDescriptor?, LayoutData<INode,IEdge,ILabel,ILabel>?, )in LayoutExecutorAsyncCreates a new instance of a layout execution helper that will asynchronously perform the calculations and apply the results on the provided graph.
createBestFitRotationStage (Size?)in LayoutTransformationsCreates an ILayoutStage that rotates the LayoutGraph to best fit the given preferredAspectRatio.
TemporaryGroupDescriptor (TemporaryGroupDescriptor?, ILayoutAlgorithm?, )in TemporaryGroupDescriptorCreates a new instance of TemporaryGroupDescriptor using the given descriptor as parent and the ILayoutAlgorithm that is considered by the RecursiveGroupLayout.
MultiPageLayout (ILayoutAlgorithm?, )in MultiPageLayoutCreates a new MultiPageLayout instance.
addFloatingBounds (Size)in OrganicConstraintDataAdds constraints that prevent the specified nodes from occupying an area larger than the defined bounds.
CollapsibleNodeStyleDecorator (INodeStyle?, )in CollapsibleNodeStyleDecoratorInitializes a new instance of the CollapsibleNodeStyleDecorator class using the provided style for the wrappedStyle property.
createButton (IRenderContext, boolean, Size)in CollapsibleNodeStyleDecoratorCreates the button's svg element.
GroupNodeStyle ()in GroupNodeStyleInitializes a new instance.
IconLabelStyle ()in IconLabelStyleCreates a new instance.
LabelStyle ()in LabelStyle
MarkupLabelStyle ()in MarkupLabelStyleCreates a new instance using an ILabelStyleRenderer implementation as renderer.
NodeStylePortStyleAdapter (INodeStyle?, )in NodeStylePortStyleAdapterCreates a port style that uses the provided node style to render the port.
ShapePortStyle ()in ShapePortStyleInitializes a new instance of this class.
addText (SVGGElement | SVGTextElement, string, Font, Size?, TextWrapping?, TextMeasurePolicy?, boolean?, GeneralPath?)in TextRenderSupportAdd the text content to the provided SVG text element.
measureText (string, Font, Size?, TextWrapping?, TextMeasurePolicy?)in TextRenderSupportCalculates the width and height required to render the provided text using the provided Font, taking text-wrapping into account.
TreeMapLayout ()in TreeMapLayoutInitializes a new instance of the TreeMapLayout class with default settings.
fireSizeChanged (Size)in CanvasComponentFires the size changed event.
PatternFill ()in PatternFillInitializes a new instance of the PatternFill class.
PointerEventArgs (PointerEventType?, Point?, PointerButtons?, ModifierKeys?, PointerButtons?, ModifierKeys?, number?, PointerType?, boolean?, number?, Size?, number?, UIEvent?, number?, number?)in PointerEventArgsConstructs a new pointer event argument.
ViewportLimiter ()in ViewportLimiterInitializes a new instance of the ViewportLimiter class.