The slice widget is a 3D analysis tool that can be used to reveal occluded content in a SceneView. The slice widget can be applied to any layer type, making it possible to see inside buildings or to explore geological surfaces.
To use the widget, instantiate it and add it to the view:
const slice = new Slice({
view: view
});
// Add widget to the bottom left corner of the view
view.ui.add(slice, {
position: "bottom-left"
});
The slicing shape is always a plane.
By default, the plane is either horizontal or vertical. To allow a tilt angle for the
plane, set SliceViewModel.tiltEnabled to true
.
The slice hides any content in front of the surface. The handles on the sides
of the plane can be used to adjust the size, heading, tilt and position of the slice plane. The SlicePlane can be set or retrieved using
SliceViewModel.shape.
Once a slice is created, layers can be excluded from the slice. For example, to look at interior elements inside a BuildingSceneLayer, the windows or furniture layers can be excluded from the slice widget.
Slice only works with SceneView. The visualizations created using slices are temporary and cannot be persisted in a WebScene or in slides.
Constructors
-
new Slice(properties)
-
Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Example:// typical usage const slice = new Slice({ view: view });
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
SliceAnalysis | more details The slice analysis object being created or modified by the widget. | more details | Slice | |
String|HTMLElement | more details The ID or node representing the DOM element containing the widget. | more details | Widget | |
String | more details The name of the class. | more details | Accessor | |
Number | more details Indicates the heading level to use for the "Excluded layers" heading. | more details | Slice | |
String | more details The widget's default CSS icon class. | more details | Slice | |
String | more details The unique ID assigned to the widget when the widget is created. | more details | Widget | |
String | more details The widget's default label. | more details | Slice | |
SceneView | more details A reference to the SceneView. | more details | Slice | |
SliceViewModel | more details The view model for this widget. | more details | Slice | |
Boolean | more details Indicates whether the widget is visible. | more details | Widget |
Property Details
-
Since: ArcGIS API for JavaScript 4.23
-
The slice analysis object being created or modified by the widget. This property is an alias for SliceViewModel.analysis.
This property can be set during widget construction, to provide an existing analysis to the widget for modification. Properties on the analysis can also be modified once it's assigned to the widget.
If no analysis is provided during widget construction, the widget automatically creates its own analysis and adds it to the view. In this case, the analysis will also be automatically removed from the view when the widget is destroyed.
- See also:
Example:// Construct a slice analysis object outside of the widget const analysis = new SliceAnalysis({ shape: { type: "plane", // autocasts as new SlicePlane() position: { type: "point", x: -0.1, y: 51.5 }, width: 50, height: 50, tilt: 45 }, tiltEnabled: true }); // Ensure that the analysis is added to the view view.analyses.add(analysis); // Frame the analysis in the view view.goTo(analysis.extent); // Pass the analysis object as a constructor parameter to modify it using the widget const widget = new Slice({ analysis: analysis, view: view });
-
-
The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use cases when working with widgets.
Examples:// Create the HTML div element programmatically at runtime and set to the widget's container const basemapGallery = new BasemapGallery({ view: view, container: document.createElement("div") }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" });
// Specify an already-defined HTML div element in the widget's container const basemapGallery = new BasemapGallery({ view: view, container: basemapGalleryDiv }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" }); // HTML markup <body> <div id="viewDiv"></div> <div id="basemapGalleryDiv"></div> </body>
// Specify the widget while adding to the view's UI const basemapGallery = new BasemapGallery({ view: view }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" });
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
headingLevel NumberSince: ArcGIS API for JavaScript 4.20
-
Indicates the heading level to use for the "Excluded layers" heading. By default, this is rendered as a level 3 heading (e.g.
<h3>Excluded layers</h3>
). Depending on the widget's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.- Default Value:3
- See also:
Example:slice.headingLevel = 2;
-
iconClass String
-
The widget's default CSS icon class.
-
The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.
-
label String
-
The widget's default label. This label displays when it is used within another widget, such as the Expand or LayerList widgets.
-
viewModel SliceViewModelautocast
-
The view model for this widget. This is a class that contains the properties and methods that control this widget's behavior.
-
Indicates whether the widget is visible.
If
false
, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the view UI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the CSS display value of"none"
.- Default Value:true
Example:// Hides the widget in the view widget.visible = false;
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
String | more details A utility method used for building the value for a widget's | more details | Widget | |
more details Destroys the widget instance. | more details | Widget | ||
Boolean | more details Emits an event on the instance. | more details | Widget | |
Boolean | more details Indicates whether there is an event listener on the instance that matches the provided event name. | more details | Widget | |
Boolean | more details
| more details | Widget | |
Boolean | more details
| more details | Widget | |
Boolean | more details
| more details | Widget | |
Object | more details Registers an event handler on the instance. | more details | Widget | |
more details Widget teardown helper. | more details | Widget | ||
more details This method is primarily used by developers when implementing custom widgets. | more details | Widget | ||
Object | more details This method is primarily used by developers when implementing custom widgets. | more details | Widget | |
more details Renders widget to the DOM immediately. | more details | Widget | ||
more details This method is primarily used by developers when implementing custom widgets. | more details | Widget | ||
Promise | more details
| more details | Widget |
Method Details
-
A utility method used for building the value for a widget's
class
property. This aids in simplifying CSS class setup.Parameter:repeatable The class names.
Returns:Type Description String The computed class name. - See also:
Example:// .tsx syntax showing how to set CSS classes while rendering the widget render() { const dynamicIconClasses = { [CSS.myIcon]: this.showIcon, [CSS.greyIcon]: !this.showIcon }; return ( <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} /> ); }
-
destroy()inherited
-
Destroys the widget instance.
-
Emits an event on the instance. This method should only be used when creating subclasses of this class.
Parameters:type StringThe name of the event.
event ObjectoptionalThe event payload.
Returns:Type Description Boolean true
if a listener was notified
-
Indicates whether there is an event listener on the instance that matches the provided event name.
Parameter:type StringThe name of the event.
Returns:Type Description Boolean Returns true if the class supports the input event.
-
Since: ArcGIS API for JavaScript 4.19
-
isFulfilled()
may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled,true
will be returned.Returns:Type Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
-
Since: ArcGIS API for JavaScript 4.19
-
isRejected()
may be used to verify if creating an instance of the class is rejected. If it is rejected,true
will be returned.Returns:Type Description Boolean Indicates whether creating an instance of the class has been rejected.
-
Since: ArcGIS API for JavaScript 4.19
-
isResolved()
may be used to verify if creating an instance of the class is resolved. If it is resolved,true
will be returned.Returns:Type Description Boolean Indicates whether creating an instance of the class has been resolved.
-
Registers an event handler on the instance. Call this method to hook an event with a listener.
Parameters:An event or an array of events to listen for.
listener FunctionThe function to call when the event fires.
Returns:Type Description Object Returns an event handler with a remove()
method that should be called to stop listening for the event(s).Property Type Description remove Function When called, removes the listener from the event. Example:view.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint); });
-
own(handles)inherited
-
Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.
Parameter:handles WatchHandle|WatchHandle[]Handles marked for removal once the widget is destroyed.
-
postInitialize()inherited
-
This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.
-
This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.
Returns:Type Description Object The rendered virtual node.
-
renderNow()inherited
-
Renders widget to the DOM immediately.
-
scheduleRender()inherited
-
This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.
-
Since: ArcGIS API for JavaScript 4.19
-
when()
may be leveraged once an instance of the class is created. This method takes two input parameters: acallback
function and anerrback
function. Thecallback
executes when the instance of the class loads. Theerrback
executes if the instance of the class fails to load.Parameters:callback FunctionoptionalThe function to call when the promise resolves.
errback FunctionoptionalThe function to execute when the promise fails.
Returns:Type Description Promise Returns a new promise for the result of callback
that may be used to chain additional functions.Example:// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way let bmGallery = new BasemapGallery(); bmGallery.when(function(){ // This function will execute once the promise is resolved }, function(error){ // This function will execute if the promise is rejected due to an error });