/v2/map_script - v1.32.1

Type declaration

• Optional fadeIn?: undefined | false | true

  タイル表示時のフェードイン有効フラグ

  default

  true

• Optional hideAnnotation?: undefined | false | true

  注記レイヤー非表示フラグ

  default

  false

• Optional hideDefaultMapTile?: undefined | false | true

  通常地図タイル非表示フラグ ※ 未指定の場合、transparencyが1ならtrue、1未満ならfalseとみなす ※ 任意タイルレイヤー内で1枚でもtrueのレイヤーがあれば、通常地図タイルは非表示となる

• Optional priority?: undefined | number

  レイヤー描画優先度

  default

  0

• Optional transparency?: undefined | number

  レイヤー不透明度(0以上1以下)

  default

  1

• zoomRange: ZoomRange

  表示ズームレベル範囲

Type declaration

• serverInfoList: {}

  サーバ情報

  • [key: string]: AdditionTileServerInfo

    key: 任意キー名 value: サーバ情報

Type declaration

• Optional copyright?: LangCopyright

  コピーライト文字列リスト

• Optional queryParam?: ParameterKeyValue

  リクエストに付加するクエリパラメータ key: プロパティ名 value: プロパティ値

• requestUrl: string

  タイル画像リクエストURL ※ タイル番号にあたる部分を{X}, {Y}, {Z}とした文字列を設定する e.g. https://www.example.com/tile/{Z}/{X}/{Y}.png

Type declaration

• • (data: AnnotationData): void

  • Parameters

    • data: AnnotationData

    Returns void

Type declaration

• Optional isIconClickable?: undefined | false | true

  アイコンクリックを有効にする

  default

  true

• Optional isNodeOnly?: undefined | { icon: boolean; text: boolean }

  クリック対象をノードIDがあるもののみに絞るか
  ※ isIconClickable および isTextClickable の値を優先

  default

  false

• Optional isTextClickable?: undefined | false | true

  テキストクリックを有効にする

  default

  true

• Optional once?: undefined | false | true

  イベントリスナーの適用を1度だけにするか

Type declaration

• Optional appearance?: undefined | string

  名称

• latlng: LatLng

  緯度経度

• Optional nodeId?: undefined | string

  乗換検索用ノードID

• type: AnnotationType

  タイプ

Type declaration

• mode: "swap"

• swapOptions: { swapInterval: number }

  • swapInterval: number

Type declaration

• sansSerif: FontFamily[]

• sansSerifBold: FontFamily[]

• serif: FontFamily[]

• serifBold: FontFamily[]

Type declaration

• Optional recordMax?: undefined | number

  レコード数上限

  default

  3000

• Optional useIndexedDB?: undefined | false | true

  indexedDB利用フラグ

  default

  true

Type declaration

• Optional display?: AnnotationDisplayOptions

  Webフォントのfont-displayの指定

• Optional fontFamily?: AnnotationFontFamilyMap

  Webフォントのフォントファミリーの設定

• Optional textBorder?: undefined | number

  縁取り有り文字注記の縁取りの太さ（単位はピクセル）

Type declaration

• Optional color?: Color

  色、デフォルトは赤

• Optional length?: undefined | number

  線の長さ、デフォルトは10px

• Optional width?: undefined | number

  線の太さ、デフォルトは2px

Type declaration

• center: LatLng

  円の中心緯度経度

• Optional fillColor?: Color

  円の内側を塗りつぶす色

  default

  #000000

• radius: number

  円の半径（単位はメートル）

• Optional strokeColor?: Color

  円の縁線の色

  default

  #000000

• Optional strokeDashArray?: number[]

  点線のパターンを塗りと休みで交互に指定する（単位はピクセル、デフォルトは実線）

• Optional strokeWeight?: undefined | number

  円の縁線の太さ(px)

  default

  1

• Optional visible?: undefined | false | true

  表示設定

  default

  true

