On this page
Interface MinimapOptionsInput
interface MinimapOptionsInput {
containerStyle?: Record<string, string>;
lockZoom?: number;
parentRect?: ParentRect;
pitchAdjust?: boolean;
position?: ControlPosition;
style?: string | StyleSpecification | ReferenceMapStyle | MapStyleVariant;
zoomAdjust?: number;
}
containerStyle?: Record<string, string>;
lockZoom?: number;
parentRect?: ParentRect;
pitchAdjust?: boolean;
position?: ControlPosition;
style?: string | StyleSpecification | ReferenceMapStyle | MapStyleVariant;
zoomAdjust?: number;
}
Index
Properties
OptionalcontainerStyle
OptionallockZoom
lockZoom?: number
Set a zoom of the minimap and don't allow any future changes
OptionalparentRect
Set the parentRect fill and/or line options
OptionalpitchAdjust
pitchAdjust?: boolean
Adjust the pitch only if the user requests
Optionalposition
Set the position of the minimap at either "top-left", "top-right", "bottom-left", or "bottom-right"
Optionalstyle
Style of the map. Can be:
- a full style URL (possibly with API key)
- a shorthand with only the MapTIler style name (eg.
"streets-v2") - a longer form with the prefix
"maptiler://"(eg."maptiler://streets-v2")
OptionalzoomAdjust
zoomAdjust?: number
Set the zoom difference between the parent and the minimap If the parent is zoomed to 10 and the minimap is zoomed to 8, the zoomAdjust should be 2 Default: -4
Was this helpful?
Set CSS properties of the container using object key-values