Options
All
  • Public
  • Public/Protected
  • All
Menu

/v2/map_script - v1.32.1

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AdditionTileConditionInitOptions

AdditionTileConditionInitOptions: { fadeIn?: undefined | false | true; hideAnnotation?: undefined | false | true; hideDefaultMapTile?: undefined | false | true; priority?: undefined | number; transparency?: undefined | number; zoomRange: ZoomRange }

任意タイル地図表示設定オプション

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

    表示ズームレベル範囲

AdditionTileOptions

AdditionTileOptions: { serverInfoList: {} }

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

Type declaration

  • serverInfoList: {}

    サーバ情報

AdditionTileServerInfo

AdditionTileServerInfo: { copyright?: LangCopyright; queryParam?: ParameterKeyValue; requestUrl: string }

任意タイル地図サーバ情報

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

AnnotationClickListener

AnnotationClickListener: (data: AnnotationData) => void

注記クリックリスナー

Type declaration

AnnotationClickListenerOptions

AnnotationClickListenerOptions: { isIconClickable?: undefined | false | true; isNodeOnly?: undefined | { icon: boolean; text: boolean }; isTextClickable?: undefined | false | true; once?: undefined | false | true }

注記クリックリスナー設定オプション

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度だけにするか

AnnotationData

AnnotationData: { appearance?: undefined | string; latlng: LatLng; nodeId?: undefined | string; type: AnnotationType }

注記データ

Type declaration

  • Optional appearance?: undefined | string

    名称

  • latlng: LatLng

    緯度経度

  • Optional nodeId?: undefined | string

    乗換検索用ノードID

  • type: AnnotationType

    タイプ

AnnotationDisplayOptions

AnnotationDisplayOptions: AnnotationDisplaySwapOptions

Webフォント表示に関する設定

AnnotationDisplaySwapOptions

AnnotationDisplaySwapOptions: { mode: "swap"; swapOptions: { swapInterval: number } }

Webフォント表示に関する設定(swapモード)

Type declaration

  • mode: "swap"
  • swapOptions: { swapInterval: number }
    • swapInterval: number

AnnotationFontFamilyMap

AnnotationFontFamilyMap: { sansSerif: FontFamily[]; sansSerifBold: FontFamily[]; serif: FontFamily[]; serifBold: FontFamily[] }

フォントIDに対応するフォントファミリー

Type declaration

AnnotationIndexedDBOptions

AnnotationIndexedDBOptions: { recordMax?: undefined | number; useIndexedDB?: undefined | false | true }

注記用IndexedDBオプション

Type declaration

  • Optional recordMax?: undefined | number

    レコード数上限

    default

    3000

  • Optional useIndexedDB?: undefined | false | true

    indexedDB利用フラグ

    default

    true

AnnotationOptions

AnnotationOptions: { display?: AnnotationDisplayOptions; fontFamily?: AnnotationFontFamilyMap; textBorder?: undefined | number }

注記DBのオプション

Type declaration

  • Optional display?: AnnotationDisplayOptions

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

  • Optional fontFamily?: AnnotationFontFamilyMap

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

  • Optional textBorder?: undefined | number

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

AnnotationType

AnnotationType: "text" | "icon" | "mapIcon"

注記タイプ

BBox

BBox: [number, number, number, number] | [number, number, number, number, number, number]

バウンディングボックス(座標範囲)

BrowserEventMap

BrowserEventMap: Pick<GaIAEventMap, "mousedown" | "mouseup" | "mousemove" | "click" | "dblclick" | "mouseenter" | "mouseleave" | "contextmenu" | "dragstart" | "drag" | "dragend" | "inertia_mousemove" | "wheel" | "wheelup" | "wheeldown" | "wheelleft" | "wheelright" | "touchstart" | "touchend" | "touchmove" | "singletap" | "singletap_2f" | "flick" | "singlescroll" | "doubletap" | "pinch" | "rotation" | "tilt" | "keydown" | "keyup" | "arrowkeydown" | "zoomkeydown">

ブラウザイベント一覧

CenterMarkerConditionInitOptions

CenterMarkerConditionInitOptions: { color?: Color; length?: undefined | number; width?: undefined | number }

十字マーカー表示オプション

Type declaration

  • Optional color?: Color

    色、デフォルトは赤

  • Optional length?: undefined | number

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

  • Optional width?: undefined | number

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

