Skip To ContentArcGIS for DevelopersSign In Dashboard
require(["esri/widgets/Slice"], function(Slice) { /* code goes here */ });
Class: esri/widgets/Slice
Inheritance: Slice Widget Accessor
Since: ArcGIS API for JavaScript 4.10

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.

slice-widget

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. When you click a surface or object in your scene, you create a slice with either a horizontal or vertical plane. 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, rotation and position of the slice plane.

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-widget-exclude

The visualizations created using slices are temporary and cannot be persisted in a WebScene or in slides.

Known Limitations

Slice only works with SceneView.

For information about gaining full control of widget styles, see the Styling topic.
See also:

Constructors

new Slice(properties)
Parameter:
properties Object
optional

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

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String|HTMLElement

The ID or node representing the DOM element containing the widget.

more details
more detailsWidget
String

The name of the class.

more details
more detailsAccessor
Boolean

When true, this property indicates whether the widget has been destroyed.

more details
more detailsWidget
String

The unique ID assigned to the widget when the widget is created.

more details
more detailsWidget
String

The widget's label.

more details
more detailsWidget
SceneView

A reference to the SceneView.

more details
more detailsSlice
SliceViewModel

The view model for this widget.

more details
more detailsSlice

Property Details

The ID or node representing the DOM element containing the widget. This property can only be set once.

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

destroyed Boolean inherited

When true, this property indicates whether the widget has been destroyed.

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.

Since: ArcGIS API for JavaScript 4.11

The widget's label.

This property is useful whenever the widget is controlled by another one (e.g. Expand)

A reference to the SceneView. Set this to link the widget to a specific view.

The view model for this widget. This is a class that contains the properties and methods that control this widget's behavior.

Method Overview

NameReturn TypeSummaryClass
String

A utility method used for building the value for a widget's class property.

more details
more detailsWidget

Destroys the widget instance.

more details
more detailsWidget
Boolean

Emits an event on the instance.

more details
more detailsWidget
Boolean

Indicates whether there is an event listener on the instance that matches the provided event name.

more details
more detailsWidget
Object

Registers an event handler on the instance.

more details
more detailsWidget

Widget teardown helper.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget
Object

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Renders widget to the DOM immediately.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Method Details

classes(classNames){String}inherited

A utility method used for building the value for a widget's class property. This aids in simplifying CSS class setup.

Parameter:
classNames (String|String[]|Object)[]
repeatable

The class names.

Returns:
TypeDescription
StringThe 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.

emit(type, event){Boolean}inherited

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters:
type String

The name of the event.

event Object
optional

The event payload.

Returns:
TypeDescription
Booleantrue if a listener was notified
hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:
type String

The name of the event.

Returns:
TypeDescription
BooleanReturns true if the class supports the input event.
on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters:

A event type, or an array of event types, to listen for.

listener Function

The function to call when the event is fired.

Returns:
TypeDescription
ObjectReturns an event handler with a remove() method that can be called to stop listening for the event(s).
PropertyTypeDescription
removeFunctionWhen 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 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.

render(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns:
TypeDescription
ObjectThe 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.

API Reference search results

NameTypeModule
Loading...