full-screen-control

Functions

FullScreenControl()

function FullScreenControl(props: FullScreenControlProps): null;

Defined in: packages/openlayers/src/control/full-screen-control.tsx:11

Parameters

Parameter	Type
`props`	`FullScreenControlProps`

Returns

null

Interfaces

FullScreenControlProps

Defined in: packages/openlayers/src/control/full-screen-control.tsx:9

Extends

ControlOptions<OlFullScreenOptions>

Properties

Property	Type	Description	Inherited from
`activeClassName?`	`string`	CSS class name for the button when full-screen is active.	`ControlOptions.activeClassName`
`className?`	`string`	CSS class name.	`ControlOptions.className`
`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`
`inactiveClassName?`	`string`	CSS class name for the button when full-screen is inactive.	`ControlOptions.inactiveClassName`
`keys?`	`boolean`	Full keyboard access.	`ControlOptions.keys`
`label?`	`string` \| `HTMLElement` \| `Text`	Text label to use for the button. Instead of text, also an element (e.g. a `span` element) can be used.	`ControlOptions.label`
`labelActive?`	`string` \| `HTMLElement` \| `Text`	Text label to use for the button when full-screen is active. Instead of text, also an element (e.g. a `span` element) can be used.	`ControlOptions.labelActive`
`render?`	(`arg0`: `MapEvent`) => `void`	Function called when the control should be re-rendered. This is called in a `requestAnimationFrame` callback.	`ControlOptions.render`
`source?`	`string` \| `HTMLElement`	The element to be displayed fullscreen. When not provided, the element containing the map viewport will be displayed fullscreen.	`ControlOptions.source`
`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`

full-screen-control

On this page