IWithEditorBehavior

Interface

Functions that are used by the arcgis-hub-entity-editor component

Methods

Method Returns Notes
Promise<HubEntity>

Update the internal Entity from the "Editor" structure. This should only be used by the arcgis-hub-entity-editor component. For general use, see the update(Partial<T>) method

Promise<IEditorConfig>

Get the Entity's ui and schema for the editor

Promise<HubEntityEditor>

Convert the entity into it's "Editor" structure. This should only be used by the arcgis-hub-entity-editor component. For general use, see the toJson():<T> method

fromEditor

Interface Method

Update the internal Entity from the "Editor" structure. This should only be used by the arcgis-hub-entity-editor component. For general use, see the update(Partial<T>) method

Parameters

Parameter Type Default Notes
editor Required HubEntityEditor
editorContext Optional IEntityEditorContext

Returns

Promise<HubEntity>

getEditorConfig

Interface Method

Get the Entity's ui and schema for the editor

Parameters

Parameter Type Default Notes
i18nScope Required string
type Required EditorType

Returns

Promise<IEditorConfig>

toEditor

Interface Method

Convert the entity into it's "Editor" structure. This should only be used by the arcgis-hub-entity-editor component. For general use, see the toJson():<T> method

Parameters

Parameter Type Default Notes
editorContext Required IEntityEditorContext
include Optional string[]

Returns

Promise<HubEntityEditor>

Interface defined in common/src/core/behaviors/IWithEditorBehavior.ts:7