@react-gis/openlayerscontrol
rotate-control
Functions
RotateControl()
function RotateControl(props: RotateControlProps): null;Defined in: packages/openlayers/src/control/rotate-control.tsx:11
Parameters
| Parameter | Type |
|---|---|
props | RotateControlProps |
Returns
null
Interfaces
RotateControlProps
Defined in: packages/openlayers/src/control/rotate-control.tsx:9
Extends
ControlOptions<OlRotateOptions>
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
autoHide? | boolean | Hide the control when rotation is 0. | ControlOptions.autoHide |
className? | string | CSS class name. | ControlOptions.className |
compassClassName? | string | CSS class name for the compass. | ControlOptions.compassClassName |
duration? | number | Animation duration in milliseconds. | ControlOptions.duration |
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 rotate button. Instead of text, also an element (e.g. a span element) can be used. | ControlOptions.label |
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 |
resetNorth? | () => void | Function called when the control is clicked. This will override the default resetNorth. | ControlOptions.resetNorth |
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 rotate tip. | ControlOptions.tipLabel |