@react-gis/openlayerscontrol
overview-map-control
Functions
OverviewMapControl()
function OverviewMapControl(props: OverviewMapControlProps): null;Defined in: packages/openlayers/src/control/overview-map-control.tsx:11
Parameters
| Parameter | Type |
|---|---|
props | OverviewMapControlProps |
Returns
null
Interfaces
OverviewMapControlProps
Defined in: packages/openlayers/src/control/overview-map-control.tsx:9
Extends
ControlOptions<OlOverviewMapOptions>
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
className? | string | CSS class name. | ControlOptions.className |
collapsed? | boolean | Whether the control should start collapsed or not (expanded). | ControlOptions.collapsed |
collapseLabel? | string | HTMLElement | Text label to use for the expanded overviewmap button. Instead of text, also an element (e.g. a span element) can be used. | ControlOptions.collapseLabel |
collapsible? | boolean | Whether the control can be collapsed or not. | ControlOptions.collapsible |
element? | HTMLElement | The element is the control's container element. This only needs to be specified if you're developing a custom control. | ControlOptions.element |
label? | string | HTMLElement | Text label to use for the collapsed overviewmap button. Instead of text, also an element (e.g. a span element) can be used. | ControlOptions.label |
layers? | BaseLayer[] | Collection<BaseLayer> | Layers for the overview map. | ControlOptions.layers |
render? | (arg0: MapEvent) => void & (arg0: MapEvent) => void | Function called when the control should be re-rendered. This is called in a requestAnimationFrame callback. | FullScreenControlProps.render |
rotateWithView? | boolean | Whether the control view should rotate with the main map view. | ControlOptions.rotateWithView |
target? | string | HTMLElement | Specify a target if you want the control to be rendered outside of the map's viewport. | ControlOptions.target |
tipLabel? | string | Text label to use for the button tip. | ControlOptions.tipLabel |
view? | View | Custom view for the overview map (should use same projection as main map). If not provided, a default view with the same projection as the main map will be used. | ControlOptions.view |