@arcgis/core
Version:
ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API
49 lines (47 loc) • 2.13 kB
TypeScript
import type Color from "../../Color.js";
import type { ColorLike } from "../../Color.js";
import type { Clonable } from "../../core/Clonable.js";
/** @since 5.0 */
export interface DiscreteOptionsProperties extends Partial<Pick<DiscreteOptions, "interval">> {
/**
* Color of the shadow visualization. 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.
*
* @default [50, 50, 50, 0.7]
* @since 5.0
*/
color?: ColorLike;
}
/**
* Configuration for the "discrete" mode of the [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/).
*
* @since 5.0
* @see [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/)
* @see [ShadowCastAnalysisView3D](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/ShadowCastAnalysisView3D/)
* @see [Sample - Shadow Cast analysis](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)
* @see [Shadow Cast component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/)
*/
export default class DiscreteOptions extends Clonable {
/** @since 5.0 */
constructor(properties?: DiscreteOptionsProperties);
/**
* Color of the shadow visualization. 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.
*
* @default [50, 50, 50, 0.7]
* @since 5.0
*/
get color(): Color;
set color(value: ColorLike);
/**
* Individual shadows are displayed at this time interval, 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.
*
* @default 1 * 3600 * 1000
* @since 5.0
*/
accessor interval: number;
}