CircleOptions

CircleOptions: { center: LatLng; fillColor?: Color; radius: number; strokeColor?: Color; strokeDashArray?: number[]; strokeWeight?: undefined | number; visible?: undefined | false | true; zIndex?: undefined | number }

円を作成するときのオプション

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

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

ContextMenuEvent

ContextMenuEvent: { native: MouseEvent; position: LatLng }

コンテキストメニュークリック時のイベント

Type declaration

  • native: MouseEvent

    元のマウスイベント

  • position: LatLng

    その地点の緯度経度

ContextMenuItem

ContextMenuItem: { onselect: (e: ContextMenuEvent) => void; text: string }

コンテキストメニューの項目

Type declaration

ContextMenuOptions

ContextMenuOptions: { hideWhenZoomChange: boolean }

コンテキストメニューのオプション

Type declaration

  • hideWhenZoomChange: boolean

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

    default

    true

CoordUnit

CoordUnit: "degree" | "millisec"

緯度経度の単位

  • degree 度表記
  • millisec ミリ秒表記

CopyrightOptions

CopyrightOptions: { backgroundColor?: undefined | string; offset?: Point; textColor?: undefined | string }

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

Type declaration

  • Optional backgroundColor?: undefined | string

    背景色

  • Optional offset?: Point

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

  • Optional textColor?: undefined | string

    文字色

CopyrightTable

CopyrightTable: {}

ズームレベルに対応するコピーライトのテーブル

Type declaration

  • [zoom: number]: string[]

DOMObjectOptions

DOMObjectOptions: Partial<{ classList: string[]; content: HTMLElement | string; onPositionUpdate: () => void; zoomRange: ZoomRange }>

ExtendedKeyboardEvent

ExtendedKeyboardEvent: KeyboardEvent & { deltaX?: undefined | number; deltaY?: undefined | number; deltaZoomLevel?: undefined | number }

ブラウザのKeyboardEventを拡張したもの

ExtendedMouseEvent

ExtendedMouseEvent: MouseEvent & { deltaX?: undefined | number; deltaY?: undefined | number; position?: LatLng }

ブラウザのMouseEventを拡張したもの

ExtendedTouchEvent

ExtendedTouchEvent: TouchEvent & { deltaRotation?: undefined | number; deltaTilt?: undefined | number; deltaX?: number[]; deltaY?: number[]; multiTouchCenter?: Point; pinchDelta?: undefined | number }

ブラウザのTouchEventを拡張したもの

FigureOptions

FigureOptions: { visible?: undefined | false | true; zIndex?: undefined | number }

Type declaration

  • Optional visible?: undefined | false | true
  • Optional zIndex?: undefined | number

FontFamily

FontFamily: string | GenericFontFamily

フォントファミリー

GLMarkerEvent

GLMarkerEvent: { native?: UIEvent; sourceObject: GLMarker }

GLMarkerで発火するイベント

Type declaration

  • Optional native?: UIEvent

    UIイベント

  • sourceObject: GLMarker

    発火元インスタンス

GLMarkerEventMap

GLMarkerEventMap: { appear: GLMarkerEvent; click: GLMarkerEvent; disappear: GLMarkerEvent; dragend: GLMarkerEvent; dragging: GLMarkerEvent; mouseout: GLMarkerEvent; mouseover: GLMarkerEvent; position_changed: GLMarkerEvent }

GLMarkerが発行するイベント一覧

Type declaration

GLMarkerIconInfoInitOptions

GLMarkerIconInfoInitOptions: { gravity?: MarkerGravity; icon: string; size?: Size }

マーカー画像情報初期化オプション

Type declaration

  • Optional gravity?: MarkerGravity

    基準位置

    default

    bottom

  • icon: string

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

  • Optional size?: Size

    表示サイズ

    default

    50px × 50px

GLMarkerInitOptions

GLMarkerInitOptions: { draggable?: undefined | false | true; info: GLMarkerIconInfo; isVisible?: undefined | false | true; label?: GLMarkerLabelOptions; name?: undefined | string; position: LatLng; zIndex?: undefined | number }

GLマーカー初期化オプション

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)

GLMarkerLabelOptions

GLMarkerLabelOptions: { content: string; offset?: Point; style?: GLMarkerLabelStyle }

GLマーカー上に表示する文字ラベルの設定

