Interface IModalToolContainer`Beta`

interface IModalToolContainer {
    currentTools: IModalTool[];
    selectedOptionId?: string;
    addTool(
        params: ModalToolCreationParameters,
        action?: RegisteredAction<NoArgsAction>,
    ): IModalTool;
    dispose(): void;
    hide(): void;
    removeTool(id: string): void;
    setSelectedOptionId(value: string, update?: boolean): void;
    show(): void;
}

Index

Properties

currentTools selectedOptionId?

Methods

addTool dispose hide removeTool setSelectedOptionId show

Properties

`Readonly` `Beta`currentTools

currentTools: IModalTool[]

Remarks

Tools within this container.

`Optional` `Readonly` `Beta`selectedOptionId

selectedOptionId?: string

Remarks

The id of the selected tool in container.

Methods

addTool

addTool(
params: ModalToolCreationParameters,
action?: RegisteredAction<NoArgsAction>,
): IModalTool
Beta
Parameters
- params: ModalToolCreationParameters
- Optionalaction: RegisteredAction<NoArgsAction>
Returns IModalTool

dispose

dispose(): void
Beta
Returns void

hide

hide(): void
Beta
Returns void

removeTool

removeTool(id: string): void
Beta
Parameters
- id: string
Returns void

setSelectedOptionId

setSelectedOptionId(value: string, update?: boolean): void
Beta
Parameters
- value: string
- Optionalupdate: boolean
Returns void

show

show(): void
Beta
Returns void