Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ExtensionSetting

The Extension source

Hierarchy

  • ExtensionSetting

Index

Properties

Properties

Optional configCommand

configCommand?: string

Project extension settings command

Optional description

description?: string

Short description about the extension

Optional enabled

enabled?: boolean

Whether the Extension is enabled

Optional extensionType

extensionType?: ExtensionType[]

Declares where the extension runs in Trimble Connect.

Required for all extension manifests — omitting this field may cause the extension to fail installation or load in Trimble Connect.

Uses the ExtensionType enum. Accepted values:

May be a single value or an array, for example ["project"], ["3dviewer"], or ["project", "3dviewer"].

For dual-scope extensions (["project", "3dviewer"]), use ExtensionAPI.getHost at runtime to detect whether the extension is hosted in the project UI or the 3D Viewer.

Optional height

height?: string

applicable for "properties" type extension in 3dviewer

Optional icon

icon?: string

The icon URL of the Extension

Optional infoUrl

infoUrl?: string

The URL of the info page

Optional manifestUrl

manifestUrl?: string

The URL of the Extension manifest

title

title: string

The title of the Extension

Optional type

type?: PlacementType

The placement type of the Extension

url

url: string

The URL of the Extension