• Optional zIndex?: undefined | number

  重なり順（大きければ大きいほど手前に表示される、デフォルト値は一番手前）

Type declaration

• native: MouseEvent

  元のマウスイベント

• position: LatLng

  その地点の緯度経度

Type declaration

• onselect: (e: ContextMenuEvent) => void

  メニュークリック時の処理

  • • (e: ContextMenuEvent): void

    • Parameters

      • e: ContextMenuEvent

      Returns void

• text: string

  表示するテキスト

Type declaration

• hideWhenZoomChange: boolean

  ズームレベルが切り替わったときにメニューを非表示にするかどうか

  default

  true

Type declaration

• Optional backgroundColor?: undefined | string

  背景色

• Optional offset?: Point

  規定位置(右下)からのずらし幅

• Optional textColor?: undefined | string

  文字色

Type declaration

• [zoom: number]: string[]

Type declaration

• Optional visible?: undefined | false | true

• Optional zIndex?: undefined | number

Type declaration

• Optional native?: UIEvent

  UIイベント

• sourceObject: GLMarker

  発火元インスタンス

Type declaration

• appear: GLMarkerEvent

  マーカーの表示

• click: GLMarkerEvent

  マーカーがクリックされたとき

• disappear: GLMarkerEvent

  マーカーの非表示

• dragend: GLMarkerEvent

  ドラッグ操作終了時

• dragging: GLMarkerEvent

  ドラッグ操作中

• mouseout: GLMarkerEvent

  マーカーからマウスポインタが降りたとき

• mouseover: GLMarkerEvent

  マーカーにマウスポインタが乗ったとき

• position_changed: GLMarkerEvent

  マーカーの緯度経度が変化したとき

Type declaration

• Optional gravity?: MarkerGravity

  基準位置

  default

  bottom

• icon: string

  画像パス(Base64文字列も可)

• Optional size?: Size

  表示サイズ

  default

  50px × 50px

Type declaration

• Optional draggable?: undefined | false | true

  ドラッグ操作可否

  default

  false

• info: GLMarkerIconInfo

  マーカー画像情報

• Optional isVisible?: undefined | false | true

  表示状態

  default

  true

• Optional label?: GLMarkerLabelOptions

  文字ラベル

• Optional name?: undefined | string

  マーカー名

• position: LatLng

  表示位置の緯度経度

• Optional zIndex?: undefined | number

  z-index（デフォルトは0）

Type declaration

• content: string

  ラベル文字列

• Optional offset?: Point

  オフセット

• Optional style?: GLMarkerLabelStyle

  ラベルのスタイル

Type declaration

• Optional align?: "left" | "center"

  ラベルの水平方向の位置

• Optional backgroundColor?: undefined | string

  背景色

• Optional borderColor?: undefined | string

  境界線の色

• Optional borderWidth?: undefined | number

  境界線の太さ

• Optional color?: undefined | string

  文字色

• Optional fontSize?: undefined | string

  文字サイズ

• Optional fontWeight?: undefined | string

  文字のウェイト

• Optional outline?: undefined | string

  文字の縁取りの色

• Optional padding?: undefined | number

  余白の上下左右一括指定 ※ top, bottom, left, right指定時はそちらを優先

• Optional paddingBottom?: undefined | number

  下側の余白幅

• Optional paddingLeft?: undefined | number

  左側の余白幅

• Optional paddingRight?: undefined | number

  右側の余白幅

• Optional paddingTop?: undefined | number

  上側の余白幅

Type declaration

• Optional once?: undefined | false | true

  イベントリスナーの適用を1度だけにするか

Type declaration

• arrowkeydown: ExtendedKeyboardEvent

• centermoved: MapLocationStatus

• click: ExtendedMouseEvent

• contextmenu: MouseEvent

• dblclick: MouseEvent

• doubletap: ExtendedTouchEvent

• drag: MouseEvent

• dragend: MouseEvent

• dragstart: MouseEvent

• flick: ExtendedTouchEvent

