documentationfor yFiles for HTML 3.0.0.3

Usages of Insets

Properties

nodeMarginsin CircularLayoutDataGets or sets the mapping from nodes to their margins.
nodeMarginsin CompactDiskLayoutDataGets or sets the mapping from nodes to their margins.
marginsin ExteriorNodeLabelModelGets or sets the margins around the node.
paddingin IStripeGets the padding for this stripe.
totalPaddingin IStripeGets the padding that is currently in effect for this stripe.
paddingin IStripeDefaultsGets or sets the default padding for a stripe.
accumulatedPaddingin ITableReturns the accumulated padding for the table.
paddingin ITableGets or sets the padding for this table.
paddingin InteriorNodeLabelModelGets or sets the padding to use within the node's layout.
paddingin StretchNodeLabelModelGets or sets the padding to use within the node's layout.
paddingin StretchStripeLabelModelGets or sets the padding to use within the stripe's layout.
paddingin StripeDefaultsGets or sets the default padding for a stripe.
paddingin Table
nodeMarginsin HierarchicalLayoutDataGets or sets the mapping from nodes to their margins.
contentMarginsin GraphEditorInputModeGets or sets the margins to use for updateContentBounds in adjustContentBounds calls.
paddingin GroupPaddingProviderGets or sets the padding returned by getPadding.
contentMarginsin OverviewInputModeGets and sets the margins in view coordinates that should be used by the updateVisibleArea operation.
textBoxMarginsin TextEditorInputModeGets or sets the margins to use around the editorContainer when it comes near to the viewport borders and needs to be adjusted.
nodeMarginsin GenericLabelingDataGets or sets the mapping from nodes to their margins.
nodeMarginsin AlignmentStageDataGets or sets the mapping from nodes to their margins.
nodeMarginsin ComponentLayoutDataGets or sets the mapping from nodes to their margins.
defaultPaddingin GroupBoundsCalculatorGets or sets the default padding that will be used if the IMapper<K,V> registered with the data key GROUP_NODE_PADDING_DATA_KEY does not contain a mapping for a specific node.
targetBoundsPaddingin LayoutExecutorGets or sets the padding (in world coordinates) that will be added to the content bounds when calculating the target viewport.
targetBoundsPaddingin LayoutExecutorAsyncGets or sets the padding (in world coordinates) that will be added to the content bounds when calculating the target viewport.
nodeMarginsin RadialGroupLayoutDataGets or sets the mapping from nodes to their margins.
nodeMarginsin RecursiveGroupLayoutDataGets or sets the mapping from nodes to their margins.
nodeMarginsin TabularLayoutDataGets or sets the mapping from nodes to their margins.
marginsin TemporaryGroupDescriptorGets or sets the margins of this temporary group.
paddingin TemporaryGroupDescriptorGets or sets the padding of this temporary group.
nodeMarginsin OrganicLayoutDataGets or sets the mapping from nodes to their margins.
nodeMarginsin OrthogonalLayoutDataGets or sets the mapping from nodes to their margins.
nodeMarginsin ClearAreaLayoutDataGets or sets the mapping from nodes to their margins.
nodeMarginsin FillAreaLayoutDataGets or sets the mapping from nodes to their margins.
nodeMarginsin PartialLayoutDataGets or sets the mapping from nodes to their margins.
nodeMarginsin RadialLayoutDataGets or sets the mapping from nodes to their margins.
nodeMarginsin CurveRoutingStageDataGets or sets the mapping from nodes to their margins.
nodeMarginsin EdgeRouterDataGets or sets the mapping from nodes to their margins.
paddingin CollapsibleNodeStyleDecoratorGets or sets the padding to use for the IGroupPaddingProvider that will be reported by the renderer's ILookup.
contentAreaPaddingin GroupNodeStyleGets or sets the padding of the content area for this style.
wrappedStylePaddingin IconLabelStyleGets or sets the padding that should be applied for the layout of the wrappedStyle style rendering.
paddingin LabelStyleGets or sets the padding for the label.
paddingin MarkupLabelStyleGets or sets the padding of the label.
labelStylePaddingin NodeStyleLabelStyleAdapterGets or sets the padding to apply for the labelStyle.
nodeMarginsin RadialTreeLayoutDataGets or sets the mapping from nodes to their margins.
nodeMarginsin TreeLayoutDataGets or sets the mapping from nodes to their margins.
autoScrollPaddingin CanvasComponentGets or sets the distance from the edge of the viewport, in which auto-scrolling should happen.
contentMarginsin CanvasComponentGets and sets the margins in view coordinates that should be used by the fitContent operation or zoom commands which zoom to a given rectangle.
marginsin LabelStyleIndicatorRendererGets or sets the margins around the label layout.
marginsin NodeStyleIndicatorRendererGets or sets the margins around the node layout.
marginsin SvgExportGets or sets the margins for the exported image.
targetMarginsin ViewportAnimationGets or sets the margins in view coordinate dimensions to use at the target zoom level.
viewportContentMarginsin ViewportLimiterGets or sets the margins in the view coordinate system around the tight bounds in world coordinates.
paddingin WebGLIconLabelStyleGets the padding of the text within the label's bounds.
paddingin WebGLLabelStyleGets the padding of the text within the label's bounds.

