Layer$Typings extension

on

Properties

allowCopy bool
Gets or sets whether the user may copy objects in this layer. The initial value is true.
getter/setter pair
allowDelete bool
Gets or sets whether the user may delete objects in this layer. The initial value is true.
getter/setter pair
allowGroup bool
Gets or sets whether the user may group parts together in this layer. The initial value is true.
getter/setter pair
Gets or sets whether the user may draw new links in this layer. The initial value is true.
getter/setter pair
allowMove bool
Gets or sets whether the user may move objects in this layer. The initial value is true.
getter/setter pair
Gets or sets whether the user may reconnect existing links in this layer. The initial value is true.
getter/setter pair
allowReshape bool
Gets or sets whether the user may reshape parts in this layer. The initial value is true.
getter/setter pair
allowResize bool
Gets or sets whether the user may resize parts in this layer. The initial value is true.
getter/setter pair
allowRotate bool
Gets or sets whether the user may rotate parts in this layer. The initial value is true.
getter/setter pair
allowSelect bool
Gets or sets whether the user may select objects in this layer. The initial value is true.
getter/setter pair
allowTextEdit bool
Gets or sets whether the user may do in-place text editing in this layer. The initial value is true.
getter/setter pair
allowUngroup bool
Gets or sets whether the user may ungroup existing groups in this layer. The initial value is true.
getter/setter pair
diagram Diagram?
This read-only property returns the Diagram that is using this Layer.
getter/setter pair
isInDocumentBounds bool
Gets or sets whether or not a layer is included in the documentBounds computation. Default value is true. However, setting #isTemporary to true also sets this property to false before version 3.
getter/setter pair
isTemporary bool
Gets or sets whether the objects in this layer are considered temporary.
getter/setter pair
name String
Gets or sets the name for this layer. The initial value is an empty string, which is also the name of the default layer. The name should be unique among the diagram's Diagram#layers.
getter/setter pair
opacity num
Gets or sets the opacity for all parts in this layer. The value must be between 0.0 (fully transparent) and 1.0 (no additional transparency). This value is multiplicative with any existing transparency, for instance from a Brush or image transparency. The default value is 1.
getter/setter pair
parts Iterator<Part>
This read-only property returns an iterator for this Layer's Parts. The Parts can be Nodes, Links, Groups, Adornments, or simple Parts.
getter/setter pair
partsBackwards Iterator<Part>
This read-only property returns a backwards iterator for this Layer's Parts, for iterating over the parts in reverse order. The Parts can be Nodes, Links, Groups, Adornments, or simple Parts.
getter/setter pair
pickable bool
Gets or sets whether methods such as #findObjectAt find any of the objects in this layer.
getter/setter pair
visible bool
Gets or sets whether the user may view any of the objects in this layer.
getter/setter pair

Methods

findObjectAt<T extends GraphObject>(Point p, [T? navig(GraphObject)?, bool pred(T)?]) → T?
Find the front-most GraphObject in this layer at the given point in document coordinates.
findObjectsAt<T extends GraphObject, S extends Iterable<T>>(Point p, [T? navig(GraphObject)?, bool pred(T)?, S? coll]) → S
Return a collection of the GraphObjects of this layer at the given point in document coordinates.
findObjectsIn<T extends GraphObject, S extends Iterable<T>>(Rect r, [T? navig(GraphObject)?, bool pred(T)?, bool? partialInclusion, S? coll]) → S
Returns a collection of all GraphObjects that are inside or that intersect a given Rect in document coordinates.
findObjectsNear<T extends GraphObject, S extends Iterable<T>>(Point p, num dist, [T? navig(GraphObject)?, bool pred(T)?, Object? partialInclusion, S? coll]) → S
Returns a collection of all GraphObjects that are within a certain distance of a given point in document coordinates.