Skip to content

Commit

Permalink
Update plugin docs
Browse files Browse the repository at this point in the history
  • Loading branch information
manisandro committed Feb 10, 2025
1 parent 4a54bd6 commit 5edf673
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion doc/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Plugin reference
* [ThemeSwitcher](#themeswitcher)
* [TimeManager](#timemanager)
* [TopBar](#topbar)
* [View3D](#view3d)
* [ZoomButton](#zoombutton)
* [EditingSupport](#editingsupport)
* [LocateSupport](#locatesupport)
Expand Down Expand Up @@ -847,10 +848,20 @@ Top bar, containing the logo, searchbar, task buttons and app menu.
| logoSrc | `string` | The logo image URL if a different source than the default assets/img/logo.<ext> and assets/img/logo-mobile.<ext> is desired. | `undefined` |
| logoUrl | `string` | The hyperlink to open when the logo is clicked. | `undefined` |
| menuItems | `array` | The menu items. Refer to the corresponding chapter of the viewer documentation and the sample config.json. | `[]` |
| searchOptions | `{`<br />`  allowSearchFilters: bool,`<br />`  hideResultLabels: bool,`<br />`  highlightStyle: {`<br />`  strokeColor: array,`<br />`  strokeWidth: number,`<br />`  strokeDash: array,`<br />`  fillColor: array,`<br />`},`<br />`  minScaleDenom: number,`<br />`  resultLimit: number,`<br />`  sectionsDefaultCollapsed: bool,`<br />`  showLayerAfterChangeTheme: bool,`<br />`  showLayerResultsBeforePlaces: bool,`<br />`  showProviderSelection: bool,`<br />`  showProvidersInPlaceholder: bool,`<br />`  showResultInSearchText: bool,`<br />`  providerSelectionAllowAll: bool,`<br />`  zoomToLayers: bool,`<br />`}` | Options passed down to the search component. | `{`<br />`  showResultInSearchText: true`<br />`}` |
| searchOptions | `{`<br />`  allowSearchFilters: bool,`<br />`  hideResultLabels: bool,`<br />`  highlightStyle: {`<br />`  strokeColor: array,`<br />`  strokeWidth: number,`<br />`  strokeDash: array,`<br />`  fillColor: array,`<br />`},`<br />`  minScaleDenom: number,`<br />`  resultLimit: number,`<br />`  sectionsDefaultCollapsed: bool,`<br />`  showLayerAfterChangeTheme: bool,`<br />`  showLayerResultsBeforePlaces: bool,`<br />`  showResultInSearchText: bool,`<br />`  zoomToLayers: bool,`<br />`}` | Options passed down to the search component. | `{`<br />`  showResultInSearchText: true`<br />`}` |
| toolbarItems | `array` | The toolbar. Refer to the corresponding chapter of the viewer documentation and the sample config.json. | `[]` |
| toolbarItemsShortcutPrefix | `string` | The keyboard shortcut prefix for triggering toolbar tasks. I.e. alt+shift. The task are then triggered by <prefix>+{1,2,3,...} for the 1st, 2nd, 3rd... toolbar icon. | `undefined` |

View3D<a name="view3d"></a>
----------------------------------------------------------------
Displays a 3D map view.

| Property | Type | Description | Default value |
|----------|------|-------------|---------------|
| buttonPosition | `number` | The position slot index of the 3d switch map button, from the bottom (0: bottom slot). | `6` |
| geometry | `{`<br />`  initialWidth: number,`<br />`  initialHeight: number,`<br />`  initialX: number,`<br />`  initialY: number,`<br />`  initiallyDocked: bool,`<br />`}` | Default window geometry. | `{`<br />`  initialWidth: 600,`<br />`  initialHeight: 800,`<br />`  initialX: 0,`<br />`  initialY: 0,`<br />`  initiallyDocked: true`<br />`}` |
| options | `{`<br />`  searchMinScaleDenom: number,`<br />`}` | Various configuration options | `{`<br />`  searchMinScaleDenom: 1000`<br />`}` |

ZoomButton<a name="zoombutton"></a>
----------------------------------------------------------------
Map button for zooming the map.
Expand Down

0 comments on commit 5edf673

Please sign in to comment.