arcgis-shadow-cast

Since

ArcGIS Maps SDK for JavaScript 5.0

The ShadowCastAnalysis created or modified by the component.

When connecting the Shadow Cast component to the arcgis-scene component, it automatically creates an empty analysis and adds it to the arcgis-scene.analyses collection. You can then wait for the ShadowCastAnalysisView3D to be created before accessing the analysis results.

// Get the Scene component and the Shadow Cast component, and wait until both are ready.
const viewElement = document.querySelector("arcgis-scene");
await viewElement.viewOnReady();
const shadowCastElement = document.querySelector("arcgis-shadow-cast");
await shadowCastElement.componentOnReady();

// Get the ShadowCastAnalysis created by the Shadow Cast component.
const analysis = shadowCastElement.analysis;

// Get the ShadowCastAnalysisView3D.
const analysisView = await viewElement.whenAnalysisView(analysis);

// Click in the Scene and get the shadow duration in that specific point.
viewElement.addEventListener("arcgisViewClick", async (event) => {
  const screenPoint = { x: event.detail.x, y: event.detail.y };
  const duration = await analysisView.getDurationAtScreen(screenPoint);
  console.log("Shadow duration (minutes):", duration);
});

Whenever the component is destroyed, the analysis is automatically removed from the collection.

Alternatively, a programmatically created ShadowCastAnalysis can be provided to the component. Then, the application itself needs to add it to and later remove it from the analyses collection of the Scene component.

// Create the ShadowCastAnalysis.
const analysis = new ShadowCastAnalysis();

// Get the Scene component and the Shadow Cast component, and wait until both are ready.
const viewElement = document.querySelector("arcgis-scene");
await viewElement.viewOnReady();
const shadowCastElement = document.querySelector("arcgis-shadow-cast");
await shadowCastElement.componentOnReady();

// Add the analysis to the analyses collection of the Scene component.
viewElement.analyses.add(analysis);

// Connect the analysis to the shadow cast component.
shadowCastElement.analysis = analysis;

If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the destroy() method when you are done to prevent memory leaks.

The calendar date used to calculate the shadow cast. This date excludes the time. If a date with a time is set, the time value will be set to midnight (00:00:00) of that date in local system time. If no date is set, then it defaults to the current date in local system time.

See also

• Date

Since

ArcGIS Maps SDK for JavaScript 5.0

Color of the shadow visualization in "discrete" mode. The opacity of the visualization is mapped to the number of overlapping shadows. No shadow corresponds to opacity 0 and maximum number of shadows corresponds to the opacity set in this color value.

Since

ArcGIS Maps SDK for JavaScript 5.0

Individual shadows are displayed at this time interval in "discrete" mode, starting with the start time of day. The interval is expressed in milliseconds. If set to 0, we'll use the smallest possible interval, up to a maximum of 255 samples.

Time (in milliseconds from midnight of the date) when the shadow cast computation should stop.

Read more

Indicates the heading level to use for the component title.

If true, the date picker will be hidden.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the color picker will be hidden in the discrete mode options.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the interval selector will be hidden in the discrete mode options.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the visualization options will be hidden in discrete mode.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the color picker will be hidden in the minimum duration mode options.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the color picker will be hidden in the context options in minimum duration mode.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the interval selector will be hidden in the context options in minimum duration mode.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the context options will be hidden in the minimum duration mode options.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the toggle used to show or hide the context options will be hidden.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the visualization options will be hidden in minimum duration mode.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the minimum duration slider will be hidden in the minimum duration mode options.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the tooltip which displays the amount of shadow at a certain location will be hidden.

If true, the time range slider will be hidden.

If true, the timezone picker will be hidden.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the color picker will be hidden in the total duration mode options.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the mode selector will be hidden in the total duration mode options.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the visualization options will be hidden in the total duration mode.

Since

ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the component's visualization is hidden in the view.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the visualization options will be hidden.

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).

See also

• Calcite Icons

The component's default label.

Since

ArcGIS Maps SDK for JavaScript 5.0

Maximum allowed value for the minDuration property, in milliseconds.

Since

ArcGIS Maps SDK for JavaScript 5.0

The minimum duration (in milliseconds) used in "min-duration" mode to determine which shadow areas are displayed.

Since

ArcGIS Maps SDK for JavaScript 5.0

Color of the shadow visualization in "min-duration" mode. The areas with cumulative shadow time longer than the minimum duration value are displayed with this color.

Since

ArcGIS Maps SDK for JavaScript 5.0

The color used when showing additional context in "min-duration" mode when minDurationContextEnabled is true.

Since

ArcGIS Maps SDK for JavaScript 5.0

Whether to enable additional context showing discrete shadows at the same time as displaying shadows above a minimum duration when in the "min-duration" mode. The minDurationContextColor and minDurationContextInterval properties are used to configure the visualization of the discrete shadows when context is enabled.

Since

ArcGIS Maps SDK for JavaScript 5.0

The interval in milliseconds used when showing additional context in "min-duration" mode when minDurationContextEnabled is true.

Since

ArcGIS Maps SDK for JavaScript 5.0

Minimum allowed value for the minDuration property, in milliseconds.

Since

ArcGIS Maps SDK for JavaScript 5.0

Mode of analysis to use when computing and displaying the shadows. There are 3 types:

• "discrete": Displays individual shadow snapshots at regular time intervals within the selected time range.
• "min-duration": Displays shadows only in areas where accumulated shading exceeds a user‑defined minimum duration within the selected time range. Optional discrete shadow overlays can provide additional context.
• "total-duration": Displays total shadow accumulation within the selected time range using opacity: areas with longer shadow duration appear more opaque. Supports continuous or 1‑hour aggregated modes.

By assigning the id attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.

See also

• Associate components with a Map or Scene component

Time (in milliseconds from midnight of the date) when the shadow cast computation should start.

Read more

The component's state. The values mean the following:

• disabled - component is being created
• ready - component is ready

Since

ArcGIS Maps SDK for JavaScript 5.0

Color of the shadow visualization in "total-duration" mode. The opacity is mapped to the time spent in shadow. Areas that don't receive any shadow are displayed with zero opacity and areas that receive shadows for the entire time range are displayed with the opacity specified in this property.

Since

ArcGIS Maps SDK for JavaScript 5.0

Mode in which the cumulative shadow duration should be displayed in "total-duration" mode: as a continuous surface or as an hourly aggregation of values.

The difference in hours between UTC time and the times displayed in the component.

The view associated with the component.

Note: The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this view property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-shadow-cast component will be associated with a map or scene component rather than using the view property.

Since

ArcGIS Maps SDK for JavaScript 5.0

Specifies the size of the component.

Creates a promise that resolves once the component is fully loaded.

Permanently destroy the component.

Since

ArcGIS Maps SDK for JavaScript 5.0

Returns the time (in milliseconds) spent in shadow for a certain point on the screen.

Read more