• inertia_mousemove: ExtendedMouseEvent

• keydown: KeyboardEvent

• keyup: KeyboardEvent

• mousedown: MouseEvent

• mouseenter: MouseEvent

• mouseleave: MouseEvent

• mousemove: MouseEvent

• mouseover: MouseEvent

• mouseup: MouseEvent

• pinch: ExtendedTouchEvent

• rotation: ExtendedTouchEvent

• singlescroll: ExtendedTouchEvent

• singletap: ExtendedTouchEvent

• singletap_2f: ExtendedTouchEvent

• tilt: ExtendedTouchEvent

• touchend: TouchEvent

• touchmove: TouchEvent

• touchstart: TouchEvent

• wheel: WheelEvent

• wheeldown: WheelEvent

• wheelleft: WheelEvent

• wheelright: WheelEvent

• wheelup: WheelEvent

• zoomchanged: MapLocationStatus

• zoomkeydown: ExtendedKeyboardEvent

Type declaration

• Optional coordUnit?: CoordUnit

  緯度経度の単位

  default

  degree

• Optional isRouteShape?: undefined | false | true

  mochaの/route/shapeから取得したGeoJSONか
  ※true: color, weight未設定時、properties値をもとに描画

  default

  false

• Optional polygon?: undefined | { color: Color }

  ポリゴンのオプション

• Optional polyline?: undefined | { inline?: undefined | { color?: Color; dashArray?: number[]; weight?: undefined | number }; outline?: undefined | { color?: Color; dashArray?: number[]; weight?: undefined | number } }

  ポリラインのオプション

• Optional showRouteArrow?: undefined | false | true

  ルート線描画時の矢印を表示するかどうか

  default

  false

• Optional zIndex?: undefined | number

  重なり順(大きいほど手前に表示)

  default

  最も手前

Type declaration

• Optional position?: LatLng

  イベントが発生した緯度経度

• sourceObject: GeoJsonFigureCondition

  発火元インスタンス

Type declaration

• click: GeoJsonFigureEvent

  GeoJSON形状がクリックされたとき

• mouseover: GeoJsonFigureEvent

  GeoJSON形状にマウスオーバーしたとき

Type declaration

• color: Color

  色

• dashArray: number[]

  点線のパターン

• weight: number

  太さ

Type declaration

• colorMap: Map<number, Color>

  色の指定

• geoJson: JsonObject

  GeoJSON

• Optional opacityCallback?: undefined | ((zoomLevel: number) => number)

  レイヤー全体の不透明度を返すコールバック関数、デフォルトは常に不透明（1.0）

• Optional radiusCallback?: undefined | ((weight: number) => number)

  スポットの円の半径（px）を返すコールバック、デフォルトは常に40px

• weightCallback: (feature: JsonObject) => number

  各スポットの重みを返すコールバック関数

  • • (feature: JsonObject): number

    • Parameters

      • feature: JsonObject

      Returns number

Type declaration

• Optional native?: UIEvent

  UIイベント

• sourceObject: InfoWindow

  発火元インスタンス

Type declaration

• click: InfoWindowEvent

  InfoWindowがクリックされたとき

• close: InfoWindowEvent

  InfoWindowのクローズ

• open: InfoWindowEvent

  InfoWindowのオープン

Type declaration

• Optional className?: undefined | string

  任意のクラス名設定

• content: string | HTMLElement

  表示要素(文字列 or HTML文字列 or DOM要素)

• Optional maxWidth?: number | string

  吹き出しの最大幅

• Optional name?: undefined | string

  識別用名称

• Optional offset?: Point

  表示位置のずらし幅

• position: LatLng

  表示位置の緯度経度

• Optional showClose?: undefined | false | true

  閉じるボタンの表示有無

  default

  true

• Optional tail?: InfoWindowTailPosition

  吹き出しの表示方向

  default

  bottom

• Optional visible?: undefined | false | true

  表示設定

  default

  true

• Optional zIndex?: undefined | number

  重なり順

