RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html below:

ShadowCast | API Reference | ArcGIS Maps SDK for JavaScript 4.33

ESM: import ShadowCast from "@arcgis/core/widgets/ShadowCast.js";

CDN: const ShadowCast = await $arcgis.import("@arcgis/core/widgets/ShadowCast.js");

Class: @arcgis/core/widgets/ShadowCast

Since: ArcGIS Maps SDK for JavaScript 4.21

The ShadowCast widget displays the cumulative shadows of 3D features in a SceneView. This type of analysis is helpful in urban development, where new projects have to satisfy certain shadow duration constraints.

The widget calculates the cumulative shadows for a time range during a single day. The user can configure the time range and select a calendar date. This time range and calendar date are only used for the shadow analysis and are not connected to the lighting in the scene. To control the lighting in the scene, the Daylight widget can be used. Changing the timezone in the widget updates the visualization by interpreting the time range as being in that timezone. This behavior is different than for the Daylight widget where selecting a timezone updates the scene date and time according to the camera position.

The widget provides three visualization modes.

In the threshold mode, only the areas that receive shadows for more than a certain amount of time are displayed. In the image below, on May 1, 2021 the red areas receive shadow for more than 4 hours within the time interval of 10AM to 4PM.

Total shadow duration mode displays the duration of the cumulative shadow using opacity: areas that don't receive any shadow are fully transparent and areas that receive a maximum amount of shadow have a default opacity of 0.7. The values in between are interpolated. Hovering over the view will display a tooltip showing the amount of time that location is in shadow, rounded to 15 minute intervals. In this mode, the visualization can display shadow cast in a continuous way or in 1 hour intervals.

Discrete shadows is a third visualization mode which displays individual shadows at a given time interval. For example, setting the time range to 10AM-11AM and the visualization time interval to 30 minutes will display shadows for 10AM, 10:30AM and 11:00AM.

The defaults for the time range and visualization settings can be changed using the ShadowCastViewModel.

Known Limitations

Terrain does not cast shadows and it is therefore not taken into account in this analysis.
The widget does not take into account the daylight savings. Use the timezone dropdown to adjust the offset from the Coordinated Universal Time (UTC) and account for the daylight saving time.
The timezone is automatically detected by the widget based on the camera location. In some situations this might not be accurate. In case of an inaccurate timezone, users can set it manually using the timezone dropdown.

You can use the view's DefaultUI to add widgets to the view's user interface via the ui property on the view. See the example below.

See also

Example

const shadowCast = new ShadowCast({
  view: view
});
// Adds the shadow cast widget in
// the top right corner of the view
view.ui.add(shadowCast, "top-right");

Constructors

ShadowCast Constructor new ShadowCast(properties)

Parameter

optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Show inherited properties Hide inherited properties

Property Details

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 case 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"
});

declaredClass Inherited Property declaredClass Stringreadonly: The name of the class. The declared class name is formatted as esri.folder.className.

headingLevel Property headingLevel Number

Indicates the heading level to use for the titles "Time range" and "Visualization". By default, this message is rendered as level 4 headings (e.g. <h4>Time range</h4>). 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.

Example

shadowCast.headingLevel = 3;

Since: ArcGIS Maps SDK for JavaScript 4.27 ShadowCast since 4.21, icon added at 4.27.: Icon which represents the widget. It is typically used when the widget is controlled by another one (e.g. in the Expand widget).

id Inherited Property id String: 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.

: The widget's default label.

: A reference to the View. This widget is only supported in a SceneView.

: The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the ShadowCastViewModel class to access all properties and methods on the widget.

visible Inherited Property visible Boolean

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".

Example

// Hides the widget in the view
widget.visible = false;

This property provides the ability to display or hide the individual elements of the widget.

Example

shadowCast.visibleElements = {
  timeRangeSlider: true,
  timezone: true,
  datePicker: true,
  visualizationOptions: true,
  colorPicker: true,
  tooltip: true
}

Method Overview

Show inherited methods Hide inherited methods

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

classes Inherited Method classes(classNames){String}

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

Returns

Type Description String The computed class name.

Example

// .tsx syntax showing how to set css classes while rendering the widget

render() {
  const dynamicClasses = {
    [css.flip]: this.flip,
    [css.primary]: this.primary
  };

  return (
    <div class={classes(css.root, css.mixin, dynamicClasses)} />
  );
}

destroy Inherited Method destroy(): Destroys the widget instance.

emit Inherited Method emit(type, event){Boolean}

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

Parameters

The name of the event.

optional

The event payload.

Returns

Type Description Boolean true if a listener was notified

hasEventListener Inherited Method hasEventListener(type){Boolean}

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

Returns

Type Description Boolean Returns true if the class supports the input event.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type Description Boolean Returns true if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

isFulfilled Inherited Method isFulfilled(){Boolean}

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).

isRejected Inherited Method isRejected(){Boolean}

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.

isResolved Inherited Method isResolved(){Boolean}

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.

on Inherited Method on(type, listener){Object}

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

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);
});

postInitialize Inherited Method postInitialize(): Executes after widget is ready for rendering.

removeHandles Inherited Method removeHandles(groupKey) Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

render Inherited Method render(){Object}

This method is implemented by subclasses for rendering.

Returns

Type Description Object The rendered virtual node.

renderNow Inherited Method renderNow(): Renders widget to the DOM immediately.

scheduleRender Inherited Method scheduleRender(): Schedules widget rendering. This method is useful for changes affecting the UI.

when Inherited Method when(callback, errback){Promise}

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters

optional

The function to call when the promise resolves.

optional

The function to execute when the promise fails.

Returns

Type Description Promise Returns a new Promise for the result of callback.

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
});

Type Definitions

VisibleElements Type Definition VisibleElements Accessor

The visible elements that are displayed within the widget. This provides the ability to turn individual elements of the widget's display on/off.

Properties

Default Value:true

When set to false, the slider used to select a time range for the analysis is not displayed.

Default Value:true

When set to false, the dropdown used to select a timezone for the time range is not displayed.

Default Value:true

When set to false, the date picker is not displayed.

Default Value:true

When set to false, the options for the various visualization modes are not displayed.

Default Value:true

When set to false, the color picker is not displayed in the options for any of the visualization modes.

Default Value:true

When set to false, the tooltip with the accumulated shadow time is not displayed when hovering the view.

Default Value:true

When set to false, the discrete shadows configuration in the threshold visualization mode is not displayed.

Default Value:true

When set to false, the discrete shadows toggle in the threshold visualization mode is not displayed. The discrete shadow configuration is not displayed when discreteToggle is set to false and the discrete shadows visualization is turned off.

thresholdContextTimeInterval Boolean

Default Value:true

When set to false, the discrete shadows time interval in the threshold visualization mode is not displayed.

Default Value:true

When set to false, the discrete shadows color picker in the threshold visualization mode is not displayed.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4