@arcgis/map-components 4.34.0-next.2 → 4.34.0-next.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cdn/{MQJ7XLGK.js → 2WYOLZ2S.js} +2 -2
- package/dist/cdn/{WIZ7RQYM.js → 32BNVHFB.js} +2 -2
- package/dist/cdn/{FMX5JKGL.js → 37OOSZJN.js} +2 -2
- package/dist/cdn/{BL6FEQUL.js → 3COE2Z3B.js} +1 -1
- package/dist/cdn/{A5THM6EA.js → 3FHU5J5V.js} +2 -2
- package/dist/cdn/3JZFTPDS.js +4 -0
- package/dist/cdn/{QGDMGHZ3.js → 3XFKPFZ6.js} +2 -2
- package/dist/cdn/{QS6PLBTH.js → 42RDF2D7.js} +2 -2
- package/dist/cdn/{E6EE4TT7.js → 53VD6INF.js} +1 -1
- package/dist/cdn/{M6KBDQ4B.js → 57BL5AOQ.js} +2 -2
- package/dist/cdn/{RKKLVIKS.js → 5F4KKKR2.js} +2 -2
- package/dist/cdn/5N3A2V7I.js +4 -0
- package/dist/cdn/5W5GGIWL.js +4 -0
- package/dist/cdn/{LQXNDSAI.js → 5YIGSG3W.js} +2 -2
- package/dist/cdn/{2DFTJYET.js → 5ZFQYKDQ.js} +2 -2
- package/dist/cdn/{47WXI5OV.js → 66WLGZBK.js} +2 -2
- package/dist/cdn/{O57FJWKG.js → 6HAPOXM4.js} +2 -2
- package/dist/cdn/{4P26B2AA.js → 6IO6EDU6.js} +2 -2
- package/dist/cdn/{54LBYLM4.js → 6PKZGLPN.js} +2 -2
- package/dist/cdn/6UECA53W.js +4 -0
- package/dist/cdn/{76V2F3M5.js → 6W5JZE6P.js} +2 -2
- package/dist/cdn/{FQM7ZIUE.js → 6YA5EHG3.js} +2 -2
- package/dist/cdn/{2Z4KRGOJ.js → 6YVLN2P3.js} +1 -1
- package/dist/cdn/{L3FVC43E.js → 7ARDNPNQ.js} +2 -2
- package/dist/cdn/{YXTLBEV3.js → 7CEESMMF.js} +2 -2
- package/dist/cdn/{3TIDM52T.js → 7FIG5C46.js} +2 -2
- package/dist/cdn/7QSEE732.js +4 -0
- package/dist/cdn/7WH4STWU.js +4 -0
- package/dist/cdn/{DH3QB5M5.js → A2OIDY5B.js} +2 -2
- package/dist/cdn/{QWVS3J6Z.js → BCW2OD35.js} +2 -2
- package/dist/cdn/BEBNYXEO.js +4 -0
- package/dist/cdn/{IE47QEIE.js → BMQSD5DM.js} +2 -2
- package/dist/cdn/{R6KUTRWE.js → BNSB5DBF.js} +2 -2
- package/dist/cdn/{ESEGUX5O.js → BQIFQSW3.js} +2 -2
- package/dist/cdn/{OBPKMGHI.js → BSLJTO5W.js} +2 -2
- package/dist/cdn/{LIRUDJLH.js → BUUMZNCV.js} +2 -2
- package/dist/cdn/{VRX7IRTW.js → CMKO5P4W.js} +2 -2
- package/dist/cdn/{5IGCHT4A.js → CTVODY2L.js} +2 -2
- package/dist/cdn/{FVCCBN6R.js → DPJONPCK.js} +2 -2
- package/dist/cdn/{LQPNE6GS.js → E5FAANO2.js} +2 -2
- package/dist/cdn/{QTUCLDNK.js → EM5YT262.js} +1 -1
- package/dist/cdn/{U7HB3CPN.js → ENR5OCHD.js} +2 -2
- package/dist/cdn/{X5HMIK3S.js → EROQMNHF.js} +2 -2
- package/dist/cdn/{VMDVUG52.js → FJUUINMO.js} +1 -1
- package/dist/cdn/{WXDH6ABX.js → FMHODF2P.js} +2 -2
- package/dist/cdn/{7CVQJHEU.js → GBHPLHDP.js} +2 -2
- package/dist/cdn/{WBS3PEXG.js → GIAR3I4T.js} +2 -2
- package/dist/cdn/{R42MVK6T.js → GM5SPCJW.js} +2 -2
- package/dist/cdn/{M67BOC6R.js → GNWBPZXN.js} +2 -2
- package/dist/cdn/{N762OEGT.js → H673H72F.js} +2 -2
- package/dist/cdn/{FPQAF5U2.js → HBJ2ZDE6.js} +2 -2
- package/dist/cdn/{3E5JGS7I.js → HRGZVM26.js} +2 -2
- package/dist/cdn/{AXKSXWQK.js → I2FMQPO7.js} +2 -2
- package/dist/cdn/{3ZGNCN4N.js → IFK2ZTSD.js} +2 -2
- package/dist/cdn/{VIU4ZSIY.js → JLC7B3OG.js} +2 -2
- package/dist/cdn/{X7Q6FQWN.js → JQ63WQ5N.js} +2 -2
- package/dist/cdn/{TV675TMD.js → JRDPLJJ2.js} +2 -2
- package/dist/cdn/{YXIBBCVA.js → JWUDTAKH.js} +2 -2
- package/dist/cdn/{O24P7Q3C.js → JXDNAFBS.js} +2 -2
- package/dist/cdn/{JXL7WD2E.js → K2V4Y6OT.js} +2 -2
- package/dist/cdn/{5APGWHKF.js → KHLYVIBR.js} +2 -2
- package/dist/cdn/{HRAFJUBY.js → KMWZKUYI.js} +2 -2
- package/dist/cdn/{HSYMUXB2.js → KP2PRNMR.js} +2 -2
- package/dist/cdn/{BOWV4BI5.js → KYAT2EEX.js} +2 -2
- package/dist/cdn/{UJWLDNQL.js → L4NZQKEH.js} +2 -2
- package/dist/cdn/{V2GGQDQV.js → LBIFHUDZ.js} +2 -2
- package/dist/cdn/{T356JENG.js → LWUM7FWM.js} +2 -2
- package/dist/cdn/{YTQ5WKUI.js → MAD2J6QQ.js} +2 -2
- package/dist/cdn/{DXPQND6H.js → MBBASR7O.js} +2 -2
- package/dist/cdn/{QDLWV3GL.js → MWU37I6K.js} +2 -2
- package/dist/cdn/{2HMQBLGX.js → NA5XNR6C.js} +2 -2
- package/dist/cdn/{AX6ZNG7O.js → NJMTMY57.js} +2 -2
- package/dist/cdn/{BBUM7LXZ.js → NKRS33IA.js} +2 -2
- package/dist/cdn/{YF5TCRIS.js → OF2ETBRA.js} +2 -2
- package/dist/cdn/{ZF2Y2DMS.js → OVBHUV5Z.js} +2 -2
- package/dist/cdn/{MSGRPQLQ.js → PG7FQ7KL.js} +2 -2
- package/dist/cdn/{OSL33XSZ.js → Q3ISTJOO.js} +2 -2
- package/dist/cdn/{LG2VTIMN.js → Q6H72XC6.js} +2 -2
- package/dist/cdn/{OPRL4XLU.js → QBOTK4ZT.js} +2 -2
- package/dist/cdn/{6QZWTGCD.js → QD4I6M3K.js} +2 -2
- package/dist/cdn/{6KAI6YXC.js → QJZTOJZ7.js} +2 -2
- package/dist/cdn/{HDHYECZP.js → R4TRCPYE.js} +1 -1
- package/dist/cdn/{LLSIG464.js → S6JGYQ4Y.js} +2 -2
- package/dist/cdn/{DKMOPJ25.js → SGEYUE62.js} +2 -2
- package/dist/cdn/{JPZTEH2M.js → SKMKH5YG.js} +2 -2
- package/dist/cdn/{6ESK4QPA.js → T2JV2ISV.js} +2 -2
- package/dist/cdn/{42ZLP4TO.js → T5CZQJOU.js} +2 -2
- package/dist/cdn/{IBKAQQBC.js → TOK4URPS.js} +2 -2
- package/dist/cdn/{FG2UUN5Y.js → TP2UXACR.js} +2 -2
- package/dist/cdn/{Z4ZNKWSQ.js → TVKSSFHU.js} +2 -2
- package/dist/cdn/TVWHW67R.js +4 -0
- package/dist/cdn/{BTB5CEYG.js → TZW53V7V.js} +2 -2
- package/dist/cdn/{R63E5IDP.js → UBDHT42U.js} +2 -2
- package/dist/cdn/{PVCZG5NR.js → ULK3ELJZ.js} +2 -2
- package/dist/cdn/VIZKBNB3.js +4 -0
- package/dist/cdn/{D6KJDF5I.js → W44LCN2B.js} +2 -2
- package/dist/cdn/{Y6UM5JRX.js → W4YLM5Q7.js} +2 -2
- package/dist/cdn/{Z5VECA2W.js → WAA675KF.js} +2 -2
- package/dist/cdn/{E77FQK43.js → WERCUHHX.js} +2 -2
- package/dist/cdn/{6YEXM7GA.js → WLZQNP7J.js} +2 -2
- package/dist/cdn/{T7VRSGAE.js → WPILVNC3.js} +2 -2
- package/dist/cdn/{2ITL25LA.js → WRW2ZSOO.js} +2 -2
- package/dist/cdn/{AACC3FYE.js → XEWUFL5A.js} +1 -1
- package/dist/cdn/{JSU4NS5T.js → XF6S3AC3.js} +2 -2
- package/dist/cdn/{ZV44DXHW.js → XHWF5J4T.js} +2 -2
- package/dist/cdn/{LE6LUZKM.js → XIQPDWHH.js} +2 -2
- package/dist/cdn/{DHZBSCQC.js → XNV22S4H.js} +2 -2
- package/dist/cdn/{ARSEOYQC.js → XRFFTEP7.js} +2 -2
- package/dist/cdn/{YL5UD5QK.js → XTOCNPIF.js} +2 -2
- package/dist/cdn/{CUYQCXUJ.js → Y3ZQAMRW.js} +2 -2
- package/dist/cdn/{YM2YPJK6.js → Y7TD4V23.js} +2 -2
- package/dist/cdn/{NBZE6Q5O.js → Y7WZVBSC.js} +1 -1
- package/dist/cdn/{TEM46PXT.js → YCEOOMPS.js} +2 -2
- package/dist/cdn/{V4FN65Z4.js → YMCFBT2L.js} +2 -2
- package/dist/cdn/{BGVGYLIS.js → YROEKDLY.js} +2 -2
- package/dist/cdn/{RAN4WBBO.js → YSBU56II.js} +2 -2
- package/dist/cdn/{LRCALZS4.js → YTHUO5OY.js} +2 -2
- package/dist/cdn/{PNN554XV.js → ZA6LS2DT.js} +2 -2
- package/dist/cdn/ZUD7WKRS.js +4 -0
- package/dist/cdn/index.js +2 -2
- package/dist/chunks/AnalysisViewModel.js +1 -1
- package/dist/chunks/async-utils.js +1 -1
- package/dist/chunks/basemap-gallery-resources.js +1 -1
- package/dist/chunks/component-utils.js +1 -1
- package/dist/chunks/createCloseEvent.js +1 -1
- package/dist/chunks/globalCss.js +1 -1
- package/dist/chunks/heading.js +1 -1
- package/dist/chunks/layer-list.js +1 -1
- package/dist/chunks/legacyIcon.js +1 -1
- package/dist/chunks/maybe.js +1 -1
- package/dist/chunks/measurementUtils.js +1 -1
- package/dist/chunks/runtime.js +1 -1
- package/dist/chunks/useHandles.js +1 -1
- package/dist/chunks/useT9n.js +1 -1
- package/dist/chunks/useView.js +1 -1
- package/dist/chunks/useViewModel.js +1 -1
- package/dist/chunks/useWidget.js +1 -1
- package/dist/chunks/utils.js +1 -1
- package/dist/components/arcgis-area-measurement-2d/customElement.js +1 -1
- package/dist/components/arcgis-area-measurement-3d/customElement.d.ts +2 -2
- package/dist/components/arcgis-area-measurement-3d/customElement.js +3 -6
- package/dist/components/arcgis-attachments/customElement.js +1 -1
- package/dist/components/arcgis-basemap-gallery/customElement.d.ts +5 -1
- package/dist/components/arcgis-basemap-gallery/customElement.js +1 -1
- package/dist/components/arcgis-basemap-gallery-item/customElement.js +1 -1
- package/dist/components/arcgis-basemap-layer-list/customElement.js +1 -1
- package/dist/components/arcgis-basemap-toggle/customElement.d.ts +5 -1
- package/dist/components/arcgis-basemap-toggle/customElement.js +1 -1
- package/dist/components/arcgis-bookmarks/customElement.js +1 -1
- package/dist/components/arcgis-building-explorer/customElement.js +1 -1
- package/dist/components/arcgis-catalog-layer-list/customElement.js +1 -1
- package/dist/components/arcgis-compass/customElement.d.ts +5 -1
- package/dist/components/arcgis-compass/customElement.js +1 -1
- package/dist/components/arcgis-coordinate-conversion/customElement.d.ts +1 -1
- package/dist/components/arcgis-coordinate-conversion/customElement.js +3 -3
- package/dist/components/arcgis-daylight/customElement.js +1 -1
- package/dist/components/arcgis-direct-line-measurement-3d/customElement.d.ts +2 -2
- package/dist/components/arcgis-direct-line-measurement-3d/customElement.js +3 -6
- package/dist/components/arcgis-directional-pad/customElement.d.ts +5 -1
- package/dist/components/arcgis-directional-pad/customElement.js +1 -1
- package/dist/components/arcgis-directions/customElement.js +1 -1
- package/dist/components/arcgis-distance-measurement-2d/customElement.js +1 -1
- package/dist/components/arcgis-editor/customElement.js +1 -1
- package/dist/components/arcgis-elevation-profile/customElement.js +1 -1
- package/dist/components/arcgis-expand/customElement.d.ts +1 -1
- package/dist/components/arcgis-expand/customElement.js +1 -1
- package/dist/components/arcgis-feature/customElement.js +1 -1
- package/dist/components/arcgis-feature-form/customElement.js +1 -1
- package/dist/components/arcgis-feature-table/customElement.js +1 -1
- package/dist/components/arcgis-feature-templates/customElement.js +1 -1
- package/dist/components/arcgis-features/customElement.js +1 -1
- package/dist/components/arcgis-floor-filter/customElement.js +1 -1
- package/dist/components/arcgis-fullscreen/customElement.d.ts +11 -1
- package/dist/components/arcgis-fullscreen/customElement.js +1 -1
- package/dist/components/arcgis-grid-controls/customElement.d.ts +5 -1
- package/dist/components/arcgis-grid-controls/customElement.js +1 -1
- package/dist/components/arcgis-histogram-range-slider/customElement.js +1 -1
- package/dist/components/arcgis-home/customElement.d.ts +18 -12
- package/dist/components/arcgis-home/customElement.js +1 -1
- package/dist/components/arcgis-labeled-switch/customElement.js +1 -1
- package/dist/components/arcgis-layer-list/customElement.js +1 -1
- package/dist/components/arcgis-layer-list-item/customElement.js +1 -1
- package/dist/components/arcgis-legend/customElement.js +1 -1
- package/dist/components/arcgis-line-of-sight/customElement.d.ts +6 -3
- package/dist/components/arcgis-line-of-sight/customElement.js +9 -12
- package/dist/components/arcgis-link-chart/customElement.d.ts +13 -5
- package/dist/components/arcgis-link-chart/customElement.js +14 -5
- package/dist/components/arcgis-link-chart-layout-switcher/customElement.d.ts +8 -3
- package/dist/components/arcgis-link-chart-layout-switcher/customElement.js +1 -1
- package/dist/components/arcgis-locate/customElement.d.ts +5 -1
- package/dist/components/arcgis-locate/customElement.js +1 -1
- package/dist/components/arcgis-map/customElement.d.ts +15 -7
- package/dist/components/arcgis-map/customElement.js +25 -14
- package/dist/components/arcgis-measurement/customElement.js +1 -1
- package/dist/components/arcgis-measurement-content/customElement.js +1 -1
- package/dist/components/arcgis-navigation-toggle/customElement.d.ts +5 -1
- package/dist/components/arcgis-navigation-toggle/customElement.js +1 -1
- package/dist/components/arcgis-oriented-imagery-viewer/customElement.js +1 -1
- package/dist/components/arcgis-placement/customElement.js +1 -1
- package/dist/components/arcgis-print/customElement.d.ts +52 -34
- package/dist/components/arcgis-print/customElement.js +1 -1
- package/dist/components/arcgis-print-custom-text-elements/customElement.js +1 -1
- package/dist/components/arcgis-print-dpi-input/customElement.js +1 -1
- package/dist/components/arcgis-print-export-button/customElement.js +1 -1
- package/dist/components/arcgis-print-exported-link/customElement.js +1 -1
- package/dist/components/arcgis-print-exports-panel/customElement.js +1 -1
- package/dist/components/arcgis-print-format-select/customElement.js +1 -1
- package/dist/components/arcgis-print-layout-advanced-options/customElement.js +1 -1
- package/dist/components/arcgis-print-layout-panel/customElement.js +1 -1
- package/dist/components/arcgis-print-main-panel/customElement.js +1 -1
- package/dist/components/arcgis-print-map-only-advanced-options/customElement.js +1 -1
- package/dist/components/arcgis-print-map-only-panel/customElement.js +1 -1
- package/dist/components/arcgis-print-out-spatial-reference-input/customElement.js +1 -1
- package/dist/components/arcgis-print-preview-input/customElement.js +1 -1
- package/dist/components/arcgis-print-scale-section/customElement.js +1 -1
- package/dist/components/arcgis-print-template-select/customElement.js +1 -1
- package/dist/components/arcgis-print-template-selector/customElement.js +1 -1
- package/dist/components/arcgis-scale-bar/customElement.d.ts +6 -2
- package/dist/components/arcgis-scale-bar/customElement.js +1 -1
- package/dist/components/arcgis-scale-range-slider/customElement.js +1 -1
- package/dist/components/arcgis-scene/customElement.d.ts +17 -7
- package/dist/components/arcgis-scene/customElement.js +23 -12
- package/dist/components/arcgis-search/customElement.d.ts +40 -15
- package/dist/components/arcgis-search/customElement.js +34 -34
- package/dist/components/arcgis-search-result-renderer/customElement.js +1 -1
- package/dist/components/arcgis-shadow-cast/customElement.js +1 -1
- package/dist/components/arcgis-sketch/customElement.js +1 -1
- package/dist/components/arcgis-slice/customElement.d.ts +8 -3
- package/dist/components/arcgis-slice/customElement.js +1 -1
- package/dist/components/arcgis-slider/customElement.js +1 -1
- package/dist/components/arcgis-swipe/customElement.d.ts +6 -2
- package/dist/components/arcgis-swipe/customElement.js +1 -1
- package/dist/components/arcgis-table-list/customElement.js +1 -1
- package/dist/components/arcgis-time-slider/customElement.js +1 -1
- package/dist/components/arcgis-time-zone-label/customElement.d.ts +3 -1
- package/dist/components/arcgis-time-zone-label/customElement.js +1 -1
- package/dist/components/arcgis-track/customElement.d.ts +6 -2
- package/dist/components/arcgis-track/customElement.js +1 -1
- package/dist/components/arcgis-unit-select/customElement.d.ts +5 -1
- package/dist/components/arcgis-unit-select/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-associations/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-trace/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-validate-topology/customElement.js +1 -1
- package/dist/components/arcgis-value-picker/customElement.js +1 -1
- package/dist/components/arcgis-version-management/customElement.d.ts +9 -5
- package/dist/components/arcgis-version-management/customElement.js +1 -1
- package/dist/components/arcgis-version-management-service-item/customElement.js +1 -1
- package/dist/components/arcgis-version-management-version-item/customElement.js +1 -1
- package/dist/components/arcgis-version-management-version-list/customElement.js +1 -1
- package/dist/components/arcgis-version-management-version-properties/customElement.js +1 -1
- package/dist/components/arcgis-video/customElement.d.ts +20 -9
- package/dist/components/arcgis-video/customElement.js +10 -19
- package/dist/components/arcgis-video-player/customElement.d.ts +18 -5
- package/dist/components/arcgis-video-player/customElement.js +32 -26
- package/dist/components/arcgis-video-player-action-bar/customElement.js +1 -1
- package/dist/components/arcgis-video-player-actions-group/customElement.js +1 -1
- package/dist/components/arcgis-video-player-controls-group/customElement.js +12 -12
- package/dist/components/arcgis-video-player-metadata/customElement.js +2 -2
- package/dist/components/arcgis-video-player-settings/customElement.js +2 -2
- package/dist/components/arcgis-video-player-slider/customElement.js +1 -1
- package/dist/components/arcgis-weather/customElement.d.ts +5 -1
- package/dist/components/arcgis-weather/customElement.js +1 -1
- package/dist/components/arcgis-zoom/customElement.d.ts +5 -1
- package/dist/components/arcgis-zoom/customElement.js +1 -1
- package/dist/docs/api.json +534 -229
- package/dist/docs/docs.json +442 -216
- package/dist/docs/vscode.html-custom-data.json +53 -31
- package/dist/docs/web-types.json +137 -99
- package/dist/index.js +1 -1
- package/dist/loader.js +8 -8
- package/dist/types/lumina.d.ts +11 -11
- package/dist/types/preact.d.ts +11 -11
- package/dist/types/react.d.ts +11 -11
- package/dist/types/stencil.d.ts +11 -11
- package/package.json +3 -3
- package/dist/cdn/4B65IRU5.js +0 -4
- package/dist/cdn/4WJ66SFY.js +0 -4
- package/dist/cdn/6X652SXL.js +0 -4
- package/dist/cdn/DNMZ4O6N.js +0 -4
- package/dist/cdn/HP3N5VUA.js +0 -4
- package/dist/cdn/NR7JLVJV.js +0 -4
- package/dist/cdn/NTUHH5NA.js +0 -4
- package/dist/cdn/OZTG4AFE.js +0 -4
- package/dist/cdn/XLHDAUF2.js +0 -4
- package/dist/cdn/ZB452APZ.js +0 -4
package/dist/docs/web-types.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
|
|
3
3
|
"name": "@arcgis/map-components",
|
|
4
|
-
"version": "4.34.0-next.
|
|
4
|
+
"version": "4.34.0-next.20",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
@@ -271,6 +271,7 @@
|
|
|
271
271
|
"properties": [
|
|
272
272
|
{
|
|
273
273
|
"name": "analysis",
|
|
274
|
+
"description": "Analysis data object.",
|
|
274
275
|
"type": "AreaMeasurementAnalysis"
|
|
275
276
|
},
|
|
276
277
|
{
|
|
@@ -709,7 +710,7 @@
|
|
|
709
710
|
},
|
|
710
711
|
{
|
|
711
712
|
"name": "messageOverrides",
|
|
712
|
-
"description": "Replace localized message strings with your own strings
|
|
713
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
713
714
|
"type": "Record<string, unknown>"
|
|
714
715
|
},
|
|
715
716
|
{
|
|
@@ -1331,7 +1332,7 @@
|
|
|
1331
1332
|
},
|
|
1332
1333
|
{
|
|
1333
1334
|
"name": "messageOverrides",
|
|
1334
|
-
"description": "Replace localized message strings with your own strings
|
|
1335
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
1335
1336
|
"type": "Record<string, unknown>"
|
|
1336
1337
|
},
|
|
1337
1338
|
{
|
|
@@ -2348,7 +2349,7 @@
|
|
|
2348
2349
|
},
|
|
2349
2350
|
{
|
|
2350
2351
|
"name": "messageOverrides",
|
|
2351
|
-
"description": "Replace localized message strings with your own strings
|
|
2352
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
2352
2353
|
"type": "Record<string, unknown>"
|
|
2353
2354
|
},
|
|
2354
2355
|
{
|
|
@@ -2413,14 +2414,14 @@
|
|
|
2413
2414
|
}
|
|
2414
2415
|
},
|
|
2415
2416
|
{
|
|
2416
|
-
"name": "hide-
|
|
2417
|
+
"name": "hide-expand-button",
|
|
2417
2418
|
"default": "false",
|
|
2418
2419
|
"value": {
|
|
2419
2420
|
"type": "boolean"
|
|
2420
2421
|
}
|
|
2421
2422
|
},
|
|
2422
2423
|
{
|
|
2423
|
-
"name": "hide-
|
|
2424
|
+
"name": "hide-input-button",
|
|
2424
2425
|
"default": "false",
|
|
2425
2426
|
"value": {
|
|
2426
2427
|
"type": "boolean"
|
|
@@ -2583,11 +2584,11 @@
|
|
|
2583
2584
|
"type": "boolean"
|
|
2584
2585
|
},
|
|
2585
2586
|
{
|
|
2586
|
-
"name": "
|
|
2587
|
+
"name": "hideExpandButton",
|
|
2587
2588
|
"type": "boolean"
|
|
2588
2589
|
},
|
|
2589
2590
|
{
|
|
2590
|
-
"name": "
|
|
2591
|
+
"name": "hideInputButton",
|
|
2591
2592
|
"type": "boolean"
|
|
2592
2593
|
},
|
|
2593
2594
|
{
|
|
@@ -3078,7 +3079,7 @@
|
|
|
3078
3079
|
},
|
|
3079
3080
|
{
|
|
3080
3081
|
"name": "messageOverrides",
|
|
3081
|
-
"description": "Replace localized message strings with your own strings
|
|
3082
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
3082
3083
|
"type": "Record<string, unknown>"
|
|
3083
3084
|
},
|
|
3084
3085
|
{
|
|
@@ -3486,6 +3487,7 @@
|
|
|
3486
3487
|
"properties": [
|
|
3487
3488
|
{
|
|
3488
3489
|
"name": "analysis",
|
|
3490
|
+
"description": "Analysis data object.",
|
|
3489
3491
|
"type": "DirectLineMeasurementAnalysis"
|
|
3490
3492
|
},
|
|
3491
3493
|
{
|
|
@@ -3640,6 +3642,7 @@
|
|
|
3640
3642
|
"properties": [
|
|
3641
3643
|
{
|
|
3642
3644
|
"name": "analysis",
|
|
3645
|
+
"description": "Analysis data object.",
|
|
3643
3646
|
"type": "DirectLineMeasurementAnalysis"
|
|
3644
3647
|
},
|
|
3645
3648
|
{
|
|
@@ -4431,7 +4434,7 @@
|
|
|
4431
4434
|
},
|
|
4432
4435
|
{
|
|
4433
4436
|
"name": "arcgis-expand",
|
|
4434
|
-
"description": "The Expand component acts as a clickable button for
|
|
4437
|
+
"description": "The Expand component acts as a clickable button for displaying interactive content, most commonly other components.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `collapse(): Promise<void>`\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `expand(): Promise<void>`\n- `toggle(): Promise<void>`",
|
|
4435
4438
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-expand/",
|
|
4436
4439
|
"attributes": [
|
|
4437
4440
|
{
|
|
@@ -6974,7 +6977,7 @@
|
|
|
6974
6977
|
},
|
|
6975
6978
|
{
|
|
6976
6979
|
"name": "arcgis-fullscreen",
|
|
6977
|
-
"description": "The Fullscreen component allows users to toggle the map or scene to fullscreen mode.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
|
|
6980
|
+
"description": "The Fullscreen component allows users to toggle the map or scene to fullscreen mode.\nUse the escape key (`esc`) to exit fullscreen mode.\n\n**Known limitations**\n\n* The Fullscreen widget only works with browsers that implement the [Fullscreen](https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API) API.\n Thus, iOS Safari is not supported.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
|
|
6978
6981
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-fullscreen/",
|
|
6979
6982
|
"attributes": [
|
|
6980
6983
|
{
|
|
@@ -7045,7 +7048,7 @@
|
|
|
7045
7048
|
},
|
|
7046
7049
|
{
|
|
7047
7050
|
"name": "messageOverrides",
|
|
7048
|
-
"description": "Replace localized message strings with your own strings
|
|
7051
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
7049
7052
|
"type": "Record<string, unknown>"
|
|
7050
7053
|
},
|
|
7051
7054
|
{
|
|
@@ -7443,7 +7446,7 @@
|
|
|
7443
7446
|
},
|
|
7444
7447
|
{
|
|
7445
7448
|
"name": "messageOverrides",
|
|
7446
|
-
"description": "Replace localized message strings with your own strings
|
|
7449
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
7447
7450
|
"type": "Record<string, unknown>"
|
|
7448
7451
|
},
|
|
7449
7452
|
{
|
|
@@ -7884,7 +7887,7 @@
|
|
|
7884
7887
|
},
|
|
7885
7888
|
{
|
|
7886
7889
|
"name": "messageOverrides",
|
|
7887
|
-
"description": "Replace localized message strings with your own strings
|
|
7890
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
7888
7891
|
"type": "Record<string, unknown>"
|
|
7889
7892
|
},
|
|
7890
7893
|
{
|
|
@@ -7902,7 +7905,7 @@
|
|
|
7902
7905
|
},
|
|
7903
7906
|
{
|
|
7904
7907
|
"name": "viewpoint",
|
|
7905
|
-
"description": "The esri
|
|
7908
|
+
"description": "The [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html)\nto go to when going \"home\".\nThe initial value is determined in a few different ways:\n\nIf no referenceElement is provided, the value is `null`.\nOnce the referenceElement is ready, the initial viewpoint value is the user-defined [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html).",
|
|
7906
7909
|
"type": "Viewpoint"
|
|
7907
7910
|
}
|
|
7908
7911
|
],
|
|
@@ -8644,7 +8647,7 @@
|
|
|
8644
8647
|
},
|
|
8645
8648
|
{
|
|
8646
8649
|
"name": "messageOverrides",
|
|
8647
|
-
"description": "Replace localized message strings with your own strings
|
|
8650
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
8648
8651
|
"type": "Record<string, unknown>"
|
|
8649
8652
|
},
|
|
8650
8653
|
{
|
|
@@ -8931,9 +8934,14 @@
|
|
|
8931
8934
|
"description": "A rejected view indicates a fatal error making it unable to display.",
|
|
8932
8935
|
"type": "Error"
|
|
8933
8936
|
},
|
|
8937
|
+
{
|
|
8938
|
+
"name": "focusAreas",
|
|
8939
|
+
"description": "A container of all [focus areas](https://developers.arcgis.com/javascript/latest/api-reference/esri-effects-FocusAreas.html) present in the map.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#focusAreas)",
|
|
8940
|
+
"type": "FocusAreas"
|
|
8941
|
+
},
|
|
8934
8942
|
{
|
|
8935
8943
|
"name": "graphics",
|
|
8936
|
-
"description": "Allows for adding graphics directly to the default graphics in the View
|
|
8944
|
+
"description": "Allows for adding graphics directly to the default graphics in the View.",
|
|
8937
8945
|
"type": "Collection<Graphic>"
|
|
8938
8946
|
},
|
|
8939
8947
|
{
|
|
@@ -9308,7 +9316,7 @@
|
|
|
9308
9316
|
},
|
|
9309
9317
|
{
|
|
9310
9318
|
"name": "messageOverrides",
|
|
9311
|
-
"description": "Replace localized message strings with your own strings
|
|
9319
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
9312
9320
|
"type": "Record<string, unknown>"
|
|
9313
9321
|
},
|
|
9314
9322
|
{
|
|
@@ -9492,7 +9500,7 @@
|
|
|
9492
9500
|
},
|
|
9493
9501
|
{
|
|
9494
9502
|
"name": "messageOverrides",
|
|
9495
|
-
"description": "Replace localized message strings with your own strings
|
|
9503
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
9496
9504
|
"type": "Record<string, unknown>"
|
|
9497
9505
|
},
|
|
9498
9506
|
{
|
|
@@ -9542,7 +9550,7 @@
|
|
|
9542
9550
|
},
|
|
9543
9551
|
{
|
|
9544
9552
|
"name": "arcgis-map",
|
|
9545
|
-
"description": "The ArcGIS Map
|
|
9553
|
+
"description": "The ArcGIS Map component is used to add 2D maps to web applications. For 3D maps, use the\n[ArcGIS Scene component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n\nThe Map component creates a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) and loads a WebMap from either [ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\n```html\n<arcgis-map item-id=\"05e015c5f0314db9a487a9b46cb37eca\"></arcgis-map>\n```\n\nAlternatively, the Map component can be initialized without a WebMap item.\n\n```html\n<arcgis-map basemap=\"satellite\" center=\"-154.88, 19.46\" zoom=\"15\"></arcgis-map>\n```\n\nOther components can be added and connected to the Map component.\n\n```html\n<arcgis-map item-id=\"05e015c5f0314db9a487a9b46cb37eca\">\n <arcgis-zoom position=\"top-left\"></arcgis-zoom>\n <arcgis-legend position=\"bottom-left\"></arcgis-legend>\n</arcgis-map>\n```\n\nThe Map component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/api-reference/) of the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-map\");\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My Layer\" });\n viewElement.map.add(layer);\n});\n```\n\nSee also:\n- [SDK sample apps using the Map component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-map)\n- [Getting started](https://developers.arcgis.com/javascript/latest/get-started-overview/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)\n--\n\n### Events\n- **arcgisViewChange** - This event is for view related property changes: zoom, scale, center, rotation, extent, camera, viewpoint.\nThis event will also emit if stationary toggles from true to false.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n- **arcgisViewHold** - Fires during a pointer drag on the view.\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n- **arcgisViewKeyUp** - Fires after a keyboard key is pressed.\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding LayerView created and rendered in the view.\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the map.\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n- **arcgisViewReadyChange** - This event is for the `ready` property and will be emitted when the view is ready.\nThis event will also emit if the `map` property is changed.\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.add(layer)` instead.\n\nAdds a layer to the map layers collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the map layers collection.. \n- `addTable(table: __esri.FeatureLayer): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.tables.add(table)` instead.\n\nAdds a table to the map tables collection.. \n- `addTables(tables: __esri.FeatureLayer[], index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the map tables collection.. \n- `closePopup(): Promise<void>` - Closes the popup.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n- `goTo(target: __esri.GoToTarget2D, options?: __esri.GoToOptions2D): Promise<unknown>` - Sets the view to a given target.\n- `hitTest(screenPoint: __esri.MapViewScreenPoint | MouseEvent, options?: __esri.MapViewHitTestOptions): Promise<__esri.HitTestResult>` - Returns hit test results from each layer that intersects the specified screen coordinates.\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup at the given location with content defined either explicitly with content or driven\nfrom the PopupTemplate of input features.\n- `takeScreenshot(options?: __esri.MapViewTakeScreenshotOptions): Promise<__esri.Screenshot>` - Create a screenshot of the current view.\n- `toMap(screenPoint: __esri.MapViewScreenPoint | MouseEvent): __esri.Point`\n- `toScreen(point: __esri.Point, options?: __esri.ToScreenOptions2D): __esri.MapViewScreenPoint | nullish`\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters: a `callback` function and an `errback` function.\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the LayerView created on the view for the given layer.",
|
|
9546
9554
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/",
|
|
9547
9555
|
"attributes": [
|
|
9548
9556
|
{
|
|
@@ -9808,6 +9816,11 @@
|
|
|
9808
9816
|
"description": "Applies a display filter on the view for a specific set of floor levels.\nIt can filter the map display on floor-aware layers by zero or more level IDs.",
|
|
9809
9817
|
"type": "Collection<string>"
|
|
9810
9818
|
},
|
|
9819
|
+
{
|
|
9820
|
+
"name": "focusAreas",
|
|
9821
|
+
"description": "A container of all [focus areas](https://developers.arcgis.com/javascript/latest/api-reference/esri-effects-FocusAreas.html) present in the map.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#focusAreas)",
|
|
9822
|
+
"type": "FocusAreas"
|
|
9823
|
+
},
|
|
9811
9824
|
{
|
|
9812
9825
|
"name": "gamepad",
|
|
9813
9826
|
"description": "Gamepad input specific configuration settings.",
|
|
@@ -9815,7 +9828,7 @@
|
|
|
9815
9828
|
},
|
|
9816
9829
|
{
|
|
9817
9830
|
"name": "graphics",
|
|
9818
|
-
"description": "Allows for adding graphics directly to the default graphics in the View
|
|
9831
|
+
"description": "Allows for adding graphics directly to the default graphics in the View.",
|
|
9819
9832
|
"type": "Collection<Graphic>"
|
|
9820
9833
|
},
|
|
9821
9834
|
{
|
|
@@ -10374,7 +10387,7 @@
|
|
|
10374
10387
|
},
|
|
10375
10388
|
{
|
|
10376
10389
|
"name": "messageOverrides",
|
|
10377
|
-
"description": "Replace localized message strings with your own strings
|
|
10390
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
10378
10391
|
"type": "Record<string, unknown>"
|
|
10379
10392
|
},
|
|
10380
10393
|
{
|
|
@@ -10727,7 +10740,7 @@
|
|
|
10727
10740
|
},
|
|
10728
10741
|
{
|
|
10729
10742
|
"name": "arcgis-print",
|
|
10730
|
-
"description": "The Print
|
|
10743
|
+
"description": "The Print component connects your application with a [printing service](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-the-portal-to-print-maps.htm) to allow the map to be printed.\nIt takes advantage of server-side, high-quality, full cartographic print functionality using the ExportWebMap service of ArcGIS,\nwhich can be configured with custom layout templates. One is provided that shows the map only, while another provides a layout with legend, etc.\nThe Print component works with the [print](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html) module, which generates a printer-ready version of the map.\n\nThe Print component uses the ArcGIS Online print service by default, but it can be configured to use a custom print service with the [printServiceUrl](#printServiceUrl) property.\nThe component can preserve map scale or map extent in the printout. By default, the map extent is preserved. Use\n[TemplateOptions.scaleEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#scaleEnabled) to preserve scale instead.\n\nThe Print component prints a localized date for all [layouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#layout)\nexcept `map-only`. If using a custom print service, then `customTextElements` are supported for each print\ntemplate. Values found there will be populated in the Print component under `Advanced options`. These values can\nbe overwritten in the Print component UI, or programmatically using the\n[templateCustomTextElements](#templateCustomTextElements) property.\n\nFor more information about printing with the `MAP_ONLY` layout, please see\n[exportOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#exportOptions).\n\n**Known limitations**\n\nSee [print](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html) for a detailed list of known limitations.\n\n```html\n<arcgis-map item-id=\"45725ba7d9fb47a0925398919b13d1fa\">\n <arcgis-print position=\"top-right\"></arcgis-print>\n</arcgis-map>\n```\n\n```js\n// get a reference to the component\nconst components = document.querySelectorAll(\"arcgis-print\");\n\nconst portal = new Portal({\n url: \"https://user.maps.arcgis.com/sharing\",\n authMode: \"immediate\",\n authorizedCrossOriginDomains: [\"https://user.maps.arcgis.com\"],\n});\n\ncomponents.forEach((component) => {\n component.portal = portal;\n});\n```\n--\n\n### Events\n- **arcgisComplete** - Emitted when the component is complete.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisSubmit** - Emitted when the component is submitted.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
10731
10744
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-print/",
|
|
10732
10745
|
"attributes": [
|
|
10733
10746
|
{
|
|
@@ -10740,6 +10753,7 @@
|
|
|
10740
10753
|
},
|
|
10741
10754
|
{
|
|
10742
10755
|
"name": "allowed-formats-for-saving",
|
|
10756
|
+
"description": "Specifies the print output file format(s) that the user can select when saving the exported map printout.\nThis property can take a string value or an array of string values.",
|
|
10743
10757
|
"value": {
|
|
10744
10758
|
"type": "\"all\""
|
|
10745
10759
|
}
|
|
@@ -10785,7 +10799,7 @@
|
|
|
10785
10799
|
},
|
|
10786
10800
|
{
|
|
10787
10801
|
"name": "heading-level",
|
|
10788
|
-
"description": "Indicates the heading level to use for the \"Exported files\" text where users can\naccess the exported map printout. By default, this text is rendered\nas a level 3 heading (e.g. `<h3>Exported files</h3>`). Depending on the
|
|
10802
|
+
"description": "Indicates the heading level to use for the \"Exported files\" text where users can\naccess the exported map printout. By default, this text is rendered\nas a level 3 heading (e.g. `<h3>Exported files</h3>`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.",
|
|
10789
10803
|
"default": "3",
|
|
10790
10804
|
"value": {
|
|
10791
10805
|
"type": [
|
|
@@ -10800,6 +10814,7 @@
|
|
|
10800
10814
|
},
|
|
10801
10815
|
{
|
|
10802
10816
|
"name": "hide-header",
|
|
10817
|
+
"description": "Indicates whether the component's header is hidden.",
|
|
10803
10818
|
"default": "false",
|
|
10804
10819
|
"value": {
|
|
10805
10820
|
"type": "boolean"
|
|
@@ -10822,6 +10837,7 @@
|
|
|
10822
10837
|
},
|
|
10823
10838
|
{
|
|
10824
10839
|
"name": "position",
|
|
10840
|
+
"description": "The UI position of a component.",
|
|
10825
10841
|
"default": "\"top-left\"",
|
|
10826
10842
|
"value": {
|
|
10827
10843
|
"type": [
|
|
@@ -10839,20 +10855,21 @@
|
|
|
10839
10855
|
},
|
|
10840
10856
|
{
|
|
10841
10857
|
"name": "print-service-url",
|
|
10842
|
-
"description": "The URL of the REST endpoint of the Export Web Map Task.\nIf the [portal](#portal) property is set,
|
|
10858
|
+
"description": "The URL of the REST endpoint of the Export Web Map Task.\nDefaults to the ArcGIS Online print service if this property is not specified.\nIf the [portal](#portal) property is set, this property will use the portal's print service URL.",
|
|
10843
10859
|
"value": {
|
|
10844
10860
|
"type": "string"
|
|
10845
10861
|
}
|
|
10846
10862
|
},
|
|
10847
10863
|
{
|
|
10848
10864
|
"name": "reference-element",
|
|
10865
|
+
"description": "By passing the `id` of the Map or Scene component into this property, you can position components from the `@arcgis/map-components`\npackage anywhere in the DOM while still maintaining a connection to the Map or Scene.\n\nSee [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component).",
|
|
10849
10866
|
"value": {
|
|
10850
10867
|
"type": "string"
|
|
10851
10868
|
}
|
|
10852
10869
|
},
|
|
10853
10870
|
{
|
|
10854
10871
|
"name": "show-print-area-enabled",
|
|
10855
|
-
"description": "The initial state of the print area toggle in the Print
|
|
10872
|
+
"description": "The initial state of the print area toggle in the Print component UI.\nWhen set to `true`, the print area toggle is enabled by default.\nWhen set to `false`, the print area toggle is disabled by default.",
|
|
10856
10873
|
"default": "false",
|
|
10857
10874
|
"value": {
|
|
10858
10875
|
"type": "boolean"
|
|
@@ -10860,7 +10877,7 @@
|
|
|
10860
10877
|
},
|
|
10861
10878
|
{
|
|
10862
10879
|
"name": "state",
|
|
10863
|
-
"description": "The
|
|
10880
|
+
"description": "The state of the Print component.",
|
|
10864
10881
|
"default": "\"disabled\"",
|
|
10865
10882
|
"value": {
|
|
10866
10883
|
"type": [
|
|
@@ -10875,7 +10892,8 @@
|
|
|
10875
10892
|
"events": [
|
|
10876
10893
|
{
|
|
10877
10894
|
"name": "arcgisComplete",
|
|
10878
|
-
"type": "{ link: FileLink; }"
|
|
10895
|
+
"type": "{ link: FileLink; }",
|
|
10896
|
+
"description": "Emitted when the component is complete."
|
|
10879
10897
|
},
|
|
10880
10898
|
{
|
|
10881
10899
|
"name": "arcgisPropertyChange",
|
|
@@ -10889,7 +10907,8 @@
|
|
|
10889
10907
|
},
|
|
10890
10908
|
{
|
|
10891
10909
|
"name": "arcgisSubmit",
|
|
10892
|
-
"type": "{ link: FileLink; }"
|
|
10910
|
+
"type": "{ link: FileLink; }",
|
|
10911
|
+
"description": "Emitted when the component is submitted."
|
|
10893
10912
|
}
|
|
10894
10913
|
],
|
|
10895
10914
|
"js": {
|
|
@@ -10901,6 +10920,7 @@
|
|
|
10901
10920
|
},
|
|
10902
10921
|
{
|
|
10903
10922
|
"name": "allowedFormatsForSaving",
|
|
10923
|
+
"description": "Specifies the print output file format(s) that the user can select when saving the exported map printout.\nThis property can take a string value or an array of string values.",
|
|
10904
10924
|
"type": "\"all\" | Array<string>"
|
|
10905
10925
|
},
|
|
10906
10926
|
{
|
|
@@ -10929,7 +10949,7 @@
|
|
|
10929
10949
|
},
|
|
10930
10950
|
{
|
|
10931
10951
|
"name": "exportedLinks",
|
|
10932
|
-
"description": "The collection of links exported from the Print
|
|
10952
|
+
"description": "The collection of links exported from the Print component.",
|
|
10933
10953
|
"type": "Collection<FileLink>"
|
|
10934
10954
|
},
|
|
10935
10955
|
{
|
|
@@ -10939,11 +10959,12 @@
|
|
|
10939
10959
|
},
|
|
10940
10960
|
{
|
|
10941
10961
|
"name": "headingLevel",
|
|
10942
|
-
"description": "Indicates the heading level to use for the \"Exported files\" text where users can\naccess the exported map printout. By default, this text is rendered\nas a level 3 heading (e.g. `<h3>Exported files</h3>`). Depending on the
|
|
10962
|
+
"description": "Indicates the heading level to use for the \"Exported files\" text where users can\naccess the exported map printout. By default, this text is rendered\nas a level 3 heading (e.g. `<h3>Exported files</h3>`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.",
|
|
10943
10963
|
"type": "1 | 2 | 3 | 4 | 5 | 6"
|
|
10944
10964
|
},
|
|
10945
10965
|
{
|
|
10946
10966
|
"name": "hideHeader",
|
|
10967
|
+
"description": "Indicates whether the component's header is hidden.",
|
|
10947
10968
|
"type": "boolean"
|
|
10948
10969
|
},
|
|
10949
10970
|
{
|
|
@@ -10958,30 +10979,32 @@
|
|
|
10958
10979
|
},
|
|
10959
10980
|
{
|
|
10960
10981
|
"name": "messageOverrides",
|
|
10961
|
-
"description": "Replace localized message strings with your own strings
|
|
10982
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
10962
10983
|
"type": "Record<string, unknown>"
|
|
10963
10984
|
},
|
|
10964
10985
|
{
|
|
10965
10986
|
"name": "outSpatialReference",
|
|
10966
|
-
"description": "The [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) used to render
|
|
10987
|
+
"description": "The [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) used to render the printed map on the server.",
|
|
10967
10988
|
"type": "SpatialReference"
|
|
10968
10989
|
},
|
|
10969
10990
|
{
|
|
10970
10991
|
"name": "portal",
|
|
10971
|
-
"description": "It is possible to search a specified portal instance's [locator services](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm).\nUse this property to set this [ArcGIS Portal](https://enterprise.arcgis.com/en/portal/) instance to search.\nThis is especially helpful when working with a [custom](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-CustomTemplate.html).\n\nIf this property is set, it is not necessary to set the [printServiceUrl](#printServiceUrl) property.",
|
|
10992
|
+
"description": "It is possible to search a specified portal instance's [locator services](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm).\nUse this property to set this [ArcGIS Portal](https://enterprise.arcgis.com/en/portal/) instance to search.\nThis is especially helpful when working with a [custom template](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-CustomTemplate.html).\n\nIf this property is set, it is not necessary to set the [printServiceUrl](#printServiceUrl) property.",
|
|
10972
10993
|
"type": "Portal"
|
|
10973
10994
|
},
|
|
10974
10995
|
{
|
|
10975
10996
|
"name": "position",
|
|
10997
|
+
"description": "The UI position of a component.",
|
|
10976
10998
|
"type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\""
|
|
10977
10999
|
},
|
|
10978
11000
|
{
|
|
10979
11001
|
"name": "printServiceUrl",
|
|
10980
|
-
"description": "The URL of the REST endpoint of the Export Web Map Task.\nIf the [portal](#portal) property is set,
|
|
11002
|
+
"description": "The URL of the REST endpoint of the Export Web Map Task.\nDefaults to the ArcGIS Online print service if this property is not specified.\nIf the [portal](#portal) property is set, this property will use the portal's print service URL.",
|
|
10981
11003
|
"type": "string"
|
|
10982
11004
|
},
|
|
10983
11005
|
{
|
|
10984
11006
|
"name": "referenceElement",
|
|
11007
|
+
"description": "By passing the `id` of the Map or Scene component into this property, you can position components from the `@arcgis/map-components`\npackage anywhere in the DOM while still maintaining a connection to the Map or Scene.\n\nSee [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component).",
|
|
10985
11008
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
10986
11009
|
},
|
|
10987
11010
|
{
|
|
@@ -10990,29 +11013,30 @@
|
|
|
10990
11013
|
},
|
|
10991
11014
|
{
|
|
10992
11015
|
"name": "showPrintAreaEnabled",
|
|
10993
|
-
"description": "The initial state of the print area toggle in the Print
|
|
11016
|
+
"description": "The initial state of the print area toggle in the Print component UI.\nWhen set to `true`, the print area toggle is enabled by default.\nWhen set to `false`, the print area toggle is disabled by default.",
|
|
10994
11017
|
"type": "boolean"
|
|
10995
11018
|
},
|
|
10996
11019
|
{
|
|
10997
11020
|
"name": "state",
|
|
10998
|
-
"description": "The
|
|
11021
|
+
"description": "The state of the Print component.",
|
|
10999
11022
|
"type": "\"disabled\" | \"error\" | \"initializing\" | \"ready\""
|
|
11000
11023
|
},
|
|
11001
11024
|
{
|
|
11002
11025
|
"name": "templateCustomTextElements",
|
|
11003
|
-
"description": "An object containing an array of `customTextElements` name-value pair objects\nfor each print template in a custom print service. Use this property to update\nthe text for custom text elements on the page layout.\n\nThe Print
|
|
11026
|
+
"description": "An object containing an array of `customTextElements` name-value pair objects\nfor each print template in a custom print service. Use this property to update\nthe text for custom text elements on the page layout.\n\nThe Print component calls the `Get Layout Templates Info` task on the GPServer\nto discover possible `customTextElements` values for each template. The name of\nthe task must match `Get Layout Templates Info`, templates must be published\nwith `customTextElements`, and values must be strings. Values found there will be\npopulated in the Print component under `Advanced options`. These values can be\noverwritten in the Print component UI, or programmatically using this property.\nTo list all print templates available on the print service to see\nsee which templates were published with `customTextElements`, use the\n[effectiveTemplateCustomTextElements](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#effectiveTemplateCustomTextElements)\nproperty.",
|
|
11004
11027
|
"type": "{\n [x: string]: Array<HashMap<string>> | undefined;\n}"
|
|
11005
11028
|
},
|
|
11006
11029
|
{
|
|
11007
11030
|
"name": "templateOptions",
|
|
11008
|
-
"description": "Defines the layout template options used by the
|
|
11031
|
+
"description": "Defines the layout template options used by the Print component to generate the print page.",
|
|
11009
11032
|
"type": "TemplateOptions"
|
|
11010
11033
|
}
|
|
11011
11034
|
],
|
|
11012
11035
|
"events": [
|
|
11013
11036
|
{
|
|
11014
11037
|
"name": "arcgisComplete",
|
|
11015
|
-
"type": "{ link: FileLink; }"
|
|
11038
|
+
"type": "{ link: FileLink; }",
|
|
11039
|
+
"description": "Emitted when the component is complete."
|
|
11016
11040
|
},
|
|
11017
11041
|
{
|
|
11018
11042
|
"name": "arcgisPropertyChange",
|
|
@@ -11026,14 +11050,15 @@
|
|
|
11026
11050
|
},
|
|
11027
11051
|
{
|
|
11028
11052
|
"name": "arcgisSubmit",
|
|
11029
|
-
"type": "{ link: FileLink; }"
|
|
11053
|
+
"type": "{ link: FileLink; }",
|
|
11054
|
+
"description": "Emitted when the component is submitted."
|
|
11030
11055
|
}
|
|
11031
11056
|
]
|
|
11032
11057
|
}
|
|
11033
11058
|
},
|
|
11034
11059
|
{
|
|
11035
11060
|
"name": "arcgis-scale-bar",
|
|
11036
|
-
"description": "The Scale Bar component displays a scale bar representing the scale of the map.\nIt respects various coordinate systems and displays units in metric or imperial values.\nMetric values show either kilometers, meters, centimeters, or millimeters depending on the scale, and likewise, imperial values show miles, feet, or inches depending on the scale.\nWhen working with Web Mercator or geographic coordinate systems the scale bar takes into account projection distortion and dynamically adjusts the scale bar.\n\nWhen the scale bar is inside the map, the actual location of the scale bar is used to calculate the scale.\nOtherwise, the center of the map is used to calculate the scale.\n\n**Known
|
|
11061
|
+
"description": "The Scale Bar component displays a scale bar representing the scale of the map.\nIt respects various coordinate systems and displays units in metric or imperial values.\nMetric values show either kilometers, meters, centimeters, or millimeters depending on the scale, and likewise, imperial values show miles, feet, or inches depending on the scale.\nWhen working with Web Mercator or geographic coordinate systems the scale bar takes into account projection distortion and dynamically adjusts the scale bar.\n\nWhen the scale bar is inside the map, the actual location of the scale bar is used to calculate the scale.\nOtherwise, the center of the map is used to calculate the scale.\n\n**Known limitations**\n\n- This component is not currently supported within a Scene component.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
11037
11062
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scale-bar/",
|
|
11038
11063
|
"attributes": [
|
|
11039
11064
|
{
|
|
@@ -11136,7 +11161,7 @@
|
|
|
11136
11161
|
},
|
|
11137
11162
|
{
|
|
11138
11163
|
"name": "messageOverrides",
|
|
11139
|
-
"description": "Replace localized message strings with your own strings
|
|
11164
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
11140
11165
|
"type": "Record<string, unknown>"
|
|
11141
11166
|
},
|
|
11142
11167
|
{
|
|
@@ -11405,7 +11430,7 @@
|
|
|
11405
11430
|
},
|
|
11406
11431
|
{
|
|
11407
11432
|
"name": "arcgis-scene",
|
|
11408
|
-
"description": "The ArcGIS Scene component is used to add 3D maps to web applications. For 2D maps, use the\n[ArcGIS Map component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/).\n\nThe Scene component creates a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)\nand loads a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\"></arcgis-scene>\n```\n\nAlternatively, the Scene component can be initialized without a WebScene item:\n\n```html\n<arcgis-scene\n basemap=\"satellite\"\n ground=\"world-elevation\"\n camera-position=\"12.3808, 46.3959, 4400\"\n camera-tilt=\"75\"\n camera-heading=\"300\">\n</arcgis-scene>\n```\n\nFurther components can be added and connected to the Scene component:\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\">\n <arcgis-layer-list position=\"bottom-right\"></arcgis-layer-list>\n</arcgis-scene>\n```\n\nThe Scene component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/api-reference/)\nof the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-scene\");\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My layer\"});\n viewElement.map.add(layer);\n});\n```\n\nSee also:\n- [SDK sample apps using the Scene component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-scene)\n- [Getting started](https://developers.arcgis.com/javascript/latest/get-started-overview/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)\n--\n\n### Events\n- **arcgisViewChange** - This event is for view related property changes:\n[zoom](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#zoom),\n[scale](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#scale),\n[center](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#center),\n[rotation](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#rotation),\n[extent](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#extent),\n[camera](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#camera),\n[viewpoint](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#viewpoint).\nThis event will also emit if [stationary](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#stationary)\ntoggles from `true` to `false`.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n\n```\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n // ....\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-click)\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-double-click)\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-drag)\n- **arcgisViewHold** - Fires after holding either a mouse button or a single finger on the view for a short amount of time.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-hold)\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-click)\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-double-click)\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-down)\n- **arcgisViewKeyUp** - Fires after a keyboard key is released.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-up)\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding LayerView created and rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create)\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the map.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create-error)\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-destroy)\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-mouse-wheel)\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-down)\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-enter)\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-leave)\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-move)\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-up)\n- **arcgisViewReadyChange** - This event is for the [ready](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#ready)\nproperty and will be emitted when the view is ready.\nThis event will also emit if the [map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) property is changed.\n\n```\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My layer\"});\n viewElement.map.add(layer);\n});\n```\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.add(layer)` instead.\n\nAdds a layer to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addTable(table: __esri.FeatureLayer): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.tables.add(table)` instead.\n\nAdds a table to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `addTables(tables: __esri.FeatureLayer[], index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `closePopup(): Promise<void>` - Closes the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#popup).\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the Scene component, and any associated resources, including its\n[map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map),\n[popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#popup),\nand removes components or other UI DOM elements added to it.\n- `goTo(target: __esri.GoToTarget3D, options?: __esri.GoToOptions3D): Promise<unknown>` - Sets the view to a given target.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo)\n- `hitTest(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewHitTestOptions): Promise<__esri.SceneViewHitTestResult>` - Returns [hit test results](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult)\nfrom each layer that intersects the specified screen coordinates.\n\n```\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n if (result?.type === \"graphic\") {\n const { longitude, latitude } = result.mapPoint;\n console.log(\"Hit graphic at (\" + longitude + \", \" + latitude + \")\", result.graphic);\n } else {\n console.log(\"Did not hit any graphic\");\n }\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest)\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup based on input options.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#openPopup)\n- `takeScreenshot(options?: __esri.SceneViewTakeScreenshotOptions): Promise<__esri.SceneViewScreenshot>` - Creates a screenshot of the current view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot)\n- `toMap(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewToMapOptions): __esri.Point | nullish` - Converts the given screen point to a [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).\n- `toScreen(point: __esri.Point): __esri.SceneViewScreenPoint` - Converts the given [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) to a screen point.\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters: a `callback` function and an `errback` function.\n- `whenAnalysisView(analysis: __esri.AreaMeasurementAnalysis | __esri.DimensionAnalysis | __esri.DirectLineMeasurementAnalysis | __esri.LineOfSightAnalysis | __esri.SliceAnalysis | __esri.ViewshedAnalysis): Promise<__esri.AreaMeasurementAnalysisView3D | __esri.DimensionAnalysisView3D | __esri.DirectLineMeasurementAnalysisView3D | __esri.LineOfSightAnalysisView3D | __esri.SliceAnalysisView3D | __esri.ViewshedAnalysisView3D>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenAnalysisView)\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the layer view created on the view for the given layer.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenLayerView)",
|
|
11433
|
+
"description": "The ArcGIS Scene component is used to add 3D maps to web applications. For 2D maps, use the\n[ArcGIS Map component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/).\n\nThe Scene component creates a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)\nand loads a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\"></arcgis-scene>\n```\n\nAlternatively, the Scene component can be initialized without a WebScene item:\n\n```html\n<arcgis-scene\n basemap=\"satellite\"\n ground=\"world-elevation\"\n camera-position=\"12.3808, 46.3959, 4400\"\n camera-tilt=\"75\"\n camera-heading=\"300\">\n</arcgis-scene>\n```\n\nFurther components can be added and connected to the Scene component:\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\">\n <arcgis-layer-list position=\"bottom-right\"></arcgis-layer-list>\n</arcgis-scene>\n```\n\nThe Scene component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/api-reference/)\nof the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-scene\");\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My layer\"});\n viewElement.map.add(layer);\n});\n```\n\nSee also:\n- [SDK sample apps using the Scene component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-scene)\n- [Getting started](https://developers.arcgis.com/javascript/latest/get-started-overview/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)\n--\n\n### Events\n- **arcgisViewChange** - This event is for view related property changes:\n[zoom](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#zoom),\n[scale](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#scale),\n[center](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#center),\n[rotation](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#rotation),\n[extent](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#extent),\n[camera](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#camera),\n[viewpoint](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#viewpoint).\nThis event will also emit if [stationary](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#stationary)\ntoggles from `true` to `false`.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n // ....\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-click)\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-double-click)\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-drag)\n- **arcgisViewHold** - Fires after holding either a mouse button or a single finger on the view for a short amount of time.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-hold)\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-click)\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-double-click)\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-down)\n- **arcgisViewKeyUp** - Fires after a keyboard key is released.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-up)\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding LayerView created and rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create)\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the map.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create-error)\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-destroy)\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-mouse-wheel)\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-down)\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-enter)\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-leave)\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-move)\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-up)\n- **arcgisViewReadyChange** - This event is for the [ready](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#ready)\nproperty and will be emitted when the view is ready.\nThis event will also emit if the [map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) property is changed.\n\n```js\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My layer\"});\n viewElement.map.add(layer);\n});\n```\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.add(layer)` instead.\n\nAdds a layer to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addTable(table: __esri.FeatureLayer): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.tables.add(table)` instead.\n\nAdds a table to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `addTables(tables: __esri.FeatureLayer[], index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `closePopup(): Promise<void>` - Closes the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#popup).\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the Scene component, and any associated resources, including its\n[map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map),\n[popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#popup),\nand removes components or other UI DOM elements added to it.\n- `goTo(target: __esri.GoToTarget3D, options?: __esri.GoToOptions3D): Promise<unknown>` - Sets the view to a given target.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo)\n- `hitTest(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewHitTestOptions): Promise<__esri.SceneViewHitTestResult>` - Returns [hit test results](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult)\nfrom each layer that intersects the specified screen coordinates.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n if (result?.type === \"graphic\") {\n const { longitude, latitude } = result.mapPoint;\n console.log(\"Hit graphic at (\" + longitude + \", \" + latitude + \")\", result.graphic);\n } else {\n console.log(\"Did not hit any graphic\");\n }\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest)\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup based on input options.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#openPopup)\n- `takeScreenshot(options?: __esri.SceneViewTakeScreenshotOptions): Promise<__esri.SceneViewScreenshot>` - Creates a screenshot of the current view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot)\n- `toMap(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewToMapOptions): __esri.Point | nullish` - Converts the given screen point to a [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).\n- `toScreen(point: __esri.Point): __esri.SceneViewScreenPoint` - Converts the given [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) to a screen point.\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters: a `callback` function and an `errback` function.\n- `whenAnalysisView(analysis: __esri.AreaMeasurementAnalysis | __esri.DimensionAnalysis | __esri.DirectLineMeasurementAnalysis | __esri.LineOfSightAnalysis | __esri.SliceAnalysis | __esri.ViewshedAnalysis): Promise<__esri.AreaMeasurementAnalysisView3D | __esri.DimensionAnalysisView3D | __esri.DirectLineMeasurementAnalysisView3D | __esri.LineOfSightAnalysisView3D | __esri.SliceAnalysisView3D | __esri.ViewshedAnalysisView3D>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenAnalysisView)\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the layer view created on the view for the given layer.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenLayerView)",
|
|
11409
11434
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/",
|
|
11410
11435
|
"attributes": [
|
|
11411
11436
|
{
|
|
@@ -11550,7 +11575,7 @@
|
|
|
11550
11575
|
{
|
|
11551
11576
|
"name": "arcgisViewClick",
|
|
11552
11577
|
"type": "ViewClickEvent",
|
|
11553
|
-
"description": "Fires after a user clicks on the view.\n\n
|
|
11578
|
+
"description": "Fires after a user clicks on the view.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n // ....\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-click)"
|
|
11554
11579
|
},
|
|
11555
11580
|
{
|
|
11556
11581
|
"name": "arcgisViewDoubleClick",
|
|
@@ -11635,7 +11660,7 @@
|
|
|
11635
11660
|
{
|
|
11636
11661
|
"name": "arcgisViewReadyChange",
|
|
11637
11662
|
"type": "void",
|
|
11638
|
-
"description": "This event is for the [ready](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#ready)\nproperty and will be emitted when the view is ready.\nThis event will also emit if the [map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) property is changed.\n\n
|
|
11663
|
+
"description": "This event is for the [ready](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#ready)\nproperty and will be emitted when the view is ready.\nThis event will also emit if the [map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) property is changed.\n\n```js\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My layer\"});\n viewElement.map.add(layer);\n});\n```"
|
|
11639
11664
|
}
|
|
11640
11665
|
],
|
|
11641
11666
|
"js": {
|
|
@@ -11735,6 +11760,11 @@
|
|
|
11735
11760
|
"description": "Applies a display filter on the view for a specific set of floor levels.\nIt can filter the map display on floor-aware layers by zero or more level IDs.",
|
|
11736
11761
|
"type": "Collection<string>"
|
|
11737
11762
|
},
|
|
11763
|
+
{
|
|
11764
|
+
"name": "focusAreas",
|
|
11765
|
+
"description": "A container of all [focus areas](https://developers.arcgis.com/javascript/latest/api-reference/esri-effects-FocusAreas.html) present in the map.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#focusAreas)",
|
|
11766
|
+
"type": "FocusAreas"
|
|
11767
|
+
},
|
|
11738
11768
|
{
|
|
11739
11769
|
"name": "gamepad",
|
|
11740
11770
|
"description": "Gamepad input specific configuration settings.",
|
|
@@ -11742,7 +11772,7 @@
|
|
|
11742
11772
|
},
|
|
11743
11773
|
{
|
|
11744
11774
|
"name": "graphics",
|
|
11745
|
-
"description": "Allows for adding graphics directly to the default graphics in the view
|
|
11775
|
+
"description": "Allows for adding graphics directly to the default graphics in the view.",
|
|
11746
11776
|
"type": "Collection<Graphic>"
|
|
11747
11777
|
},
|
|
11748
11778
|
{
|
|
@@ -11905,7 +11935,7 @@
|
|
|
11905
11935
|
{
|
|
11906
11936
|
"name": "arcgisViewClick",
|
|
11907
11937
|
"type": "ViewClickEvent",
|
|
11908
|
-
"description": "Fires after a user clicks on the view.\n\n
|
|
11938
|
+
"description": "Fires after a user clicks on the view.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n // ....\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-click)"
|
|
11909
11939
|
},
|
|
11910
11940
|
{
|
|
11911
11941
|
"name": "arcgisViewDoubleClick",
|
|
@@ -11990,14 +12020,14 @@
|
|
|
11990
12020
|
{
|
|
11991
12021
|
"name": "arcgisViewReadyChange",
|
|
11992
12022
|
"type": "void",
|
|
11993
|
-
"description": "This event is for the [ready](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#ready)\nproperty and will be emitted when the view is ready.\nThis event will also emit if the [map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) property is changed.\n\n
|
|
12023
|
+
"description": "This event is for the [ready](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#ready)\nproperty and will be emitted when the view is ready.\nThis event will also emit if the [map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) property is changed.\n\n```js\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My layer\"});\n viewElement.map.add(layer);\n});\n```"
|
|
11994
12024
|
}
|
|
11995
12025
|
]
|
|
11996
12026
|
}
|
|
11997
12027
|
},
|
|
11998
12028
|
{
|
|
11999
12029
|
"name": "arcgis-search",
|
|
12000
|
-
"description": "The Search component provides a way to perform search operations on locator service(s), map/feature service feature layer(s), SceneLayers with an associated feature layer,\nBuildingComponentSublayer with an associated feature layer, GeoJSONLayer, CSVLayer, OGCFeatureLayer, and/or table(s). If using a locator with a geocoding service, the\nfindAddressCandidates operation is used, whereas queries are used on feature layers.\n\nBy default, the Search component uses the ArcGIS World Geocoding Service via this URL: `https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer`.\nIf a global apiKey is present, the Search component uses this URL: `https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer`. If an apiKey\nis present on the LocatorSearchSource, then the Search component uses the URL defined by the LocatorSearchSource.url property.\n\nThe Search component sets the view on the Search result. The level of detail (LOD) at the center of the view depends on the data source, with higher quality data\nsources returning extents closer to the `feature` obtained from the search. To manually define the scale of the view at the Search result, use the `zoomScale` property\nof the LocatorSearchSource or LayerSearchSource. Search component results are typically sorted according to their relevance to the search and their relative importance.\nHowever, when the scale of the MapView or SceneView is less than or equal to 300,000, the operations support prioritization of candidates based on their distance from a\nspecified point (the center of the view) by passing in the `location parameter`. Features closest to the input location show up higher in the list of results.\nThis behavior can be changed by using the localSearchDisabled property.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisSearchClear** - Fires when a result is cleared from the input box or a new result is selected.\n- **arcgisSearchComplete** - Fires when the [search()](#search) method is called and returns its results.\n- **arcgisSearchStart** - Fires when the [search()](#search) method starts.\n- **arcgisSelectResult** - Fires when a search result is selected.\n- **arcgisSuggestComplete** - Fires when the [suggest](#suggest) method is called and returns its results.\n- **arcgisSuggestStart** - Fires when the [suggest()](#suggest) method starts.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `setFocus(): Promise<void>` - Brings focus to the component's text input.",
|
|
12030
|
+
"description": "The Search component provides a way to perform search operations on locator service(s), map/feature service feature layer(s), SceneLayers with an associated feature layer,\nBuildingComponentSublayer with an associated feature layer, GeoJSONLayer, CSVLayer, OGCFeatureLayer, and/or table(s). If using a locator with a geocoding service, the\nfindAddressCandidates operation is used, whereas queries are used on feature layers.\n\nBy default, the Search component uses the ArcGIS World Geocoding Service via this URL: `https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer`.\nIf a global apiKey is present, the Search component uses this URL: `https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer`. If an apiKey\nis present on the LocatorSearchSource, then the Search component uses the URL defined by the LocatorSearchSource.url property.\n\nThe Search component sets the view on the Search result. The level of detail (LOD) at the center of the view depends on the data source, with higher quality data\nsources returning extents closer to the `feature` obtained from the search. To manually define the scale of the view at the Search result, use the `zoomScale` property\nof the LocatorSearchSource or LayerSearchSource. Search component results are typically sorted according to their relevance to the search and their relative importance.\nHowever, when the scale of the MapView or SceneView is less than or equal to 300,000, the operations support prioritization of candidates based on their distance from a\nspecified point (the center of the view) by passing in the `location parameter`. Features closest to the input location show up higher in the list of results.\nThis behavior can be changed by using the localSearchDisabled property.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisSearchClear** - Fires when a result is cleared from the input box or a new result is selected.\n- **arcgisSearchComplete** - Fires when the [search()](#search) method is called and returns its results.\n- **arcgisSearchStart** - Fires when the [search()](#search) method starts.\n- **arcgisSelectResult** - Fires when a search result is selected.\n- **arcgisSuggestComplete** - Fires when the [suggest](#suggest) method is called and returns its results.\n- **arcgisSuggestStart** - Fires when the [suggest()](#suggest) method starts.\n\n### Methods\n- `clear(): void` - Clears the current searchTerm, search results, suggest results, graphic, and graphics layer.\nIt also hides any open menus.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `search(searchItem?: __esri.Graphic | __esri.Point | __esri.SuggestResult | Nil | number[] | string): Promise<__esri.SearchResponse | Nil>` - Depending on the sources specified, search() queries the feature layer(s) and/or performs\naddress matching using any specified [locator(s)](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html) and\nreturns any applicable results.\n- `setFocus(): Promise<void>` - Brings focus to the component's text input.\n- `suggest(query?: string): Promise<__esri.SuggestResponse | Nil>` - Performs a suggest() request on the active Locator. It also uses the current value of\nthe component or one that is passed in.\n\nSuggestions are available if working with a 10.3 or greater geocoding service that has\n[suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e.\n`supportsPagination = true`.",
|
|
12001
12031
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-search/",
|
|
12002
12032
|
"attributes": [
|
|
12003
12033
|
{
|
|
@@ -12037,9 +12067,9 @@
|
|
|
12037
12067
|
}
|
|
12038
12068
|
},
|
|
12039
12069
|
{
|
|
12040
|
-
"name": "auto-select",
|
|
12070
|
+
"name": "auto-select-disabled",
|
|
12041
12071
|
"description": "Indicates whether to automatically select and zoom to the first geocoded result. If `false`, the\n[findAddressCandidates](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm)\noperation will still geocode the input string, but the top result will not be selected. To work with the\ngeocoded results, you can set up a [search-complete](#event-search-complete) event handler and get the results\nthrough the event object.",
|
|
12042
|
-
"default": "
|
|
12072
|
+
"default": "false",
|
|
12043
12073
|
"value": {
|
|
12044
12074
|
"type": "boolean"
|
|
12045
12075
|
}
|
|
@@ -12061,9 +12091,9 @@
|
|
|
12061
12091
|
}
|
|
12062
12092
|
},
|
|
12063
12093
|
{
|
|
12064
|
-
"name": "include-default-sources",
|
|
12094
|
+
"name": "include-default-sources-disabled",
|
|
12065
12095
|
"description": "Indicates whether or not to include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI.\nThis can be a boolean value or a function that returns an array of Search [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources).",
|
|
12066
|
-
"default": "
|
|
12096
|
+
"default": "false",
|
|
12067
12097
|
"value": {
|
|
12068
12098
|
"type": "boolean"
|
|
12069
12099
|
}
|
|
@@ -12076,9 +12106,9 @@
|
|
|
12076
12106
|
}
|
|
12077
12107
|
},
|
|
12078
12108
|
{
|
|
12079
|
-
"name": "location-
|
|
12109
|
+
"name": "location-disabled",
|
|
12080
12110
|
"description": "Enables location services within the component.\n\n\n\n::: esri-md class=\"warning\"\nThe use of this property is only supported on secure origins.\nTo use it, switch your application to a secure origin, such as HTTPS.\nNote that localhost is considered \"potentially secure\" and can be used for easy testing in browsers that supports\n[Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext#browser_compatibility)\n(currently Chrome and Firefox).\n:::",
|
|
12081
|
-
"default": "
|
|
12111
|
+
"default": "false",
|
|
12082
12112
|
"value": {
|
|
12083
12113
|
"type": "boolean"
|
|
12084
12114
|
}
|
|
@@ -12108,9 +12138,9 @@
|
|
|
12108
12138
|
}
|
|
12109
12139
|
},
|
|
12110
12140
|
{
|
|
12111
|
-
"name": "popup-
|
|
12141
|
+
"name": "popup-disabled",
|
|
12112
12142
|
"description": "Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) on feature click. The graphic can\nbe clicked to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).",
|
|
12113
|
-
"default": "
|
|
12143
|
+
"default": "false",
|
|
12114
12144
|
"value": {
|
|
12115
12145
|
"type": "boolean"
|
|
12116
12146
|
}
|
|
@@ -12139,17 +12169,17 @@
|
|
|
12139
12169
|
}
|
|
12140
12170
|
},
|
|
12141
12171
|
{
|
|
12142
|
-
"name": "result-graphic-
|
|
12172
|
+
"name": "result-graphic-disabled",
|
|
12143
12173
|
"description": "Indicates if the [resultGraphic](#resultGraphic) will display at the\nlocation of the selected feature.",
|
|
12144
|
-
"default": "
|
|
12174
|
+
"default": "false",
|
|
12145
12175
|
"value": {
|
|
12146
12176
|
"type": "boolean"
|
|
12147
12177
|
}
|
|
12148
12178
|
},
|
|
12149
12179
|
{
|
|
12150
|
-
"name": "search-all-
|
|
12180
|
+
"name": "search-all-disabled",
|
|
12151
12181
|
"description": "Indicates whether to display the option to search all sources. When `true`, the \"All\" option\nis displayed by default:\n\n\n\nWhen `false`, no option to search all sources at once is available:\n\n",
|
|
12152
|
-
"default": "
|
|
12182
|
+
"default": "false",
|
|
12153
12183
|
"value": {
|
|
12154
12184
|
"type": "boolean"
|
|
12155
12185
|
}
|
|
@@ -12175,9 +12205,9 @@
|
|
|
12175
12205
|
}
|
|
12176
12206
|
},
|
|
12177
12207
|
{
|
|
12178
|
-
"name": "suggestions-
|
|
12208
|
+
"name": "suggestions-disabled",
|
|
12179
12209
|
"description": "Enable suggestions for the component.\n\nThis is only available if working with a 10.3 or greater geocoding service that has [suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`.",
|
|
12180
|
-
"default": "
|
|
12210
|
+
"default": "false",
|
|
12181
12211
|
"value": {
|
|
12182
12212
|
"type": "boolean"
|
|
12183
12213
|
}
|
|
@@ -12258,7 +12288,7 @@
|
|
|
12258
12288
|
"type": "boolean"
|
|
12259
12289
|
},
|
|
12260
12290
|
{
|
|
12261
|
-
"name": "
|
|
12291
|
+
"name": "autoSelectDisabled",
|
|
12262
12292
|
"description": "Indicates whether to automatically select and zoom to the first geocoded result. If `false`, the\n[findAddressCandidates](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm)\noperation will still geocode the input string, but the top result will not be selected. To work with the\ngeocoded results, you can set up a [search-complete](#event-search-complete) event handler and get the results\nthrough the event object.",
|
|
12263
12293
|
"type": "boolean"
|
|
12264
12294
|
},
|
|
@@ -12283,7 +12313,7 @@
|
|
|
12283
12313
|
"type": "string"
|
|
12284
12314
|
},
|
|
12285
12315
|
{
|
|
12286
|
-
"name": "
|
|
12316
|
+
"name": "includeDefaultSourcesDisabled",
|
|
12287
12317
|
"description": "Indicates whether or not to include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI.\nThis can be a boolean value or a function that returns an array of Search [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources).",
|
|
12288
12318
|
"type": "Function | boolean"
|
|
12289
12319
|
},
|
|
@@ -12293,7 +12323,7 @@
|
|
|
12293
12323
|
"type": "string"
|
|
12294
12324
|
},
|
|
12295
12325
|
{
|
|
12296
|
-
"name": "
|
|
12326
|
+
"name": "locationDisabled",
|
|
12297
12327
|
"description": "Enables location services within the component.\n\n\n\n::: esri-md class=\"warning\"\nThe use of this property is only supported on secure origins.\nTo use it, switch your application to a secure origin, such as HTTPS.\nNote that localhost is considered \"potentially secure\" and can be used for easy testing in browsers that supports\n[Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext#browser_compatibility)\n(currently Chrome and Firefox).\n:::",
|
|
12298
12328
|
"type": "boolean"
|
|
12299
12329
|
},
|
|
@@ -12309,7 +12339,7 @@
|
|
|
12309
12339
|
},
|
|
12310
12340
|
{
|
|
12311
12341
|
"name": "messageOverrides",
|
|
12312
|
-
"description": "Replace localized message strings with your own strings
|
|
12342
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
12313
12343
|
"type": "Record<string, unknown>"
|
|
12314
12344
|
},
|
|
12315
12345
|
{
|
|
@@ -12318,7 +12348,7 @@
|
|
|
12318
12348
|
"type": "number"
|
|
12319
12349
|
},
|
|
12320
12350
|
{
|
|
12321
|
-
"name": "
|
|
12351
|
+
"name": "popupDisabled",
|
|
12322
12352
|
"description": "Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) on feature click. The graphic can\nbe clicked to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).",
|
|
12323
12353
|
"type": "boolean"
|
|
12324
12354
|
},
|
|
@@ -12346,7 +12376,7 @@
|
|
|
12346
12376
|
"type": "Graphic"
|
|
12347
12377
|
},
|
|
12348
12378
|
{
|
|
12349
|
-
"name": "
|
|
12379
|
+
"name": "resultGraphicDisabled",
|
|
12350
12380
|
"description": "Indicates if the [resultGraphic](#resultGraphic) will display at the\nlocation of the selected feature.",
|
|
12351
12381
|
"type": "boolean"
|
|
12352
12382
|
},
|
|
@@ -12356,7 +12386,7 @@
|
|
|
12356
12386
|
"type": "Array<SearchResults>"
|
|
12357
12387
|
},
|
|
12358
12388
|
{
|
|
12359
|
-
"name": "
|
|
12389
|
+
"name": "searchAllDisabled",
|
|
12360
12390
|
"description": "Indicates whether to display the option to search all sources. When `true`, the \"All\" option\nis displayed by default:\n\n\n\nWhen `false`, no option to search all sources at once is available:\n\n",
|
|
12361
12391
|
"type": "boolean"
|
|
12362
12392
|
},
|
|
@@ -12386,7 +12416,7 @@
|
|
|
12386
12416
|
"type": "Array<SuggestResults>"
|
|
12387
12417
|
},
|
|
12388
12418
|
{
|
|
12389
|
-
"name": "
|
|
12419
|
+
"name": "suggestionsDisabled",
|
|
12390
12420
|
"description": "Enable suggestions for the component.\n\nThis is only available if working with a 10.3 or greater geocoding service that has [suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`.",
|
|
12391
12421
|
"type": "boolean"
|
|
12392
12422
|
}
|
|
@@ -13499,7 +13529,7 @@
|
|
|
13499
13529
|
},
|
|
13500
13530
|
{
|
|
13501
13531
|
"name": "messageOverrides",
|
|
13502
|
-
"description": "Replace localized message strings with your own strings
|
|
13532
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
13503
13533
|
"type": "Record<string, unknown>"
|
|
13504
13534
|
},
|
|
13505
13535
|
{
|
|
@@ -13512,7 +13542,7 @@
|
|
|
13512
13542
|
},
|
|
13513
13543
|
{
|
|
13514
13544
|
"name": "shape",
|
|
13515
|
-
"description": "The shape used to slice elements in a 3D scene. Currently the only supported shape is a plane
|
|
13545
|
+
"description": "The shape used to slice elements in a 3D scene. Currently the only supported shape is a plane.",
|
|
13516
13546
|
"type": "SlicePlane"
|
|
13517
13547
|
},
|
|
13518
13548
|
{
|
|
@@ -13980,7 +14010,7 @@
|
|
|
13980
14010
|
},
|
|
13981
14011
|
{
|
|
13982
14012
|
"name": "arcgis-swipe",
|
|
13983
|
-
"description": "The Swipe component provides a tool to show a portion of a layer or layers\non top of a map. Layers can be swiped vertically or horizontally to easily\ncompare two layers or see what is underneath a layer.\n\nTo use the Swipe component, set the `leadingLayers` and `trailingLayers`\nproperties to determine what will be compared on either side of the component. If one of these properties\nis not set, then the Swipe component will overlay the existing map.\n\n**Known
|
|
14013
|
+
"description": "The Swipe component provides a tool to show a portion of a layer or layers\non top of a map. Layers can be swiped vertically or horizontally to easily\ncompare two layers or see what is underneath a layer.\n\nTo use the Swipe component, set the `leadingLayers` and `trailingLayers`\nproperties to determine what will be compared on either side of the component. If one of these properties\nis not set, then the Swipe component will overlay the existing map.\n\n**Known limitations**\n\n- This component is not currently supported within a Scene component.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
13984
14014
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-swipe/",
|
|
13985
14015
|
"attributes": [
|
|
13986
14016
|
{
|
|
@@ -14141,7 +14171,7 @@
|
|
|
14141
14171
|
},
|
|
14142
14172
|
{
|
|
14143
14173
|
"name": "messageOverrides",
|
|
14144
|
-
"description": "Replace localized message strings with your own strings
|
|
14174
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
14145
14175
|
"type": "Record<string, unknown>"
|
|
14146
14176
|
},
|
|
14147
14177
|
{
|
|
@@ -14909,7 +14939,7 @@
|
|
|
14909
14939
|
},
|
|
14910
14940
|
{
|
|
14911
14941
|
"name": "messageOverrides",
|
|
14912
|
-
"description": "Replace localized message strings with your own strings
|
|
14942
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
14913
14943
|
"type": "Record<string, unknown>"
|
|
14914
14944
|
},
|
|
14915
14945
|
{
|
|
@@ -14942,7 +14972,7 @@
|
|
|
14942
14972
|
},
|
|
14943
14973
|
{
|
|
14944
14974
|
"name": "arcgis-track",
|
|
14945
|
-
"description": "The Track component is a button that animates the map or scene to the user's location when clicked.\nThe view rotates based on device heading.\nThe default heading symbol will display when speed is greater than zero and the browser provides heading information.\n\n**Known
|
|
14975
|
+
"description": "The Track component is a button that animates the map or scene to the user's location when clicked.\nThe view rotates based on device heading.\nThe default heading symbol will display when speed is greater than zero and the browser provides heading information.\n\n**Known limitations**\n\n- The heading symbol is not currently supported within a Scene component.\n--\n\n### Events\n- **arcgisComplete**\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>`\n- `stop(): Promise<void>`",
|
|
14946
14976
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-track/",
|
|
14947
14977
|
"attributes": [
|
|
14948
14978
|
{
|
|
@@ -15109,7 +15139,7 @@
|
|
|
15109
15139
|
},
|
|
15110
15140
|
{
|
|
15111
15141
|
"name": "messageOverrides",
|
|
15112
|
-
"description": "Replace localized message strings with your own strings
|
|
15142
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
15113
15143
|
"type": "Record<string, unknown>"
|
|
15114
15144
|
},
|
|
15115
15145
|
{
|
|
@@ -16393,7 +16423,7 @@
|
|
|
16393
16423
|
},
|
|
16394
16424
|
{
|
|
16395
16425
|
"name": "page-size",
|
|
16396
|
-
"description": "Specifies the number of versions displayed on each page of the Version Management
|
|
16426
|
+
"description": "Specifies the number of versions displayed on each page of the Version Management component.",
|
|
16397
16427
|
"default": "5",
|
|
16398
16428
|
"value": {
|
|
16399
16429
|
"type": "number"
|
|
@@ -16469,7 +16499,7 @@
|
|
|
16469
16499
|
},
|
|
16470
16500
|
{
|
|
16471
16501
|
"name": "initialVersionInfos",
|
|
16472
|
-
"description": "The `initialVersionInfos` property enables users to initialize the Version Management
|
|
16502
|
+
"description": "The `initialVersionInfos` property enables users to initialize the Version Management component with a predefined set of versions.\nBy providing an array of `InitialVersionInfo`, the component displays a specified version for each feature service upon initialization.",
|
|
16473
16503
|
"type": "Array<{\n url: string;\n name: string;\n}>"
|
|
16474
16504
|
},
|
|
16475
16505
|
{
|
|
@@ -16478,7 +16508,7 @@
|
|
|
16478
16508
|
},
|
|
16479
16509
|
{
|
|
16480
16510
|
"name": "messageOverrides",
|
|
16481
|
-
"description": "Replace localized message strings with your own strings
|
|
16511
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
16482
16512
|
"type": "Record<string, unknown>"
|
|
16483
16513
|
},
|
|
16484
16514
|
{
|
|
@@ -16487,7 +16517,7 @@
|
|
|
16487
16517
|
},
|
|
16488
16518
|
{
|
|
16489
16519
|
"name": "pageSize",
|
|
16490
|
-
"description": "Specifies the number of versions displayed on each page of the Version Management
|
|
16520
|
+
"description": "Specifies the number of versions displayed on each page of the Version Management component.",
|
|
16491
16521
|
"type": "number"
|
|
16492
16522
|
},
|
|
16493
16523
|
{
|
|
@@ -16505,7 +16535,7 @@
|
|
|
16505
16535
|
},
|
|
16506
16536
|
{
|
|
16507
16537
|
"name": "versioningStates",
|
|
16508
|
-
"description": "This class provides functionality for managing versions in a versioned geodatabase.\nIn the event that the Version Management component is destroyed, the VersioningStates can be utilized to maintain the current state of the Version Management
|
|
16538
|
+
"description": "This class provides functionality for managing versions in a versioned geodatabase.\nIn the event that the Version Management component is destroyed, the VersioningStates can be utilized to maintain the current state of the Version Management component.\nThe Version Management component can be reinitialized using a `Collection<VersioningState>`, or a predefined `Collection<VersioningState>` can be provided during the initial instantiation of the Version Management component.",
|
|
16509
16539
|
"type": "Collection<VersioningState>"
|
|
16510
16540
|
}
|
|
16511
16541
|
],
|
|
@@ -16524,7 +16554,7 @@
|
|
|
16524
16554
|
},
|
|
16525
16555
|
{
|
|
16526
16556
|
"name": "arcgis-video",
|
|
16527
|
-
"description": "The ArcGIS Video component provides a view for displaying video feeds from a\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html).\nIt is designed to render and interact with video layers.\n\nA Video component must have a valid
|
|
16557
|
+
"description": "The ArcGIS Video component provides a view for displaying video feeds from a\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html).\nIt is designed to render and interact with video layers.\n\nA Video component must have a valid VideoLayer.\nIt supports various features such as navigating, zooming, and panning, making it suitable for\napplications that require interactive video overlays.\n--\n\n### Events\n- **arcgisViewReadyChange**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.",
|
|
16528
16558
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video/",
|
|
16529
16559
|
"attributes": [
|
|
16530
16560
|
{
|
|
@@ -16533,12 +16563,6 @@
|
|
|
16533
16563
|
"value": {
|
|
16534
16564
|
"type": "boolean"
|
|
16535
16565
|
}
|
|
16536
|
-
},
|
|
16537
|
-
{
|
|
16538
|
-
"name": "layer-url",
|
|
16539
|
-
"value": {
|
|
16540
|
-
"type": "string"
|
|
16541
|
-
}
|
|
16542
16566
|
}
|
|
16543
16567
|
],
|
|
16544
16568
|
"events": [
|
|
@@ -16558,10 +16582,6 @@
|
|
|
16558
16582
|
"description": "The [VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html) to display in the view.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-VideoView.html#layer)",
|
|
16559
16583
|
"type": "VideoLayer"
|
|
16560
16584
|
},
|
|
16561
|
-
{
|
|
16562
|
-
"name": "layerUrl",
|
|
16563
|
-
"type": "string"
|
|
16564
|
-
},
|
|
16565
16585
|
{
|
|
16566
16586
|
"name": "ready",
|
|
16567
16587
|
"description": "When `true`, this property indicates whether the view successfully satisfied all dependencies,\nsignaling that the following conditions are met.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-VideoView.html#ready)",
|
|
@@ -16583,7 +16603,7 @@
|
|
|
16583
16603
|
},
|
|
16584
16604
|
{
|
|
16585
16605
|
"name": "arcgis-video-player",
|
|
16586
|
-
"description": "The Video Player component provides a user interface for interacting with a [VideoLayer](api-reference/esri-layers-VideoLayer.html).\nIt displays the original video content and provides controls for playing, pausing, seeking, and changing the video speed and quality.\n\nThe Video Player component provides the following capabilities:\n - Control operations (play, pause, seek)\n - Time and duration display\n - Customizable graphics colors\n - Following options (sensor, frame, video)\n - Adjustable speed and quality\n - Access to frame metadata\n\nThe [VideoPlayerViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VideoPlayer-VideoPlayerViewModel.html) class provides the logic for the Video Player.\n\n**Known
|
|
16606
|
+
"description": "The Video Player component provides a user interface for interacting with a [VideoLayer](api-reference/esri-layers-VideoLayer.html).\nIt displays the original video content and provides controls for playing, pausing, seeking, and changing the video speed and quality.\n\nThe Video Player component provides the following capabilities:\n - Control operations (play, pause, seek)\n - Time and duration display\n - Customizable graphics colors\n - Following options (sensor, frame, video)\n - Adjustable speed and quality\n - Access to frame metadata\n\nThe [VideoPlayerViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VideoPlayer-VideoPlayerViewModel.html) class provides the logic for the Video Player.\n\n**Known limitations**\n\n* Not supported in 3D [Scenes](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n* Not supported on macOS and iOS devices.\n\n[](https://mediaspace.esri.com/media/1_ctc3psfr)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisVideoReady**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
16587
16607
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video-player/",
|
|
16588
16608
|
"attributes": [
|
|
16589
16609
|
{
|
|
@@ -16594,6 +16614,19 @@
|
|
|
16594
16614
|
"type": "boolean"
|
|
16595
16615
|
}
|
|
16596
16616
|
},
|
|
16617
|
+
{
|
|
16618
|
+
"name": "following-mode",
|
|
16619
|
+
"description": "Determines which telemetry elements to follow when the video layer is playing.",
|
|
16620
|
+
"default": "\"follow-both\"",
|
|
16621
|
+
"value": {
|
|
16622
|
+
"type": [
|
|
16623
|
+
"\"follow-both\"",
|
|
16624
|
+
"\"follow-frame\"",
|
|
16625
|
+
"\"follow-sensor\"",
|
|
16626
|
+
"\"none\""
|
|
16627
|
+
]
|
|
16628
|
+
}
|
|
16629
|
+
},
|
|
16597
16630
|
{
|
|
16598
16631
|
"name": "hide-header",
|
|
16599
16632
|
"description": "Indicates whether to display the video player's header information.",
|
|
@@ -16680,6 +16713,11 @@
|
|
|
16680
16713
|
"description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video-player/#destroy) method when you are done to\nprevent memory leaks.",
|
|
16681
16714
|
"type": "boolean"
|
|
16682
16715
|
},
|
|
16716
|
+
{
|
|
16717
|
+
"name": "followingMode",
|
|
16718
|
+
"description": "Determines which telemetry elements to follow when the video layer is playing.",
|
|
16719
|
+
"type": "\"follow-both\" | \"follow-frame\" | \"follow-sensor\" | \"none\""
|
|
16720
|
+
},
|
|
16683
16721
|
{
|
|
16684
16722
|
"name": "hideHeader",
|
|
16685
16723
|
"description": "Indicates whether to display the video player's header information.",
|
|
@@ -16702,7 +16740,7 @@
|
|
|
16702
16740
|
},
|
|
16703
16741
|
{
|
|
16704
16742
|
"name": "messageOverrides",
|
|
16705
|
-
"description": "Replace localized message strings with your own strings
|
|
16743
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
16706
16744
|
"type": "Record<string, unknown>"
|
|
16707
16745
|
},
|
|
16708
16746
|
{
|
|
@@ -16865,7 +16903,7 @@
|
|
|
16865
16903
|
},
|
|
16866
16904
|
{
|
|
16867
16905
|
"name": "messageOverrides",
|
|
16868
|
-
"description": "Replace localized message strings with your own strings
|
|
16906
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
16869
16907
|
"type": "Record<string, unknown>"
|
|
16870
16908
|
},
|
|
16871
16909
|
{
|
|
@@ -17006,7 +17044,7 @@
|
|
|
17006
17044
|
},
|
|
17007
17045
|
{
|
|
17008
17046
|
"name": "messageOverrides",
|
|
17009
|
-
"description": "Replace localized message strings with your own strings
|
|
17047
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
17010
17048
|
"type": "Record<string, unknown>"
|
|
17011
17049
|
},
|
|
17012
17050
|
{
|