Skip to content

Documentation / @geoverse/core-ol / OverviewOptions

Interface: OverviewOptions

Defined in: packages/core-ol/src/controls/overview.ts:10

Extends

  • Options

Properties

className?

ts
optional className?: string;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/OverviewMap.d.ts:6

CSS class name.

Inherited from

ts
Options.className

collapsed?

ts
optional collapsed?: boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/OverviewMap.d.ts:10

Whether the control should start collapsed or not (expanded).

Inherited from

ts
Options.collapsed

collapseLabel?

ts
optional collapseLabel?: string | HTMLElement;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/OverviewMap.d.ts:15

Text label to use for the expanded overviewmap button. Instead of text, also an element (e.g. a span element) can be used.

Inherited from

ts
Options.collapseLabel

collapsible?

ts
optional collapsible?: boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/OverviewMap.d.ts:19

Whether the control can be collapsed or not.

Inherited from

ts
Options.collapsible

label?

ts
optional label?: string | HTMLElement;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/OverviewMap.d.ts:24

Text label to use for the collapsed overviewmap button. Instead of text, also an element (e.g. a span element) can be used.

Inherited from

ts
Options.label

layers?

ts
optional layers?: 
  | BaseLayer<{
[x: string]: any;
}>[]
  | Collection<BaseLayer<{
[x: string]: any;
}>>;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/OverviewMap.d.ts:28

Layers for the overview map.

Inherited from

ts
Options.layers

map?

ts
optional map?: Map;

Defined in: packages/core-ol/src/controls/overview.ts:12

主地图(用于复制底图到鹰眼)


onlyBase?

ts
optional onlyBase?: boolean;

Defined in: packages/core-ol/src/controls/overview.ts:14

仅显示底图图层,默认 true


render?

ts
optional render?: (arg0) => void;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/OverviewMap.d.ts:37

Function called when the control should be re-rendered. This is called in a requestAnimationFrame callback.

Parameters

arg0

MapEvent

Returns

void

Inherited from

ts
Options.render

rotateWithView?

ts
optional rotateWithView?: boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/OverviewMap.d.ts:41

Whether the control view should rotate with the main map view.

Inherited from

ts
Options.rotateWithView

show?

ts
optional show?: boolean;

Defined in: packages/core-ol/src/controls/overview.ts:16

初始是否展开,默认 false


target?

ts
optional target?: string | HTMLElement;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/OverviewMap.d.ts:46

Specify a target if you want the control to be rendered outside of the map's viewport.

Inherited from

ts
Options.target

tipLabel?

ts
optional tipLabel?: string;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/OverviewMap.d.ts:50

Text label to use for the button tip.

Inherited from

ts
Options.tipLabel

view?

ts
optional view?: View;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/control/OverviewMap.d.ts:55

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.

Inherited from

ts
Options.view