Type declaration

• Optional maxZoomLevelMiniature?: undefined | number

  3Dランドマークをミニチュア表示する最大ズームレベル（デフォルトは16）

• Optional visibleZoomRange?: ZoomRange

  3Dランドマークを表示するズームレンジ（デフォルトは15~20）

Type declaration

Type declaration

• • (progress: number): void

  • Parameters

    • progress: number

    Returns void

Type declaration

• • (data: MapIconData): void

  • Parameters

    • data: MapIconData

    Returns void

Type declaration

• Optional isIconClickable?: undefined | false | true

  アイコンクリックを有効にする

  default

  true

• Optional once?: undefined | false | true

  イベントリスナーの適用を1度だけにするか

Type declaration

• Optional product?: undefined | string

  ライセンス照合に使うプロダクトID(デフォルトは"tile")

• tags: {}

  カテゴリタグとその見た目の設定

  • [tag: string]: MapIconConditionPaletteConfig[]

Type declaration

• Optional name?: undefined | string

  アイコン画像の名前（デフォルトは属性の16進数表記）

• Optional size?: undefined | number

  アイコンの大きさ（デフォルト値は100）

• zoomRange: ZoomRange

  表示するズームレベルの範囲

Type declaration

• Optional address?: undefined | string

  住所文字列

• latlng: LatLng

  緯度経度

• Optional name?: undefined | string

  スポットの名前

• Optional phone?: undefined | string

  電話番号の文字列

• Optional postalCode?: undefined | string

  郵便番号の文字列

• Optional providerId?: undefined | string

  提供者ID

• Optional spotId?: undefined | string

  スポットID

Type declaration

• • (data: MapIconData): void

  • Parameters

    • data: MapIconData

    Returns void

Type declaration

• Optional additionTileOptions?: AdditionTileOptions

  任意タイル地図オプション

• Optional annotationIndexedDB?: AnnotationIndexedDBOptions

  注記IndexedDBオプション

• Optional annotationOptions?: AnnotationOptions

  注記DBオプション

• Optional blankTileImage?: undefined | string

  ブランクタイル画像パス(Base64文字列も可)

• Optional centerOffset?: Point

  中心地点の基準位置オフセット

• Optional copyright?: CopyrightOptions

  コピーライト指定オプション

• Optional fogColor?: Color

  霧の色

  default

  白

• Optional isAnnotationEnabled?: undefined | false | true

  注記DB有効フラグ

  default

  true

• Optional language?: Language

  地図の言語

  default

  ja

• Optional mapIconOptions?: MapIconConditionInitOptions

  地図アイコンオプション

• Optional scale?: ScaleOptions

  縮尺表示オプション

• Optional skyColor?: Color

  空の色

  default

  シアン

• Optional tileBuilding3D?: undefined | false | true

  3Dビル表示フラグ

  default

  true

• Optional tileLoader?: TileLoaderOptions

  タイル画像取得の設定(v1.29.0以降は参照されなくなりました)

  deprecated

• Optional tileZoomLevelFix?: TileZoomLevelFixValue

  少数ズームレベルで上位・下位のどちらのタイルを描画するか

  default

  lower

• Optional viewRange?: LatLngRect

  地図を表示できる範囲

• Optional wheelZoomEnable?: undefined | false | true

  ホイール操作による拡縮の有効・無効指定

  default

  true

• Optional zoomRange?: ZoomRange

  ズームレンジ

Type declaration

• center: LatLng

  中心座標

• Optional options?: MapInitSettingOptions

  オプション

• target: string | HTMLElement

  地図表示をする要素

• zoomLevel: number

  ズームレベル(整数値)

Type declaration

• center: LatLng

  中心緯度経度

• heading: number

  回転角

• tilt: number

  傾き

• zoom: number

  現在のズームレベル

Type declaration

• Optional native?: UIEvent

  UIイベント

• sourceObject: Marker

  発火元インスタンス

Type declaration

