atlas module
클래스
EventManager |
지도 컨트롤의 이벤트에 대한 관리자입니다. atlas의 이벤트 속성을 통해 노출됩니다. Map 클래스입니다. 사용자가 인스턴스화할 수 없습니다. |
HtmlMarker |
이 클래스는 지도에 표시할 수 있는 HTML 요소를 래핑합니다. |
Map |
시각적 및 대화형 웹 맵에 대한 컨트롤입니다. |
Pixel |
픽셀 좌표 또는 오프셋을 나타냅니다. [x, y]의 배열을 확장합니다. |
Popup |
지도의 지정된 위치에 고정된 정보 창입니다. |
PopupTemplate |
팝업에 대한 레이아웃 템플릿입니다. |
Shape |
Geometry 또는 Feature를 래핑하고 쉽게 업데이트하고 유지 관리할 수 있는 도우미 클래스입니다. |
인터페이스
AggregateExpression |
집계 식은 데이터 집합을 통해 처리되는 계산을 정의합니다.
스키마: [operator: string, initialValue?: boolean | number, mapExpression: Expression] 연산자: 클러스터의 각 지점에 대해 |
AnimationOptions |
지도 컨트롤의 카메라에 변경 내용에 애니메이션 효과를 주는 옵션입니다. |
AuthenticationManager |
지도 컨트롤의 인증 관리자입니다. atlas의 인증 속성을 통해 노출됩니다. Map 클래스입니다. 사용자가 인스턴스화할 수 없습니다. |
AuthenticationOptions |
맵 컨트롤이 Azure Maps 서비스를 사용하여 인증하는 방법을 지정하는 옵션입니다. |
BubbleLayerOptions |
BubbleLayer에서 Point 개체를 렌더링할 때 사용되는 옵션입니다. |
CameraBoundsOptions |
지도 컨트롤 카메라의 경계를 설정하는 옵션입니다. |
CameraOptions |
지도 컨트롤의 카메라를 설정하는 옵션입니다. |
ClusteredProperties |
ClusteredProperties에 대해 존재할 속성 |
CompassControlOptions |
CompassControl 개체에 대한 옵션입니다. |
Control |
맵의 컨트롤을 정의하기 위한 인터페이스입니다. |
ControlManager |
지도 컨트롤의 컨트롤에 대한 관리자입니다. 아틀라스의 컨트롤 속성을 통해 노출됩니다. Map 클래스입니다. 사용자가 인스턴스화할 수 없습니다. |
ControlOptions |
맵에 컨트롤을 추가하는 옵션입니다. |
DataSourceOptions |
지도에 표시될 셰이프 데이터를 관리하기 위한 데이터 원본입니다.
데이터 원본이 맵에 표시되기 전에 계층에 추가해야 합니다.
|
ElevationTileSourceOptions | |
FullscreenControlOptions |
FullscreenControl 개체에 대한 옵션입니다. |
HeatMapLayerOptions |
HeatMapLayer에서 Point 개체를 렌더링할 때 사용되는 옵션입니다. |
HtmlMarkerEvents | |
HtmlMarkerManager |
지도 컨트롤의 HTML 표식에 대한 관리자입니다. 아틀라스의 표식 속성을 통해 노출됩니다. Map 클래스입니다. 사용자가 인스턴스화할 수 없습니다. |
HtmlMarkerOptions |
HtmlMarker 개체 렌더링 옵션 |
HyperLinkFormatOptions |
하이퍼링크 문자열의 서식 옵션입니다. |
IconOptions |
SymbolLayer에서 아이콘을 사용자 지정하는 데 사용되는 옵션 |
ImageLayerOptions |
ImageLayer에서 Point 개체를 렌더링할 때 사용되는 옵션입니다. |
ImageSpriteManager |
지도 컨트롤의 이미지 스프라이트에 대한 관리자입니다. atlas의 imageSprite 속성을 통해 노출됩니다. Map 클래스입니다. 사용자가 인스턴스화할 수 없습니다. |
LayerManager |
지도 컨트롤의 레이어에 대한 관리자입니다. 아틀라스의 레이어 속성을 통해 노출됩니다. Map 클래스입니다. 사용자가 인스턴스화할 수 없습니다. |
LayerOptions |
다른 모든 계층 옵션이 상속하는 기본 클래스입니다. |
LightOptions |
지도 조명 옵션입니다. |
LineLayerOptions |
줄 계층에서 SimpleLine, SimplePolygon, CirclePolygon, LineString, MultiLineString, Polygon 및 MultiPolygon 개체를 렌더링할 때 사용되는 옵션입니다. |
MapConfiguration |
사용할 수 있는 스타일 목록을 포함하는 지도 구성의 내용을 나타냅니다. |
MapConfigurationStyle |
단일 스타일에 대한 정보를 나타냅니다. |
MapDataEvent |
데이터 이벤트가 발생할 때 맵에서 반환되는 이벤트 개체입니다. |
MapErrorEvent |
오류 이벤트가 발생할 때 맵에서 반환되는 이벤트 개체입니다. |
MapEvent |
기본 이벤트가 발생할 때 맵에서 반환되는 이벤트 개체입니다. |
MapMouseEvent |
마우스 이벤트가 발생할 때 맵에서 반환되는 이벤트 개체입니다. |
MapMouseWheelEvent |
휠 이벤트가 발생할 때 맵에서 반환되는 이벤트 개체입니다. |
MapTouchEvent |
터치 이벤트가 발생할 때 맵에서 반환되는 이벤트 개체입니다. |
MediaLayerOptions |
캔버스, 이미지, 래스터 타일 및 비디오 레이어를 렌더링할 때 사용되는 옵션 |
Options | |
Padding |
지도의 카메라를 설정할 때 BoundingBox의 측면에 추가할 안쪽 여백의 양을 픽셀 단위로 나타냅니다. |
PitchControlOptions |
PitchControl 개체에 대한 옵션입니다. |
PolygonExtrusionLayerOptions |
|
PolygonLayerOptions |
PolygonLayer에서 Polygon 및 MultiPolygon 개체를 렌더링할 때 사용되는 옵션입니다. |
PopupEvents | |
PopupManager |
지도 컨트롤의 팝업 관리자입니다.
|
PopupOptions |
팝업 옵션입니다. |
Properties |
|
PropertyInfo |
속성을 표시하는 방법에 대한 종 세부 정보입니다. |
RasterTileSourceOptions | |
RequestParameters |
transformRequest 콜백에서 반환될 것으로 예상되는 개체 형식입니다. |
ScaleControlOptions |
ScaleControl 개체에 대한 옵션입니다. |
ServiceOptions |
모든 atlas 서비스 요청에 사용되는 전역 속성입니다. |
ShapeEvents | |
SourceManager |
지도 컨트롤의 원본에 대한 관리자입니다. atlas의 sources 속성을 통해 노출됩니다. Map 클래스입니다. 사용자가 인스턴스화할 수 없습니다. |
StyleChangedEvent |
새 스타일을 로드한 후 맵에서 반환된 이벤트 개체입니다. |
StyleControlOptions |
StyleControl 개체에 대한 옵션입니다. |
StyleOptions |
지도 스타일에 대한 옵션입니다. |
SymbolLayerOptions |
SymbolLayer에서 기하 도형을 렌더링할 때 사용되는 옵션입니다. |
TargetedEvent | |
TextOptions |
SymbolLayer에서 텍스트를 사용자 지정하는 데 사용되는 옵션 |
Tile |
원본 데이터 이벤트가 발생할 때 맵에서 반환되는 타일 개체입니다. |
TileId | |
TileLayerOptions |
TileLayer에서 래스터 타일 이미지를 렌더링할 때 사용되는 옵션입니다. |
TrafficControlOptions | |
TrafficOptions |
맵에서 트래픽을 설정하는 옵션입니다. |
UserInteractionOptions |
맵과의 사용자 상호 작용을 사용/사용하지 않도록 설정하는 옵션입니다. |
VectorTileSourceOptions |
지도에 표시될 셰이프 데이터를 관리하기 위한 데이터 원본입니다.
데이터 원본이 맵에 표시되기 전에 계층에 추가해야 합니다.
|
WebGLLayerOptions |
WebGLLayer에서 그래픽을 렌더링하는 데 사용되는 옵션입니다. |
WebGLRenderer |
WebGLLayer에서 WebGL 그래픽을 렌더링하기 위한 인터페이스입니다. |
ZoomControlOptions |
ZoomControl 개체에 대한 옵션입니다. |
형식 별칭
Expression |
필터 또는 특정 계층 옵션의 값으로 지정할 수 있습니다. 식은 속성 값을 계산하기 위한 수식을 정의합니다. 식은 JSON 배열로 표시됩니다. 식의 첫 번째 요소는 식 연산자의 이름을 지정하는 문자열입니다. |
getAuthTokenCallback |
익명 인증 모드에서 인증 토큰을 획득하는 데 사용되는 콜백 함수입니다. 인증 토큰으로 해결하거나 오류를 사용하여 거부합니다. |
ResourceType | |
StyleImageMetadata |
|
열거형
AuthenticationType |
사용할 인증 메커니즘의 유형을 지정하는 데 사용되는 열거형입니다. |
ControlPosition |
컨트롤을 지도에 배치할 수 있는 위치입니다. |
ControlStyle |
Control에 사용 가능한 스타일입니다. |
함수
add |
아틀라스 네임스페이스에 이미지 템플릿을 추가합니다. |
add |
사용자 지정 URL 스키마로 시작하는 URL을 사용할 때 호출되는 사용자 지정 로드 리소스 함수를 추가합니다. |
clear |
|
get |
atlas 네임스페이스에서 사용할 수 있는 모든 이미지 템플릿의 이름 배열을 검색합니다. |
get |
제공된 기본 인증 옵션을 가져옵니다. 이전에 설정하지 않은 경우 모든 속성이 정의되지 않습니다. |
get |
제공된 기본 도메인을 가져옵니다.
이전에 설정하지 않은 경우 기본값은 |
get |
이름으로 SVG 템플릿을 검색합니다. |
get |
제공된 기본 언어를 가져옵니다.
이전에 설정하지 않은 경우 기본값은 |
get |
병렬로 로드할 최대 이미지 수(래스터 타일, 스프라이트, 아이콘)를 가져옵니다. |
get |
제공된 기본 세션 ID를 가져옵니다. 이전에 설정하지 않은 경우 기본값은 임의의 UUID입니다. |
get |
제공된 기본 Azure Maps 구독 키를 가져옵니다. |
get |
|
get |
빌드 번호를 기반으로 하는 현재 API 버전 번호입니다. |
get |
지도 컨트롤의 기본 보기 설정을 가져옵니다.
이전에 설정하지 않은 경우 기본값은 |
get |
만들 작업자 수를 가져옵니다. |
is |
사용자의 브라우저가 지도 컨트롤에서 지원되는지 확인합니다. |
prewarm() | 일부 상황에서는 로드 시간을 낮추기 위해 맵 간에 공유할 수 있는 WebWorkers와 같은 리소스를 초기화합니다.
이는 주로 단일 페이지 앱에서 GL-JS 맵을 사용할 때 유용합니다. 여기서 사용자는 지도 인스턴스를 지속적으로 만들고 제거할 수 있는 다양한 보기 사이를 탐색합니다. |
remove |
주 스레드에서 이전에 추가된 프로토콜을 제거합니다. |
set |
인증 옵션을 지도 컨트롤 및 Azure Maps 서비스에 대한 요청을 만드는 모든 모듈에서 사용하는 atlas 네임스페이스의 기본 옵션으로 설정합니다. 맵이 명시적으로 정의된 인증 옵션으로 초기화되고 setAuthenticationOptions가 이전에 호출되지 않은 경우 Map 생성자가 자동으로 호출합니다. |
set |
API의 해당 부분을 사용할 때 도메인을 명시적으로 지정하지 않는 한 맵 및 서비스 모듈에서 사용하는 기본 도메인을 설정합니다.
맵이 명시적으로 정의된 도메인으로 초기화되고 setDomain이 이전에 호출되지 않은 경우 지도 생성자가 자동으로 호출합니다.
프로토콜이 지정되지 않은 경우 |
set |
API의 해당 부분을 사용할 때 언어를 명시적으로 지정하지 않는 한 지도 및 서비스 모듈에서 사용하는 기본 언어를 설정합니다. 맵이 명시적으로 정의된 언어로 초기화되고 setLanguage가 이전에 호출되지 않은 경우 지도 생성자가 자동으로 호출합니다. |
set |
래스터가 많은 맵의 성능에 영향을 미치는 최대 이미지 수(래스터 타일, 스프라이트, 아이콘)를 병렬로 로드하도록 설정합니다. 기본적으로 16. |
set |
API의 해당 부분을 사용할 때 세션 ID를 명시적으로 지정하지 않는 한 맵 및 서비스 모듈에서 사용하는 기본 세션 ID를 설정합니다. 맵이 명시적으로 정의된 세션 ID로 초기화되고 setSessionId가 이전에 호출되지 않은 경우 Map 생성자가 자동으로 호출합니다. |
set |
Azure Maps 구독 키를 지도 컨트롤 및 Azure Maps 서비스에 대한 요청을 만드는 모든 모듈에서 사용하는 atlas 네임스페이스의 기본 구독 키로 설정합니다. 맵이 명시적으로 정의된 구독 키로 초기화되고 setSubscriptionKey가 이전에 호출되지 않은 경우 지도 생성자가 자동으로 호출합니다. |
set |
|
set |
지도에 표시되는 지정학적으로 분쟁이 있는 테두리 및 레이블 집합을 지정합니다. View 매개 변수("사용자 지역 매개 변수"라고도 함)는 해당 국가/지역에 대한 올바른 맵을 표시하는 2자 ISO-3166 국가 코드입니다. 보기 목록에 없거나 지정되지 않은 경우 국가/지역은 기본적으로 "통합" 보기로 설정됩니다. 지원되는 [보기]{@link https://aka.ms/AzureMapsLocalizationViews }를 참조하세요. 사용자의 위치를 확인한 다음 해당 위치에 대해 View 매개 변수를 올바르게 설정하는 것은 사용자의 책임입니다. Azure Maps의 View 매개 변수는 Azure Maps를 통해 액세스할 수 있는 권한이 있는 지도, 이미지 및 기타 데이터 및 타사 콘텐츠를 사용할 수 있는 국가/지역의 매핑과 관련된 법률을 포함하여 관련 법률을 준수하는 데 사용해야 합니다. |
set |
페이지에서 인스턴스화된 웹 작업자 수를 설정합니다. 기본적으로 CPU 코어 수의 절반으로 설정됩니다(6으로 제한됨). |
함수 세부 정보
addImageTemplate(string, string, boolean)
아틀라스 네임스페이스에 이미지 템플릿을 추가합니다.
function addImageTemplate(templateName: string, template: string, override: boolean)
매개 변수
- templateName
-
string
템플릿의 이름입니다.
- template
-
string
추가할 SVG 템플릿입니다. {color}, {secondaryColor}, {scale}, {text}을(를) 지원합니다.
- override
-
boolean
이름이 같은 템플릿이 이미 있는 경우 기존 템플릿을 재정의해야 하는지 여부를 지정합니다.
addProtocol(string, (args: any[]) => Promise<any>)
사용자 지정 URL 스키마로 시작하는 URL을 사용할 때 호출되는 사용자 지정 로드 리소스 함수를 추가합니다.
function addProtocol(customProtocol: string, loadFn: (args: any[]) => Promise<any>)
매개 변수
- customProtocol
-
string
후크할 프로토콜(예: 'custom')
- loadFn
-
(args: any[]) => Promise<any>
customProtocol에서 지정한 타일을 가져올 때 사용할 함수입니다.
clearPrewarmedResources()
atlas.prewarm()
이전에 만든 리소스를 지웁니다.
이는 일반적으로 필요하지 않습니다. 앱 사용자가 애플리케이션의 어느 지점에서든 지도 보기로 돌아가지 않을 것으로 예상하는 경우에만 이 함수를 호출해야 합니다.
function clearPrewarmedResources()
getAllImageTemplateNames()
atlas 네임스페이스에서 사용할 수 있는 모든 이미지 템플릿의 이름 배열을 검색합니다.
function getAllImageTemplateNames(): string[]
반환
string[]
getAuthenticationOptions()
제공된 기본 인증 옵션을 가져옵니다. 이전에 설정하지 않은 경우 모든 속성이 정의되지 않습니다.
function getAuthenticationOptions(): AuthenticationOptions
반환
getDomain()
제공된 기본 도메인을 가져옵니다.
이전에 설정하지 않은 경우 기본값은 "atlas.microsoft.com"
.
function getDomain(): string
반환
string
getImageTemplate(string, number)
이름으로 SVG 템플릿을 검색합니다.
function getImageTemplate(templateName: string, scale?: number): string
매개 변수
- templateName
-
string
검색할 템플릿의 이름입니다.
- scale
-
number
템플릿의 크기를 조정할 크기를 지정합니다. 최상의 결과를 위해 아이콘을 지도에 표시할 최대 크기로 조정한 다음 기호 계층 아이콘 크기 옵션을 사용하여 필요한 경우 축소합니다. 이렇게 하면 크기 조정으로 인한 흐림이 줄어듭니다. 기본값: 1
반환
string
getLanguage()
제공된 기본 언어를 가져옵니다.
이전에 설정하지 않은 경우 기본값은 "NGT"
.
function getLanguage(): string
반환
string
getMaxParallelImageRequests()
병렬로 로드할 최대 이미지 수(래스터 타일, 스프라이트, 아이콘)를 가져옵니다.
function getMaxParallelImageRequests(): number
반환
number
getSessionId()
제공된 기본 세션 ID를 가져옵니다. 이전에 설정하지 않은 경우 기본값은 임의의 UUID입니다.
function getSessionId(): string
반환
string
getSubscriptionKey()
제공된 기본 Azure Maps 구독 키를 가져옵니다.
function getSubscriptionKey(): string
반환
string
getUserRegion()
경고
이 API는 이제 사용되지 않습니다.
use atlas.getView() instead
function getUserRegion(): string
반환
string
getVersion()
빌드 번호를 기반으로 하는 현재 API 버전 번호입니다.
function getVersion(): string
반환
string
getView()
지도 컨트롤의 기본 보기 설정을 가져옵니다.
이전에 설정하지 않은 경우 기본값은 undefined
.
function getView(): string
반환
string
getWorkerCount()
만들 작업자 수를 가져옵니다.
function getWorkerCount(): number
반환
number
isSupported(boolean)
사용자의 브라우저가 지도 컨트롤에서 지원되는지 확인합니다.
function isSupported(failIfMajorPerformanceCaveat?: boolean): boolean
매개 변수
- failIfMajorPerformanceCaveat
-
boolean
true이면 맵 컨트롤의 성능이 예상보다 훨씬 더 나빠지면 함수가 false를 반환합니다(예: 소프트웨어 WebGL 렌더러가 사용됨).
반환
boolean
prewarm()
일부 상황에서는 로드 시간을 낮추기 위해 맵 간에 공유할 수 있는 WebWorkers와 같은 리소스를 초기화합니다.
atlas.setWorkerCount
prewarm()
호출하여 효과를 발휘하기 전에 설정해야 합니다.
기본적으로 이러한 리소스의 수명 주기는 자동으로 관리되며 맵을 처음 만들 때 지연 초기화됩니다.
prewarm()
호출하면 이러한 리소스가 미리 만들어지고 마지막 맵이 페이지에서 제거될 때 지워지지 않습니다. 이렇게 하면 나중에 만든 새 Map 인스턴스에서 다시 사용할 수 있습니다.
atlas.clearPrewarmedResources()
호출하여 수동으로 지울 수 있습니다. 웹 페이지가 활성 상태로 유지되지만 맵 사용을 완전히 중지하는 경우에만 필요합니다.
이는 주로 단일 페이지 앱에서 GL-JS 맵을 사용할 때 유용합니다. 여기서 사용자는 지도 인스턴스를 지속적으로 만들고 제거할 수 있는 다양한 보기 사이를 탐색합니다.
function prewarm()
removeProtocol(string)
주 스레드에서 이전에 추가된 프로토콜을 제거합니다.
function removeProtocol(customProtocol: string)
매개 변수
- customProtocol
-
string
등록을 제거할 사용자 지정 프로토콜
setAuthenticationOptions(AuthenticationOptions)
인증 옵션을 지도 컨트롤 및 Azure Maps 서비스에 대한 요청을 만드는 모든 모듈에서 사용하는 atlas 네임스페이스의 기본 옵션으로 설정합니다. 맵이 명시적으로 정의된 인증 옵션으로 초기화되고 setAuthenticationOptions가 이전에 호출되지 않은 경우 Map 생성자가 자동으로 호출합니다.
function setAuthenticationOptions(options: AuthenticationOptions)
매개 변수
- options
- AuthenticationOptions
새 기본 인증 옵션입니다.
setDomain(string)
API의 해당 부분을 사용할 때 도메인을 명시적으로 지정하지 않는 한 맵 및 서비스 모듈에서 사용하는 기본 도메인을 설정합니다.
맵이 명시적으로 정의된 도메인으로 초기화되고 setDomain이 이전에 호출되지 않은 경우 지도 생성자가 자동으로 호출합니다.
프로토콜이 지정되지 않은 경우 https
가정됩니다.
function setDomain(domain: string)
매개 변수
- domain
-
string
새 기본 도메인입니다.
setLanguage(string)
API의 해당 부분을 사용할 때 언어를 명시적으로 지정하지 않는 한 지도 및 서비스 모듈에서 사용하는 기본 언어를 설정합니다. 맵이 명시적으로 정의된 언어로 초기화되고 setLanguage가 이전에 호출되지 않은 경우 지도 생성자가 자동으로 호출합니다.
function setLanguage(language: string)
매개 변수
- language
-
string
새 기본 언어입니다.
setMaxParallelImageRequests(number)
래스터가 많은 맵의 성능에 영향을 미치는 최대 이미지 수(래스터 타일, 스프라이트, 아이콘)를 병렬로 로드하도록 설정합니다. 기본적으로 16.
function setMaxParallelImageRequests(maxParallelImageRequests: number)
매개 변수
- maxParallelImageRequests
-
number
병렬로 로드할 최대 이미지 수입니다.
setSessionId(string)
API의 해당 부분을 사용할 때 세션 ID를 명시적으로 지정하지 않는 한 맵 및 서비스 모듈에서 사용하는 기본 세션 ID를 설정합니다. 맵이 명시적으로 정의된 세션 ID로 초기화되고 setSessionId가 이전에 호출되지 않은 경우 Map 생성자가 자동으로 호출합니다.
function setSessionId(id: string)
매개 변수
- id
-
string
새 기본 세션 ID입니다.
setSubscriptionKey(string)
Azure Maps 구독 키를 지도 컨트롤 및 Azure Maps 서비스에 대한 요청을 만드는 모든 모듈에서 사용하는 atlas 네임스페이스의 기본 구독 키로 설정합니다. 맵이 명시적으로 정의된 구독 키로 초기화되고 setSubscriptionKey가 이전에 호출되지 않은 경우 지도 생성자가 자동으로 호출합니다.
function setSubscriptionKey(key: string)
매개 변수
- key
-
string
새 기본 구독 키입니다.
setUserRegion(string)
경고
이 API는 이제 사용되지 않습니다.
use atlas.setView(view: string) instead.
function setUserRegion(userRegion: string)
매개 변수
- userRegion
-
string
setView(string)
지도에 표시되는 지정학적으로 분쟁이 있는 테두리 및 레이블 집합을 지정합니다. View 매개 변수("사용자 지역 매개 변수"라고도 함)는 해당 국가/지역에 대한 올바른 맵을 표시하는 2자 ISO-3166 국가 코드입니다. 보기 목록에 없거나 지정되지 않은 경우 국가/지역은 기본적으로 "통합" 보기로 설정됩니다. 지원되는 [보기]{@link https://aka.ms/AzureMapsLocalizationViews }를 참조하세요. 사용자의 위치를 확인한 다음 해당 위치에 대해 View 매개 변수를 올바르게 설정하는 것은 사용자의 책임입니다. Azure Maps의 View 매개 변수는 Azure Maps를 통해 액세스할 수 있는 권한이 있는 지도, 이미지 및 기타 데이터 및 타사 콘텐츠를 사용할 수 있는 국가/지역의 매핑과 관련된 법률을 포함하여 관련 법률을 준수하는 데 사용해야 합니다.
function setView(view: string)
매개 변수
- view
-
string
새 기본 보기
setWorkerCount(number)
페이지에서 인스턴스화된 웹 작업자 수를 설정합니다. 기본적으로 CPU 코어 수의 절반으로 설정됩니다(6으로 제한됨).
function setWorkerCount(workerCount: number)
매개 변수
- workerCount
-
number
작업자 수입니다.