Type declaration

  • content: string

    ラベル文字列

  • Optional offset?: Point

    オフセット

  • Optional style?: GLMarkerLabelStyle

    ラベルのスタイル

GLMarkerLabelStyle

GLMarkerLabelStyle: { align?: "left" | "center"; backgroundColor?: undefined | string; borderColor?: undefined | string; borderWidth?: undefined | number; color?: undefined | string; fontSize?: undefined | string; fontWeight?: undefined | string; outline?: undefined | string; padding?: undefined | number; paddingBottom?: undefined | number; paddingLeft?: undefined | number; paddingRight?: undefined | number; paddingTop?: undefined | number }

GLマーカー上に表示する文字ラベルのスタイル設定

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

    上側の余白幅

GaIAEvent

イベントオブジェクト

GaIAEventListenerOptions

GaIAEventListenerOptions: { once?: undefined | false | true }

イベントリスナーに設定するオプション

Type declaration

  • Optional once?: undefined | false | true

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

GaIAEventMap

GaIAEventMap: { 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

GeoJSON

GeoJSONオブジェクト種別

GeoJsonFigureConditionInitOptions

GeoJsonFigureConditionInitOptions: { coordUnit?: CoordUnit; isRouteShape?: undefined | false | true; polygon?: undefined | { color: Color }; polyline?: undefined | { inline?: undefined | { color?: Color; dashArray?: number[]; weight?: undefined | number }; outline?: undefined | { color?: Color; dashArray?: number[]; weight?: undefined | number } }; showRouteArrow?: undefined | false | true; zIndex?: undefined | number }

GeoJSON形状オプション

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

    最も手前

GeoJsonFigureEvent

GeoJsonFigureEvent: { position?: LatLng; sourceObject: GeoJsonFigureCondition }

GeoJSON形状で発火するイベント

Type declaration

GeoJsonFigureEventMap

GeoJsonFigureEventMap: { click: GeoJsonFigureEvent; mouseover: GeoJsonFigureEvent }

GeoJSON形状が発行するイベント一覧

Type declaration

GeoJsonGeometry

GeoJsonGeometry: Point | MultiPoint | LineString | MultiLineString | Polygon | MultiPolygon | GeometryCollection

ジオメトリオブジェクト種別

GeoJsonGeometryTypes

GeoJsonGeometryTypes: GeoJsonGeometry["type"]

ジオメトリオブジェクトのtype値

GeoJsonLineOption

GeoJsonLineOption: { color: Color; dashArray: number[]; weight: number }

線のオプション

Type declaration

  • color: Color

  • dashArray: number[]

    点線のパターン

  • weight: number

    太さ

GeoJsonProperties

GeoJsonProperties: {} | null

プロパティ

GeoJsonTypes

GeoJsonTypes: GeoJSON["type"]

GeoJSONオブジェクトのtype値

HeatMapConditionInitOptions

HeatMapConditionInitOptions: { colorMap: Map<number, Color>; geoJson: JsonObject; opacityCallback?: undefined | ((zoomLevel: number) => number); radiusCallback?: undefined | ((weight: number) => number); weightCallback: (feature: JsonObject) => 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

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

InfoWindowEvent

InfoWindowEvent: { native?: UIEvent; sourceObject: InfoWindow }

InfoWindowで発火するイベント

Type declaration

  • Optional native?: UIEvent

    UIイベント

  • sourceObject: InfoWindow

    発火元インスタンス

InfoWindowEventMap

InfoWindowEventMap: { click: InfoWindowEvent; close: InfoWindowEvent; open: InfoWindowEvent }

InfoWindowが発行するイベント一覧

Type declaration

InfoWindowInitOptions

InfoWindowInitOptions: { className?: undefined | string; content: string | HTMLElement; maxWidth?: number | string; name?: undefined | string; offset?: Point; position: LatLng; showClose?: undefined | false | true; tail?: InfoWindowTailPosition; visible?: undefined | false | true; zIndex?: undefined | number }

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

    重なり順

InfoWindowTailPosition

InfoWindowTailPosition: "none" | "left" | "right" | "top" | "bottom"

吹き出しの表示方向

JsonObject

JsonObject: any

Jsonオブジェクトの型表現

KeyboardEventMap

KeyboardEventMap: Pick<BrowserEventMap, "keydown" | "keyup" | "arrowkeydown" | "zoomkeydown">

キーボードイベント一覧

LandmarkConditionInitOptions

LandmarkConditionInitOptions: { maxZoomLevelMiniature?: undefined | number; visibleZoomRange?: ZoomRange }

3Dランドマーク表示オプション

Type declaration

  • Optional maxZoomLevelMiniature?: undefined | number

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

  • Optional visibleZoomRange?: ZoomRange

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

LangCopyright

LangCopyright: {}

言語ごとのコピーライト情報

Type declaration

Language

Language: "ja" | "en" | "ko" | "zh-TW" | "zh-CN" | "th"

言語

  • ja: 日本語
  • en: 英語
  • ko: 韓国語
  • zh-TW: 繁体字
  • zh-CN: 簡体字
  • th: タイ語

LoadingProgressListener

LoadingProgressListener: (progress: number) => void

Type declaration

    • (progress: number): void
    • Parameters

      • progress: number

      Returns void

MapEventMap

MapEventMap: Pick<GaIAEventMap, "zoomchanged" | "centermoved">

地図イベント一覧

MapIconClickListener

MapIconClickListener: (data: MapIconData) => void

Type declaration

MapIconClickListenerOptions

MapIconClickListenerOptions: { isIconClickable?: undefined | false | true; once?: undefined | false | true }

Type declaration

  • Optional isIconClickable?: undefined | false | true

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

    default

    true

  • Optional once?: undefined | false | true

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

MapIconConditionInitOptions

MapIconConditionInitOptions: { product?: undefined | string; tags: {} }

地図アイコンオプション

Type declaration

  • Optional product?: undefined | string

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

  • tags: {}

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

MapIconConditionPaletteConfig

MapIconConditionPaletteConfig: { name?: undefined | string; size?: undefined | number; zoomRange: ZoomRange }

地図アイコンの見た目の設定

Type declaration

  • Optional name?: undefined | string

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

  • Optional size?: undefined | number

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

  • zoomRange: ZoomRange

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

MapIconData

MapIconData: { address?: undefined | string; latlng: LatLng; name?: undefined | string; phone?: undefined | string; postalCode?: undefined | string; providerId?: undefined | string; spotId?: undefined | string }

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

MapIconMouseEnterListener

MapIconMouseEnterListener: (data: MapIconData) => void

Type declaration

MapInitSettingOptions

MapInitSettingOptions: { additionTileOptions?: AdditionTileOptions; annotationIndexedDB?: AnnotationIndexedDBOptions; annotationOptions?: AnnotationOptions; blankTileImage?: undefined | string; centerOffset?: Point; copyright?: CopyrightOptions; fogColor?: Color; isAnnotationEnabled?: undefined | false | true; language?: Language; mapIconOptions?: MapIconConditionInitOptions; scale?: ScaleOptions; skyColor?: Color; tileBuilding3D?: undefined | false | true; tileLoader?: TileLoaderOptions; tileZoomLevelFix?: TileZoomLevelFixValue; viewRange?: LatLngRect; wheelZoomEnable?: undefined | false | true; zoomRange?: ZoomRange }

地図初期化の追加設定オプション

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

    ズームレンジ

MapInitSettings

MapInitSettings: { center: LatLng; options?: MapInitSettingOptions; target: string | HTMLElement; zoomLevel: number }

地図初期化設定

Type declaration

  • center: LatLng

    中心座標

  • Optional options?: MapInitSettingOptions

    オプション

  • target: string | HTMLElement

    地図表示をする要素

  • zoomLevel: number

    ズームレベル(整数値)

MapLocationStatus

MapLocationStatus: { center: LatLng; heading: number; tilt: number; zoom: number }

現在見えている地図の状態

Type declaration

  • center: LatLng

    中心緯度経度

  • heading: number

    回転角

  • tilt: number

    傾き

  • zoom: number

    現在のズームレベル

MarkerAnimationType

MarkerAnimationType: "fadeIn" | "drop"

マーカーに設定できるアニメーション

  • fadeIn: フェードイン
  • drop: 落下

MarkerEvent

MarkerEvent: { native?: UIEvent; sourceObject: Marker }

Markerで発火するイベント

Type declaration

  • Optional native?: UIEvent

    UIイベント

  • sourceObject: Marker

    発火元インスタンス

MarkerEventMap

MarkerEventMap: { appear: MarkerEvent; click: MarkerEvent; disappear: MarkerEvent; position_changed: MarkerEvent }

Markerが発行するイベント一覧

Type declaration

  • appear: MarkerEvent

    マーカーの表示

  • click: MarkerEvent

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

  • disappear: MarkerEvent

    マーカーの非表示

  • position_changed: MarkerEvent

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

MarkerGravity

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

マーカー基準位置
(画像のどの位置に対して指定緯度経度地点を置くか)

  • top-left: 左上
  • top: 上
  • top-right: 右上
  • left: 左
  • center: 中央
  • right: 右
  • bottom-left: 左下
  • bottom: 下
  • bottom-right: 右下

MarkerInitOptions

MarkerInitOptions: { animation?: MarkerAnimationType; className?: undefined | string; draggable?: undefined | false | true; gravity?: MarkerGravity; icon: string; label?: MarkerLabelOptions; name?: undefined | string; offset?: Point; position: LatLng; size?: Size; zIndex?: undefined | number }

マーカー初期化オプション

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

    重なり順

MarkerLabelOptions

MarkerLabelOptions: { content: string; offset?: Point; style?: MarkerLabelStyle }

マーカー上に表示する文字ラベルの設定

Type declaration

  • content: string

    ラベル文字列

  • Optional offset?: Point

    オフセット

  • Optional style?: MarkerLabelStyle

    ラベルのスタイル

MarkerLabelStyle

MarkerLabelStyle: { backgroundColor?: undefined | string; border?: undefined | string; color?: undefined | string; fontSize?: undefined | string; fontWeight?: undefined | string; padding?: undefined | string; textShadow?: undefined | string }

マーカー上に表示する文字ラベルのCSS設定
※ CSSStyleDeclaration に定義されているものの一部を利用可能

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

    テキストの影

MarkerProperties

MarkerProperties: Record<string, any>

Markerのプロパティ

MouseEventMap

MouseEventMap: Pick<BrowserEventMap, "mousedown" | "mouseup" | "mousemove" | "click" | "dblclick" | "mouseenter" | "mouseleave" | "contextmenu" | "dragstart" | "drag" | "dragend" | "inertia_mousemove">

マウスイベント一覧

OrbitConditionInitOptions

OrbitConditionInitOptions: { baseDate?: Date; openedRoad?: undefined | false | true }

軌跡(moon)表示オプション

Type declaration

  • Optional baseDate?: Date

    基準日時

  • Optional openedRoad?: undefined | false | true

    新規開通道路表示フラグ

ParameterKeyValue

ParameterKeyValue: {}

プロパティ・値がともに文字列となるオブジェクトの型表現

Type declaration

  • [key: string]: string

PolygonOptions

PolygonOptions: { fillColor?: Color; paths: LatLng[]; strokeColor?: Color; strokeDashArray?: number[]; strokeWeight?: undefined | number; visible?: undefined | false | true; zIndex?: undefined | number }

ポリゴン生成オプション

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

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

PolylineEvent

PolylineEvent: { position?: LatLng; sourceObject: Polyline }

ポリラインで発火するイベント

Type declaration

  • Optional position?: LatLng

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

  • sourceObject: Polyline

    発火元インスタンス

PolylineEventMap

PolylineEventMap: { click: PolylineEvent; mouseover: PolylineEvent }

ポリラインが発行するイベント一覧

Type declaration

  • click: PolylineEvent

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

  • mouseover: PolylineEvent

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

PolylineOptions

PolylineOptions: { path: LatLng[]; strokeColor?: Color; strokeDashArray?: number[]; strokeWeight?: undefined | number; visible?: undefined | false | true; zIndex?: undefined | number }

ポリライン生成オプション

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

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

Position

Position: number[]

GeoJSONオブジェクトが持つ座標

RoadShapeOpenedCallback

RoadShapeOpenedCallback: (data: RoadShapeOpenedData) => RoadShapeOpenedAppearance

新規開通道路の見た目情報設定用コールバック

RoadShapeOpenedClickListener

RoadShapeOpenedClickListener: (data: RoadShapeOpenedData) => void

新規開通道路クリックリスナー

Type declaration

RoadShapeOpenedData

RoadShapeOpenedData: { attr?: undefined | string; endDate?: undefined | string; mesh?: undefined | string; ordinalNo?: undefined | string; roadId?: undefined | string; roadName?: undefined | string; startDate?: undefined | string }

新規開通道路データ

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

    開通日時

RoadShapeOpenedInitOptions

RoadShapeOpenedInitOptions: { baseDate?: Date; zoomRange?: ZoomRange }

新規開通道路表示オプション

Type declaration

  • Optional baseDate?: Date

    基準日時

  • Optional zoomRange?: ZoomRange

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

RoadShapeOpenedLineStyle

RoadShapeOpenedLineStyle: { inline?: RoadShapeOpenedLineStyleOption; outline?: RoadShapeOpenedLineStyleOption }

新規開通道路の描画スタイル

Type declaration

RoadShapeOpenedLineStyleOption

RoadShapeOpenedLineStyleOption: { color: Color; dashArray?: number[]; visible: boolean; weight: number }

新規開通道路の描画スタイルオプション

Type declaration

  • color: Color

  • Optional dashArray?: number[]

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

    default

    実線

  • visible: boolean

    表示フラグ

  • weight: number

ScaleOptions

ScaleOptions: { backgroundColor?: undefined | string; offset?: Point; scaleColor?: undefined | string; visible?: undefined | false | true }

縮尺表示指定オプション

Type declaration

  • Optional backgroundColor?: undefined | string

    背景色

  • Optional offset?: Point

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

  • Optional scaleColor?: undefined | string

    スケールの色

  • Optional visible?: undefined | false | true

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

ServerInformation

ServerInformation: { name?: undefined | string; productId: string; server: string }

地図データを取得するサーバー情報

Type declaration

  • Optional name?: undefined | string

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

  • productId: string

    プロダクトID (mochaのSID)

  • server: string

    サーバー向き先

TileLoaderOptions

TileLoaderOptions: { withWebWorker?: undefined | false | true }

タイル画像取得に関する設定

Type declaration

  • Optional withWebWorker?: undefined | false | true

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

    deprecated

TileSize

TileSize: 256 | 512

タイル画像サイズ

TileZoomLevelFixValue

TileZoomLevelFixValue: "upper" | "lower" | "round"

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

  • upper 上位タイルを優先
  • lower 下位タイルを優先
  • round 四捨五入したもの

TouchEventMap

TouchEventMap: Pick<BrowserEventMap, "touchstart" | "touchend" | "touchmove" | "singletap" | "singlescroll" | "doubletap" | "pinch" | "rotation" | "tilt" | "singletap_2f" | "flick">

タッチイベント一覧

TrafficConditionInitOptions

TrafficConditionInitOptions: { showArrow?: undefined | false | true; source: TrafficJamSourceType; time?: Date; trafficTime?: Date; uid?: undefined | string }

交通情報表示

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表示で必須)

TrafficJamSourceType

TrafficJamSourceType: "vics" | "probe" | "both" | "none"

渋滞情報提供元

  • vics : VICS
  • probe : プローブ
  • both : VICS + プローブ
  • none : 非表示

TrainRouteCallback

TrainRouteCallback: (data: TrainRouteData) => TrainRouteAppearance

鉄道路線の見た目情報設定用コールバック

Type declaration

TrainRouteClickListener

TrainRouteClickListener: (data: TrainRouteData) => void

鉄道路線クリックリスナー

Type declaration

TrainRouteData

TrainRouteData: { arrivalNodeId?: undefined | string; companyId?: undefined | string; companyName?: undefined | string; courseSeqNo?: undefined | string; depatureNodeId?: undefined | string; rellineColor?: undefined | string; rellineId?: undefined | string; rellineName?: undefined | string }

鉄道路線データ

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

    実路線名

TrainRouteInitOptions

TrainRouteInitOptions: { zoomRange?: ZoomRange }

鉄道路線図表示オプション

Type declaration

  • Optional zoomRange?: ZoomRange

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

TrainRouteLineStyle

TrainRouteLineStyle: { inline?: TrainRouteLineStyleOption; outline?: TrainRouteLineStyleOption }

鉄道路線の描画スタイル

Type declaration

TrainRouteLineStyleOption

TrainRouteLineStyleOption: { color: Color; dashArray?: number[]; weight: number }

鉄道路線の描画スタイルオプション

Type declaration

  • color: Color

  • Optional dashArray?: number[]

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

    default

    実線

  • weight: number

UserLocationEvent

UserLocationEvent: { native?: UIEvent; sourceObject: UserLocation }

UserLocationで発火するイベント

Type declaration

  • Optional native?: UIEvent

    UIイベント

  • sourceObject: UserLocation

    発火元インスタンス

UserLocationEventMap

UserLocationEventMap: { appear: UserLocationEvent; disappear: UserLocationEvent }

UserLocationが発行するイベント一覧

Type declaration

UserLocationInitOptions

UserLocationInitOptions: { info: GLMarkerIconInfo; projectionMode?: UserLocationProjectionMode }

自位置マーカー初期化オプション

Type declaration

UserLocationProjectionMode

UserLocationProjectionMode: "perspective" | "orthographic"

自位置マーカーの投影モード

UserLocationTrackingMode

UserLocationTrackingMode: "none" | "follow" | "heading_up"

トラッキングモード

WheelEventMap

WheelEventMap: Pick<BrowserEventMap, "wheel" | "wheelup" | "wheeldown" | "wheelleft" | "wheelright">

ホイールイベント一覧

Variables

Const DASH_ARRAY_SOLID

DASH_ARRAY_SOLID: number[] = [1000 * 1000 * 1000]

Const DEFAULT_GEOJSON_COLOR

DEFAULT_GEOJSON_COLOR: Color = Color.green()

デフォルトの色

Const DEFAULT_GEOJSON_LINE_WEIGHT

DEFAULT_GEOJSON_LINE_WEIGHT: 5 = 5

デフォルトの線幅

Const DEFAULT_GEOJSON_OUTLINE_COLOR

DEFAULT_GEOJSON_OUTLINE_COLOR: Color = new Color(0, 0.5, 0, 1)

デフォルトの縁線色

Const DEFAULT_GEOJSON_OUTLINE_WEIGHT

DEFAULT_GEOJSON_OUTLINE_WEIGHT: 10 = 10

デフォルトの縁線幅

Const DEFAULT_LENGTH

DEFAULT_LENGTH: 10 = 10

Const DEFAULT_MAX_ZOOM_LEVEL_MINIATURE

DEFAULT_MAX_ZOOM_LEVEL_MINIATURE: 16 = 16

Const DEFAULT_VISIBLE_ZOOM_RANGE

DEFAULT_VISIBLE_ZOOM_RANGE: ZoomRange = new ZoomRange(15)

Const DEFAULT_WIDTH

DEFAULT_WIDTH: 2 = 2

Const DEFAULT_ZOOM_RANGE

DEFAULT_ZOOM_RANGE: ZoomRange = new ZoomRange()

Const DefaultIndoorBackgroundColor

DefaultIndoorBackgroundColor: Color = new Color(0, 0, 0, 0.8)

Const GLOBE_SPHERE_RADIUS

GLOBE_SPHERE_RADIUS: 6378137 = 6378137

WGS84での地球の赤道半径(m)

Const MAX_UNSIGNED_BYTE

MAX_UNSIGNED_BYTE: 255 = 255

Const config

config: Config = new Config(process.env.CONF_SERVER_ENDPOINT ?? '')

Functions

Const calcDistance

  • 2地点間の距離を算出する

    Parameters

    Returns number

    2地点間の距離

Const locationsToLatLngRect

  • 指定された緯度経度が全て入る矩形作成

    Parameters

    • locationList: LatLng[]

      緯度経度配列

    • Optional centerLocation: LatLng

      中心緯度経度

    Returns Optional<LatLngRect>

    LatLngRect ※locationsListが空の場合はnull

Const transDegreeToMillisec

  • transDegreeToMillisec(position: number): number
  • 度表記からミリ秒表記に変換する

    Parameters

    • position: number

      緯度または経度

    Returns number

    ミリ秒表記の緯度または経度

Const transMillisecToDegree

  • transMillisecToDegree(position: number): number
  • ミリ秒表記から度表記に変換する

    Parameters

    • position: number

      緯度または経度

    Returns number

    度表記の緯度または経度

Const transTokyoToWGS

  • 日本測地系を世界測地系に変換する

    Parameters

    Returns LatLng

    変換後緯度経度

Const transWGSToTokyo

  • 世界測地系を日本測地系に変換する

    Parameters

    Returns LatLng

    変換後緯度経度