UNPKG

@arcgis/core

Version:

ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API

54 lines (52 loc) 3.48 kB
import type LinePattern3D from "./LinePattern3D.js"; import type { LineStyle } from "../types.js"; export interface LineStylePattern3DProperties extends Partial<Pick<LineStylePattern3D, "style">> {} /** * Renders lines with predefined style patterns. * * @since 4.22 * @see [Sample - 3D hiking map with line patterns](https://developers.arcgis.com/javascript/latest/sample-code/visualization-line-patterns/) * @see [Sample - Line markers and label placement](https://developers.arcgis.com/javascript/latest/sample-code/visualization-line-markers/) * @see [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/references/core/symbols/LineSymbol3DLayer/) * @see [FillSymbol3DLayer.outline](https://developers.arcgis.com/javascript/latest/references/core/symbols/FillSymbol3DLayer/#outline) * @example * const symbol = { * type: "line-3d", // autocasts as new LineSymbol3D() * symbolLayers: [{ * type: "line", // autocasts as new LineSymbol3DLayer() * material: { color: "red" }, * pattern: { // autocasts as new LineStylePattern3D() * type: "style", * style: "dash" * } * }] * }; */ export default class LineStylePattern3D extends LinePattern3D { constructor(properties?: LineStylePattern3DProperties); /** * The pattern style. Note that the pattern segments' appearance depends on which `cap` style is applied to a [LineSymbol3DLayer](https://developers.arcgis.com/javascript/latest/references/core/symbols/LineSymbol3DLayer/) or which `patternCap` to a [FillSymbol3DLayer](https://developers.arcgis.com/javascript/latest/references/core/symbols/FillSymbol3DLayer/) outline. * * Possible values are listed in the table below: * * Value | Description * ------|------------- * dash | ![sls-dash](https://developers.arcgis.com/javascript/latest/assets/references/core/symbols/symbols-sls-dash.png) * dash-dot | ![sls-dash-dot](https://developers.arcgis.com/javascript/latest/assets/references/core/symbols/symbols-sls-dash-dot.png) * dot | ![sls-dot](https://developers.arcgis.com/javascript/latest/assets/references/core/symbols/symbols-sls-dot.png) * long-dash | ![sls-long-dash](https://developers.arcgis.com/javascript/latest/assets/references/core/symbols/symbols-sls-long-dash.png) * long-dash-dot | ![sls-long-dash-dot](https://developers.arcgis.com/javascript/latest/assets/references/core/symbols/symbols-sls-long-dash-dot.png) * long-dash-dot-dot | ![sls-dash-dot-dot](https://developers.arcgis.com/javascript/latest/assets/references/core/symbols/symbols-sls-dash-dot-dot.png) * none | The line has no symbol. * short-dash | ![sls-short-dash](https://developers.arcgis.com/javascript/latest/assets/references/core/symbols/symbols-sls-short-dash.png) * short-dash-dot | ![sls-short-dash-dot](https://developers.arcgis.com/javascript/latest/assets/references/core/symbols/symbols-sls-short-dash-dot.png) * short-dash-dot-dot | ![sls-short-dash-dot-dot](https://developers.arcgis.com/javascript/latest/assets/references/core/symbols/symbols-sls-short-dash-dot-dot.png) * short-dot | ![sls-short-dot](https://developers.arcgis.com/javascript/latest/assets/references/core/symbols/symbols-sls-short-dot.png) * solid | ![sls-solid](https://developers.arcgis.com/javascript/latest/assets/references/core/symbols/symbols-sls-solid.png) * * @default "solid" */ accessor style: LineStyle; /** The pattern type. */ get type(): "style"; }