@react-gis/openlayerscontrol
attribution-control
Functions
AttributionControl()
function AttributionControl(props: AttributionControlProps): null;Defined in: packages/openlayers/src/control/attribution-control.tsx:11
Parameters
| Parameter | Type |
|---|---|
props | AttributionControlProps |
Returns
null
Interfaces
AttributionControlProps
Defined in: packages/openlayers/src/control/attribution-control.tsx:9
Extends
ControlOptions<AttributionControlOptions>
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
attributions? | string | string[] | Optional attribution(s) that will always be displayed regardless of the layers rendered. Caution: Attributions are rendered dynamically using innerHTML, which can lead to potential XSS (Cross-Site Scripting) vulnerabilities. Use this feature only for trusted content or ensure that the content is properly sanitized before inserting it. | ControlOptions.attributions |
className? | string | CSS class name. | ControlOptions.className |
collapseClassName? | string | CSS class name for the expanded attributions button. | ControlOptions.collapseClassName |
collapsed? | boolean | Specify if attributions should be collapsed at startup. | ControlOptions.collapsed |
collapseLabel? | string | HTMLElement | Text label to use for the expanded attributions button. Instead of text, also an element (e.g. a span element) can be used. | ControlOptions.collapseLabel |
collapsible? | boolean | Specify if attributions can be collapsed. If not specified, sources control this behavior with their attributionsCollapsible setting. | 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 |
expandClassName? | string | CSS class name for the collapsed attributions button. | ControlOptions.expandClassName |
label? | string | HTMLElement | Text label to use for the collapsed attributions 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 |
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 |