• appear: MarkerEvent

  マーカーの表示

• click: MarkerEvent

  マーカーがクリックされたとき

• disappear: MarkerEvent

  マーカーの非表示

• position_changed: MarkerEvent

  マーカーの緯度経度が変化したとき

Type declaration

• Optional animation?: MarkerAnimationType

  アニメーション

• Optional className?: undefined | string

  カスタムクラス名

• Optional draggable?: undefined | false | true

  ドラッグ操作可否

  default

  false

• Optional gravity?: MarkerGravity

  マーカー基準位置

  default

  bottom

• icon: string

  アイコン画像パス (Base64文字列も可)

• Optional label?: MarkerLabelOptions

  文字ラベル

• Optional name?: undefined | string

  マーカー名

• Optional offset?: Point

  オフセット

• position: LatLng

  表示位置の緯度経度

• Optional size?: Size

  マーカーの表示サイズ

• Optional zIndex?: undefined | number

  重なり順

Type declaration

• content: string

  ラベル文字列

• Optional offset?: Point

  オフセット

• Optional style?: MarkerLabelStyle

  ラベルのスタイル

Type declaration

• Optional backgroundColor?: undefined | string

  背景色

• Optional border?: undefined | string

  境界線

• Optional color?: undefined | string

  文字色

• Optional fontSize?: undefined | string

  文字サイズ

• Optional fontWeight?: undefined | string

  文字のウェイト

• Optional padding?: undefined | string

  余白

• Optional textShadow?: undefined | string

  テキストの影

Type declaration

• Optional baseDate?: Date

  基準日時

• Optional openedRoad?: undefined | false | true

  新規開通道路表示フラグ

Type declaration

• [key: string]: string

Type declaration

• Optional fillColor?: Color

  ポリゴンの内側を塗りつぶす色

  default

  #000000

• paths: LatLng[]

  ポリゴンの形状

• Optional strokeColor?: Color

  ポリゴンの縁線の色

  default

  #000000

• Optional strokeDashArray?: number[]

  点線のパターンを塗りと休みで交互に指定する（単位はピクセル、デフォルトは実線）

• Optional strokeWeight?: undefined | number

  ポリゴンの縁線の太さ(px)

  default

  1

• Optional visible?: undefined | false | true

  表示設定

  default

  true

• Optional zIndex?: undefined | number

  重なり順（大きければ大きいほど手前に表示される、デフォルト値は一番手前）

Type declaration

• Optional position?: LatLng

  イベントが発生した緯度経度

• sourceObject: Polyline

  発火元インスタンス

Type declaration

• click: PolylineEvent

  ポリラインがクリックされたとき

• mouseover: PolylineEvent

  ポリラインにマウスオーバーしたとき

Type declaration

• path: LatLng[]

  ポリラインの形状

• Optional strokeColor?: Color

  ポリラインの色（デフォルト値は黒）

  default

  #000000

• Optional strokeDashArray?: number[]

  点線のパターンを塗りと休みで交互に指定する（単位はピクセル、デフォルトは実線）

• Optional strokeWeight?: undefined | number

  ポリラインの太さ(px)

  default

  1

• Optional visible?: undefined | false | true

  表示設定

  default

  true

• Optional zIndex?: undefined | number

  重なり順（大きければ大きいほど手前に表示される、デフォルト値は一番手前）

Type declaration

• • (data: RoadShapeOpenedData): RoadShapeOpenedAppearance

  • Parameters

    • data: RoadShapeOpenedData

    Returns RoadShapeOpenedAppearance

Type declaration

• • (data: RoadShapeOpenedData): void

  • Parameters

    • data: RoadShapeOpenedData

    Returns void

Type declaration

• Optional Readonly attr?: undefined | string

  属性ID

• Optional Readonly endDate?: undefined | string

  閉鎖日時

• Optional Readonly mesh?: undefined | string

  メッシュID

• Optional Readonly ordinalNo?: undefined | string

  整理番号

