EnvelopeBuilder class final

The envelope builder allows you to create and modify envelope geometries incrementally.

Envelope geometries are immutable and cannot be changed directly once created. Use the constructors to define minimum and maximum x,y coordinates, z and m values, and a SpatialReference. Once set, the SpatialReference cannot be changed. Use GeometryBuilder.toGeometry to return the new Envelope from the builder.

Inheritance

Constructors

EnvelopeBuilder({SpatialReference? spatialReference})
Creates an envelope builder.
factory
EnvelopeBuilder.fromCenter(ArcGISPoint center, {required double width, required double height, double? depth})
Creates an envelope builder from a center point and a width, height, and depth.
factory
EnvelopeBuilder.fromEnvelope(Envelope envelope)
Creates an envelope builder from the specified Envelope.
factory

Properties

center → ArcGISPoint
The center point of the Envelope being constructed.
no setter
depth → double
The depth of the Envelope being constructed.
no setter
extent → Envelope
The extent for the geometry being constructed in the geometry builder.
no setterinherited
hasCurves → bool
True if the geometry builder currently contains any curve segments, false otherwise.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
hasM → bool
True if the geometry builder supports geometries with m values, false otherwise.
no setterinherited
hasZ → bool
True if the geometry builder supports geometries with z values, false otherwise.
no setterinherited
height → double
The height of the Envelope being constructed.
no setter
isEmpty → bool
True if no coordinates have been added to this geometry builder, false otherwise.
no setterinherited
isSketchValid → bool
True if the geometry builder contains sufficient points to show a valid graphical sketch, false otherwise.
no setterinherited
mMax ↔ double
The m maximum value of the Envelope being constructed.
getter/setter pair
mMin ↔ double
The m minimum value of the Envelope being constructed.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
spatialReference → SpatialReference?
The spatial reference for the geometry.
no setterinherited
width → double
The width of the Envelope being constructed.
no setter
xMax ↔ double
The x maximum value of the Envelope being constructed.
getter/setter pair
xMin ↔ double
The x minimum value of the Envelope being constructed.
getter/setter pair
yMax ↔ double
The y maximum value of the Envelope being constructed.
getter/setter pair
yMin ↔ double
The y minimum value of the Envelope being constructed.
getter/setter pair
zMax ↔ double
The z maximum value of the Envelope being constructed.
getter/setter pair
zMin ↔ double
The z minimum value of the Envelope being constructed.
getter/setter pair

Methods

centerAt(ArcGISPoint point) → void
Centers the envelope at the specified point.
changeAspectRatio({required double width, required double height}) → void
Adjust the envelope's aspect ratio to match the ratio of the given width and height.
expandBy(double factor, {ArcGISPoint? anchor}) → void
Expands the envelope at the anchor point by the given factor.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
offsetBy({required double offsetX, required double offsetY}) → void
Moves the builder's envelope geometry by the given offsets in the x and y dimension.
replaceGeometry(Geometry? geometry) → void
Replaces the geometry currently stored in the geometry builder with the new geometry.
inherited
setM({required double mMin, required double mMax}) → void
Set the m-values for the envelope.
setXY({required double xMin, required double yMin, required double xMax, required double yMax}) → void
Set the x,y coordinates for the envelope.
setZ({required double zMin, required double zMax}) → void
Set the z-values for the envelope.
toGeometry() → Geometry
Returns Geometry that the geometry builder is constructing or modifying.
inherited
toString() → String
A string representation of this object.
inherited
unionWithEnvelope(Envelope envelope) → void
Finds the union of the builder's envelope and the specified envelope and updates the envelope builder with the result.
unionWithPoint(ArcGISPoint point) → void
Finds the union of the builder's envelope and the specified point and updates the envelope builder with the result.

Operators

operator ==(Object other) → bool
The equality operator.
inherited