SliceViewModel
require(["esri/widgets/Slice/SliceViewModel"], function(SliceViewModel) { /* code goes here */ });
esri/widgets/Slice/SliceViewModel
Provides the logic for the Slice widget.
Constructors
- new SliceViewModel(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | The name of the class. more details | more details | Accessor | |
Collection<(Layer|BuildingComponentSublayer)> | Add layers to this collection to exclude them from the slice. more details | more details | SliceViewModel | |
Boolean | Indicates whether the Ground and layers that are draped on the ground surface are excluded from the slice. more details | more details | SliceViewModel | |
String | The view model's state. more details | more details | SliceViewModel | |
SceneView | The view from which the widget will operate. more details | more details | SliceViewModel |
Property Details
The name of the class. The declared class name is formatted as
esri.folder.className
.
- excludedLayers Collection<(Layer|BuildingComponentSublayer)>
Add layers to this collection to exclude them from the slice. Layers that are draped on the ground surface are not affected by this property
- excludeGroundSurface Boolean
Indicates whether the Ground and layers that are draped on the ground surface are excluded from the slice.
- Default Value:false
- state Stringreadonly
The view model's state.
Value Description disabled not ready yet ready ready for slicing slicing currently slicing sliced finished slicing Possible Values:"disabled"|"ready"|"slicing"|"sliced"
- Default Value:disabled
- view SceneView
The view from which the widget will operate.
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
Clears the current slice. more details | more details | SliceViewModel | ||
Starts a new slice. more details | more details | SliceViewModel |
Method Details
- clearSlice()
Clears the current slice.
- newSlice()
Starts a new slice.