types.ui.editor.IServiceEditPage - ZeMA-gGmbH/NoPE-JS GitHub Wiki

Interface: IServiceEditPage<T>

ui.editor.IServiceEditPage

Type which is used to render an custom html code. Must return a function, which will be called if the panel is destroyed.

Result, that must be provided by the Render Function.

Type parameters

Name Type
T any

Hierarchy

Properties

getDescriptionText

Optional getDescriptionText: () => Promise<string>

Type declaration

(): Promise<string>

Function used to Descripe the configured Settings in a short sentence.

Returns

Promise<string>


onDestroy

Optional onDestroy: () => Promise<boolean>

Type declaration

(): Promise<boolean>

Callback, which is called on destroyed

Returns

Promise<boolean>

Inherited from

TRenderFunctionResult.onDestroy


onHide

Optional onHide: () => Promise<boolean>

Type declaration

(): Promise<boolean>

Callback, which is called, if the panel is hide

Returns

Promise<boolean>

Inherited from

TRenderFunctionResult.onHide


onShow

Optional onShow: () => Promise<void>

Type declaration

(): Promise<void>

Callback, which is calle, if the Element is rendered.

Returns

Promise<void>

Inherited from

TRenderFunctionResult.onShow


type

type: "node" | "edge"

Element showing the type of the edit panel.

Methods

getData

getData(): Promise<T>

Function, which must return the current service-data.

Author

M.Karkowski

Memberof

IEditPage

Returns

Promise<T>


isValid

isValid(): Promise<boolean>

Function which must return true, if the Entered- Data is valid. Otherwise the Update will be refused

Author

M.Karkowski

Memberof

IEditPage

Returns

Promise<boolean>

⚠️ **GitHub.com Fallback** ⚠️