Fields

EMPTYin InsetsThe "empty" insets that have all properties set to 0.0d.
GROUP_NODE_PADDING_DATA_KEYin LayoutKeysGets a NodeDataKey<TValue> used for specifying the padding around the contents of group nodes.
NODE_MARGIN_DATA_KEYin LayoutKeysA data key for assigning margins for the nodes.

Method Return Values

createUnion (Insets)in InsetsCalculates the union of this instance and the given inset which is done by performing Math.max on all four inset values.
divide (Insets, number)in InsetsDivides each side of the insets by the given factor.
from (Insets)in InsetsCreates a Insets instance from the given insets-like object by performing automatic type conversion.
getEnlarged (Insets)in InsetsCreates an enlarged instance by adding the insets of the specified insets to this instance and returning the result.
getReduced (Insets)in InsetsCreates a reduced instance by subtracting the insets of the specified insets from this instance and returning the result.
multiply (Insets, number)in InsetsMultiplies each side of the insets by the given factor and returns the result.
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.
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.
getPadding ()in GroupPaddingProvider
getPadding ()in IGroupPaddingProviderReturns the padding for the node whose lookup returned this provider.

Method Parameters

CircularLayoutData ()in CircularLayoutDataCreates a new instance of CircularLayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> which helps configuring CircularLayout.
CompactDiskLayoutData ()in CompactDiskLayoutData
getEnlarged (Insets)in IOrientedRectangleCreates an enlarged instance that is the same as this one but enlarged by the specified padding.
createUnion (Insets)in InsetsCalculates the union of this instance and the given inset which is done by performing Math.max on all four inset values.
divide (Insets, number)in InsetsDivides each side of the insets by the given factor.
from (Insets)in InsetsCreates a Insets instance from the given insets-like object by performing automatic type conversion.
getEnlarged (Insets)in InsetsCreates an enlarged instance by adding the insets of the specified insets to this instance and returning the result.
getReduced (Insets)in InsetsCreates a reduced instance by subtracting the insets of the specified insets from this instance and returning the result.
multiply (Insets, number)in InsetsMultiplies each side of the insets by the given factor and returns the result.
getEnlarged (Insets)in RectCreates an instance enlarged by the specified insets.
getReduced (Insets)in RectCreates an instance reduced by the specified insets.
ExteriorNodeLabelModel ()in ExteriorNodeLabelModelCreates a new instance of this model
createChildColumn (IColumn, number?, number?, Insets?, IStripeStyle?, IColumn['tag']?, number?, )in ITableCreate a new column as the indexth child of parent with the given parameters.
createChildRow (IRow, number?, number?, Insets?, IStripeStyle?, IRow['tag']?, number?, )in ITableCreate a new row as the indexth child of parent with the given parameters.
createColumn (number?, number?, Insets?, IStripeStyle?, IColumn['tag']?, number?)in ITableCreates and returns a column as last child of table.
createRow (number?, number?, Insets?, IStripeStyle?, IRow['tag']?, number?)in ITableCreates and returns a row as last child of table.
setStripePadding (IStripe, Insets)in ITableSets the padding of stripe.
InteriorNodeLabelModel ()in InteriorNodeLabelModelCreates a new instance of this model with zero margins.
StretchNodeLabelModel ()in StretchNodeLabelModelCreates a new instance of this model.
StretchStripeLabelModel ()in StretchStripeLabelModelCreates a new instance of this model.
StripeDefaults ()in StripeDefaultsDefault constructor
Table ()in TableDefault constructor that creates an empty table
createChildColumn (IColumn, number?, number?, Insets?, IStripeStyle?, IColumn['tag']?, number?, )in Table
createChildRow (IRow, number?, number?, Insets?, IStripeStyle?, IRow['tag']?, number?, )in Table
setStripePadding (IStripe, Insets)in Table
HierarchicalLayoutData ()in HierarchicalLayoutData
GraphEditorInputMode ()in GraphEditorInputModeCreates a new instance that is not bound to an existing graph or selection, initially.
GroupPaddingProvider (Insets)in GroupPaddingProviderCreates a new instance using the provided padding.
OverviewInputMode ()in OverviewInputModeCreates a new instance.
TextEditorInputMode (HTMLDivElement?, )in TextEditorInputModeCreates a new instance using a default text box or the provided editor.
GenericLabelingData ()in GenericLabelingData
AlignmentStageData ()in AlignmentStageData
ComponentLayoutData ()in ComponentLayoutData
LayoutExecutor (GraphComponent, ILayoutAlgorithm, )in LayoutExecutorInitializes a new instance of the LayoutExecutor class.
LayoutExecutor (GraphComponent, IGraph, ILayoutAlgorithm, )in LayoutExecutorInitializes a new instance of the LayoutExecutor class.
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.
RadialGroupLayoutData ()in RadialGroupLayoutData
RecursiveGroupLayoutData ()in RecursiveGroupLayoutData
TabularLayoutData ()in TabularLayoutData
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.
OrganicLayoutData ()in OrganicLayoutData
OrthogonalLayoutData ()in OrthogonalLayoutData
ClearAreaLayoutData ()in ClearAreaLayoutData
FillAreaLayoutData ()in FillAreaLayoutData
PartialLayoutData ()in PartialLayoutData
RadialLayoutData ()in RadialLayoutData
CurveRoutingStageData ()in CurveRoutingStageData
EdgeRouterData ()in EdgeRouterData
CollapsibleNodeStyleDecorator (INodeStyle?, )in CollapsibleNodeStyleDecoratorInitializes a new instance of the CollapsibleNodeStyleDecorator class using the provided style for the wrappedStyle property.
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.
NodeStyleLabelStyleAdapter (INodeStyle?, ILabelStyle?, )in NodeStyleLabelStyleAdapterCreates a label style that uses the provided node style to render the background and the label style to render the foreground of this style.
RadialTreeLayoutData ()in RadialTreeLayoutData
TreeLayoutData ()in TreeLayoutData
ensureVisible (Rect, Insets?, ViewportLimitingMode?)in CanvasComponentEnsures that the provided bounds in world coordinates are visible by adjusting the viewport accordingly.
ensureVisible (IEnumerable<Point>, Insets?, ViewportLimitingMode?)in CanvasComponentEnsures that the provided points in world coordinates are all visible by adjusting the viewport accordingly.
updateContentBounds (Insets?, IRenderTreeGroup?)in CanvasComponentUpdates the contentBounds to encompass the bounds of all elements in the current scene graph plus the given margins.
GraphComponent (HTMLElement, )in GraphComponentCreates a new instance of the GraphComponent in the given div element.
GraphComponent ()in GraphComponentCreates a new instance of the GraphComponent.
GraphComponent (string, )in GraphComponentCreates a new instance of GraphComponent using the div element that is specified by the selector.
applyLayoutAnimated (ILayoutAlgorithm, TimeSpan?, LayoutData<INode,IEdge,ILabel,ILabel>?, TimeSpan?, TimeSpan?, boolean?, ItemMapping<IPort,PortAdjustmentPolicy>?, ItemMapping<IPort,PortPlacementPolicy>?, ItemMapping<ILabel,PortLabelPolicy>?, ItemMapping<IModelItem,LayoutAnchoringPolicy>?, Insets?, ItemMapping<ILabel,LabelPlacementPolicy>?, function(INode, INode):number?, function(IEdge, IEdge):number?)in GraphComponentRuns a layout on the graph of the GraphComponent and animates the transition.
fitGraphBounds (Insets?, boolean?)in GraphComponentUpdates the content bounds for the contentGroup considering the provided margins and adjusts the viewport to encompass the contents.
LabelStyleIndicatorRenderer ()in LabelStyleIndicatorRendererCreate a new instance of this class.
NodeStyleIndicatorRenderer ()in NodeStyleIndicatorRendererCreate a new instance of this class.
SvgExport (Rect, number?, )in SvgExportCreates a new SvgExport instance for the given world bounds and scale.
ViewportAnimation (CanvasComponent, Rect, TimeSpan, )in ViewportAnimationCreates a new instance of ViewportAnimation.
ViewportLimiter ()in ViewportLimiterInitializes a new instance of the ViewportLimiter class.
WebGLIconLabelStyle (ImageData, Color?, Color?, WebGLStroke?, Insets?, WebGLLabelShape?, WebGLEffect?, WebGLTextureRendering?)in WebGLIconLabelStyleCreates a new icon label style that is rendered with WebGL2.
WebGLLabelStyle (Font?, Color?, Color?, WebGLStroke?, HorizontalTextAlignment?, Insets?, WebGLLabelShape?, WebGLEffect?, number?, WebGLTextureRendering?, TextWrapping?, TextWrappingShape?, number?, VerticalTextAlignment?)in WebGLLabelStyleCreates a new label style that is rendered with WebGL2.