Interface IDraggersRegistry

Defines the viewer draggers registry interface.

interface IDraggersRegistry {
    createDragger(name: string, viewer: IViewer): IDragger;
    getDragger(name: string): IDraggerProvider;
    getDraggers(): IDraggersMap;
    registerDragger(name: string, provider: IDraggerProvider): void;
    registerDraggerAlias(name: string, alias: string): void;
}

Index

Methods

createDragger getDragger getDraggers registerDragger registerDraggerAlias

Methods

createDragger

createDragger(name: string, viewer: IViewer): IDragger
Creates the dragger denoted by the given name. Returns null if a dragger with given name not registered.
Parameters
- name: string
  Dragger name.
- viewer: IViewer
  Viewer instance that wants to create the dragger.
Returns IDragger

getDragger

getDragger(name: string): IDraggerProvider
Returns the specified dragger provider or undefined when the dragger doesn't exists.
Parameters
- name: string
  Dragger name.
Returns IDraggerProvider

getDraggers

getDraggers(): IDraggersMap
Returns a list of registered draggers.

Returns IDraggersMap

registerDragger

registerDragger(name: string, provider: IDraggerProvider): void
Binds a dragger name to a dragger provider. Registering a dragger with an existing name twice overrides the existing dragger.
Parameters
- name: string
  Unique name for the dragger.
- provider: IDraggerProvider
  Dragger provider.
Returns void

registerDraggerAlias

registerDraggerAlias(name: string, alias: string): void
Registers an alias for a dragger.
Parameters
- name: string
  Unique name for the dragger.
- alias: string
  Dragger alias string.
Returns void