Class: MeasureExtension
Class: MeasureExtension
Extension for measuring distances and projections.
Hierarchy
↳
MeasureExtension
Constructors
constructor
• new MeasureExtension(viewerName): MeasureExtension
Parameters
| Name | Type | Description |
|---|---|---|
viewerName | string | Owner viewer name. |
Returns
Overrides
Properties
getName
• getName: () => string
Get unique extension name.
Type declaration
▸ (): string
Get unique extension name.
Returns
string
Inherited from
helpDesc
• Readonly helpDesc: string
Optional description for placing on HelpToolbar.
Inherited from
helpIcon
• Readonly helpIcon: string
Optional icon for placing on HelpToolbar.
Inherited from
hideToolbar
• hideToolbar: boolean
Is extension need to hide toolbar or not.
Inherited from
isActive
• isActive: boolean
Whether the measurement command is active or not.
state
• state: any
Any extension data which can be stored in browser local storage and restored after (any extension settings, buttons state and so one). State will be saved in local storage with 'tangl-ext-extensionName' key.
Inherited from
type
• Readonly type: string
Extension type (ext, mode, control).
Inherited from
viewerName
• Readonly viewerName: string
Owner viewer name.
Inherited from
Methods
getRenderManager
▸ getRenderManager(): RenderManager
Get current RenderManager instance.
Returns
Inherited from
ExtensionBase.getRenderManager
restoreState
▸ restoreState(): void
Restore extension state from the local storage.
Returns
void
Inherited from
saveState
▸ saveState(): void
Save extension state in the local storage.
Returns
void
Inherited from
setRestoreStateHandler
▸ setRestoreStateHandler(handler): this
Sets external hook handler for restoring extension state in the local storage.
Parameters
| Name | Type | Description |
|---|---|---|
handler | Function | handler hook function. |
Returns
this
Inherited from
ExtensionBase.setRestoreStateHandler
setSaveStateHandler
▸ setSaveStateHandler(handler): this
Sets external hook handler for storing extension state in the local storage.
Parameters
| Name | Type | Description |
|---|---|---|
handler | Function | handler hook function. |
Returns
this
Inherited from
ExtensionBase.setSaveStateHandler
switchRulerMode
▸ switchRulerMode(): void
Enables or disables the measurement mode.
Returns
void
Hooks
dedicatedToolbarRender
▸ dedicatedToolbarRender(container): void
Render function for rendering dedicated toolbar content.
Parameters
| Name | Type | Description |
|---|---|---|
container | HTMLElement | Parent DOM container. |
Returns
void