Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • MarkerOptions

Index

Constructors

constructor

Properties

Optional iconAnchor

iconAnchor: "center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right"

Optional iconName

iconName: undefined | string

Optional iconScale

iconScale: undefined | number

objectClass

objectClass: string = "MarkerOptions"

Optional title

title: undefined | string

Optional titleAnchor

titleAnchor: "center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right"

Optional titleColor

titleColor: undefined | string

Optional titleFontSize

titleFontSize: undefined | number

Optional titleOffset

titleOffset: number[]

This can offset the title from the center. An array of two Float values : Positive values indicate right and down, while negative values indicate left and up

Methods

setIconAnchor

  • setIconAnchor(iconAnchor: "center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right"): MarkerOptions
  • Sets the part of the icon to be placed closest to the anchor.

    Parameters

    • iconAnchor: "center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right"

    Returns MarkerOptions

setIconName

setIconScale

  • Sets the scale factor of the the icon and the original size.

    Parameters

    • iconScale: number

      eg. "0.5"

    Returns MarkerOptions

setTitle

setTitleAnchor

  • setTitleAnchor(titleAnchor: "center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right"): MarkerOptions
  • Sets the part of the text to be placed closest to the anchor.

    Parameters

    • titleAnchor: "center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right"

    Returns MarkerOptions

setTitleColor

setTitleFontSize

setTitleOffset

  • This can offset the title from the center.

    Parameters

    • titleOffset: number[]

      An array of two number values : Positive values indicate right and down, while negative values indicate left and up

    Returns MarkerOptions

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Inherited property

Generated using TypeDoc