• Optional Readonly roadId?: undefined | string

  道路ID

• Optional Readonly roadName?: undefined | string

  道路名称

• Optional Readonly startDate?: undefined | string

  開通日時

Type declaration

• Optional baseDate?: Date

  基準日時

• Optional zoomRange?: ZoomRange

  表示するズームレベル範囲

Type declaration

• Optional inline?: RoadShapeOpenedLineStyleOption

  内線のオプション

• Optional outline?: RoadShapeOpenedLineStyleOption

  縁線のオプション

Type declaration

• color: Color

  色

• Optional dashArray?: number[]

  点線のパターン 数値の配列で点線のパターンを指定する 例えば [2, 1] と指定すると次のようなパターンで点線を描画する 2weightピクセル塗り、1weightピクセル休み、2*weightピクセル塗り、...

  default

  実線

• visible: boolean

  表示フラグ

• weight: number

  幅

Type declaration

• Optional backgroundColor?: undefined | string

  背景色

• Optional offset?: Point

  規定位置(左下)からのずらし幅

• Optional scaleColor?: undefined | string

  スケールの色

• Optional visible?: undefined | false | true

  表示状態設定(デフォルトはtrue)

Type declaration

• Optional name?: undefined | string

  名称 (カスタムパレット名)

• productId: string

  プロダクトID (mochaのSID)

• server: string

  サーバー向き先

Type declaration

• Optional withWebWorker?: undefined | false | true

  タイル画像取得にWebWorkerを使う(デフォルトはtrue, v1.29.0以降は参照されなくなりました)

  deprecated

Type declaration

• Optional showArrow?: undefined | false | true

  渋滞線の矢印表示

• source: TrafficJamSourceType

  交通情報提供元

• Optional time?: Date

  交通情報/大型車・定義規制情報を取得する情報の対象時刻
  ※個別の時間を指定したい場合は trafficTime および regulationTime を利用してください

  default

  現在時刻

• Optional trafficTime?: Date

  交通情報の対象時刻
  ※ time と両方指定されている場合はこちらが優先されます

  default

  現在時刻

• Optional uid?: undefined | string

  集計用UID(VICS表示で必須)

Type declaration

• • (data: TrainRouteData): TrainRouteAppearance

  • Parameters

    • data: TrainRouteData

    Returns TrainRouteAppearance

Type declaration

• • (data: TrainRouteData): void

  • Parameters

    • data: TrainRouteData

    Returns void

Type declaration

• Optional arrivalNodeId?: undefined | string

  着ノードID

• Optional companyId?: undefined | string

  会社ID

• Optional companyName?: undefined | string

  会社名

• Optional courseSeqNo?: undefined | string

  路線分割番号

• Optional depatureNodeId?: undefined | string

  発ノードID

• Optional rellineColor?: undefined | string

  実路線色

• Optional rellineId?: undefined | string

  実路線ID

• Optional rellineName?: undefined | string

  実路線名

Type declaration

• Optional zoomRange?: ZoomRange

  表示するズームレベル範囲

Type declaration

• Optional inline?: TrainRouteLineStyleOption

  内線のオプション

• Optional outline?: TrainRouteLineStyleOption

  縁線のオプション

Type declaration

• color: Color

  色

• Optional dashArray?: number[]

  点線のパターン 数値の配列で点線のパターンを指定する 例えば [2, 1] と指定すると次のようなパターンで点線を描画する 2weightピクセル塗り、1weightピクセル休み、2*weightピクセル塗り、...

  default

  実線

• weight: number

  幅

Type declaration

• Optional native?: UIEvent

  UIイベント

• sourceObject: UserLocation

  発火元インスタンス

Type declaration

• appear: UserLocationEvent

  マーカーの表示

• disappear: UserLocationEvent

  マーカーの非表示

Type declaration

• info: GLMarkerIconInfo

  画像情報

• Optional projectionMode?: UserLocationProjectionMode

  投影モード

  default

  orthographic