Last updated

API / geotoolkit / plot / IToolContainer / IToolContainer

Class: IToolContainer

plot.IToolContainer.IToolContainer

Define an interface that implement plot tool container

Interface

Hierarchy

Implemented by

Table of contents

Constructors
Methods

Contents

Constructors

new IToolContainer()

new IToolContainer()

Inherited from

IDisposable.constructor

Methods

add

Abstract add(tool): IToolContainer

Add tool

Parameters

Name Type Description
toolITool | ITool[]tool to add

Returns

IToolContainer


dispose

Abstract dispose(): void

Dispose

Returns

void

Inherited from

IDisposable.dispose


getToolByName

Abstract getToolByName(node): ITool

Returns tool by name

Parameters

Name Type Description
nodestringnode to check

Returns

ITool

plot tool


getToolByType

Abstract getToolByType(toolType): ITool

Returns the tool matching the given type. or null if nothing is matching the tool type

Parameters

Name Type Description
toolTypeClassType<any>toolType of the tool

Returns

ITool


listToolsNames

Abstract listToolsNames(): string[]

List all the tools contained in this composite. Prepend their parent tools parent using a '.'.

Returns

string[]


remove

Abstract remove(tool): IToolContainer

Remove tool

Parameters

Name Type Description
toolITooltool to remove

Returns

IToolContainer