sy-flow-lines

Flow Lines

지도 위에서 거점 사이의 이동을 연결합니다.

sy-flow-lines

물류·노선·지역 간 이동량을 살펴보세요.

대권 경로와 투영 평면의 직선은 다릅니다. 연결량과 실제 이동 경로를 구분해 설명하세요.

기본 차트 등급: Pro. 추가 렌더러·커스텀 브랜딩 등 기능의 권한은 별도입니다.

입력데이터 설명
datalocations의 id를 flows의 from·to가 참조합니다.
routePathgreat-circle 또는 straight 경로입니다.

전체 적용 예제

html
<div id="chart-container" style="width: 100%; min-width: 0;"></div>

<script type="module">
  import { defineCustomElement as define0 } from '@syidax/advanced-pro/components/sy-flow-lines.js';
  define0();

  // Pro: 앱 시작 시 발급받은 인증서로 registerLicense를 완료하세요.
  // 홈페이지 미리보기의 인증서는 고객 앱에서 사용하지 않습니다.
  const specs = [
    {
      "id": "example-chart",
      "tag": "sy-flow-lines",
      "props": {
        "data": {
          "locations": [
            {
              "id": "seoul",
              "label": "서울",
              "longitude": 126.98,
              "latitude": 37.57
            },
            {
              "id": "tokyo",
              "label": "도쿄",
              "longitude": 139.69,
              "latitude": 35.68
            },
            {
              "id": "taipei",
              "label": "타이베이",
              "longitude": 121.56,
              "latitude": 25.03
            },
            {
              "id": "singapore",
              "label": "싱가포르",
              "longitude": 103.82,
              "latitude": 1.35
            }
          ],
          "flows": [
            {
              "id": "s-t",
              "from": "seoul",
              "to": "tokyo",
              "value": 80
            },
            {
              "id": "s-p",
              "from": "seoul",
              "to": "taipei",
              "value": 45
            },
            {
              "id": "p-s",
              "from": "taipei",
              "to": "singapore",
              "value": 30
            }
          ]
        },
        "mapRegion": "asia",
        "mapBackground": "natural-earth",
        "routePath": "great-circle",
        "locationLabels": "show",
        "width": 640,
        "height": 360,
        "brandPosition": "bottom-right",
        "brandLogo": ""
      }
    }
  ];
  const container = document.querySelector('#chart-container');
  const elements = specs.map(({ tag, id, props }) => {
    const element = document.createElement(tag);
    element.id = id;
    Object.assign(element, props);
    element.setAttribute('aria-label', 'flow-lines 예제 차트');
    return element;
  });
  container.replaceChildren(...elements);
  const chart = elements.at(-1);
  const onEvent = event => {
    console.log('pointClick', event.detail);
  };
  chart.addEventListener('pointClick', onEvent);
  const observer = new ResizeObserver(([entry]) => {
    const width = Math.max(160, Math.floor(entry.contentRect.width));
    elements.forEach(element => { element.width = width; });
  });
  observer.observe(container);

  // SPA에서는 화면이 해제될 때 이 함수를 호출하세요.
  function disposeChart() {
    observer.disconnect();
    chart.removeEventListener('pointClick', onEvent);
    container.replaceChildren();
  }
</script>

Properties

data

locations의 id를 flows의 from·to가 참조합니다.

항목값
JavaScript 프로퍼티data
HTML attribute객체·배열·콜백은 JavaScript 프로퍼티로 전달
타입FlowLinesData
기본값undefined

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

width

차트의 너비를 px 단위로 지정합니다. 컨테이너 너비가 변하는 앱에서는 ResizeObserver에서 width를 갱신하세요.

항목값
JavaScript 프로퍼티width
HTML attributewidth
타입number
기본값900

height

차트의 높이를 px 단위로 지정합니다. 축, 제목과 범례가 차지하는 공간을 함께 고려하세요.

항목값
JavaScript 프로퍼티height
HTML attributeheight
타입number
기본값460

brandPosition

로고를 고정할 코너입니다. Community·Pro 모두 네 코너 중 하나를 선택할 수 있으며 화면과 이미지 내보내기에 같은 위치를 사용합니다.

항목값
JavaScript 프로퍼티brandPosition
HTML attributebrand-position
타입'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'
기본값'bottom-right'
허용값top-left, top-right, bottom-left, bottom-right

padding

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.

항목값
JavaScript 프로퍼티padding
HTML attributepadding
타입number
기본값16

projection

허용값: identity, mercator, equirectangular, albers, orthographic. 기본값: 'equirectangular'.

항목값
JavaScript 프로퍼티projection
HTML attribute객체·배열·콜백은 JavaScript 프로퍼티로 전달
타입GeoMapProjection
기본값'equirectangular'
타입에 포함된 리터럴identity, mercator, equirectangular, albers, orthographic

mapRegion

허용값: world, africa, asia, europe, north-america, south-america, oceania, antarctica. 기본값: 'world'.

항목값
JavaScript 프로퍼티mapRegion
HTML attributemap-region
타입GeoMapRegion
기본값'world'
허용값world, africa, asia, europe, north-america, south-america, oceania, antarctica

mapBackground

허용값: none, natural-earth. 기본값: 'natural-earth'.

항목값
JavaScript 프로퍼티mapBackground
HTML attributemap-background
타입GeoMapBackground
기본값'natural-earth'
허용값none, natural-earth

mapFixed

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.

항목값
JavaScript 프로퍼티mapFixed
HTML attributemap-fixed
타입boolean
기본값false

routePath

great-circle 또는 straight 경로입니다.

항목값
JavaScript 프로퍼티routePath
HTML attributeroute-path
타입GeoMapConnectionPath
기본값'great-circle'
허용값great-circle, straight

styleOptions

JavaScript 프로퍼티로 전달합니다. 타입: FlowLinesStyle.

항목값
JavaScript 프로퍼티styleOptions
HTML attribute객체·배열·콜백은 JavaScript 프로퍼티로 전달
타입FlowLinesStyle
기본값undefined

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

locationLabels

허용값: auto, show, hide. 기본값: 'auto'.

항목값
JavaScript 프로퍼티locationLabels
HTML attributelocation-labels
타입GeoMapLabelMode
기본값'auto'
허용값auto, show, hide

flowLabels

허용값: auto, show, hide. 기본값: 'hide'.

항목값
JavaScript 프로퍼티flowLabels
HTML attributeflow-labels
타입GeoMapLabelMode
기본값'hide'
허용값auto, show, hide

labelValue

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.

항목값
JavaScript 프로퍼티labelValue
HTML attributelabel-value
타입boolean
기본값false

mapLayers

JavaScript 프로퍼티로 전달합니다. 타입: GeoMapLayersInput.

항목값
JavaScript 프로퍼티mapLayers
HTML attribute객체·배열·콜백은 JavaScript 프로퍼티로 전달
타입GeoMapLayersInput
기본값undefined

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

legend

시리즈 또는 항목의 범례 표시 여부입니다.

항목값
JavaScript 프로퍼티legend
HTML attributelegend
타입boolean
기본값true

activeColor

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string.

항목값
JavaScript 프로퍼티activeColor
HTML attributeactive-color
타입string
기본값'#f59e0b'

inactiveOtherPoints

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.

항목값
JavaScript 프로퍼티inactiveOtherPoints
HTML attributeinactive-other-points
타입boolean
기본값false

inactivePointOpacity

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.

항목값
JavaScript 프로퍼티inactivePointOpacity
HTML attributeinactive-point-opacity
타입number
기본값.2

chartTitle

차트 내부 제목입니다. 데이터의 단위와 의미를 함께 설명하세요.

항목값
JavaScript 프로퍼티chartTitle
HTML attributechart-title
타입string
기본값undefined

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

chartSubtitle

차트 내부 부제목입니다.

항목값
JavaScript 프로퍼티chartSubtitle
HTML attributechart-subtitle
타입string
기본값undefined

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

locale

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: string.

항목값
JavaScript 프로퍼티locale
HTML attributelocale
타입string
기본값'en-US'

enableMouseTracking

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.

항목값
JavaScript 프로퍼티enableMouseTracking
HTML attributeenable-mouse-tracking
타입boolean
기본값true

tooltip

포인터에 따라 표시할 값, 위치, 내용의 툴팁 설정입니다.

항목값
JavaScript 프로퍼티tooltip
HTML attribute객체·배열·콜백은 JavaScript 프로퍼티로 전달
타입CartesianTooltipInput
기본값undefined
타입에 포함된 리터럴auto, off

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

tooltipEnabled

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.

항목값
JavaScript 프로퍼티tooltipEnabled
HTML attributetooltip-show
타입boolean
기본값true

tooltipFormat

JavaScript 프로퍼티로 전달합니다. 타입: (detail:FlowLinesHitDetail)=>string.

항목값
JavaScript 프로퍼티tooltipFormat
HTML attribute객체·배열·콜백은 JavaScript 프로퍼티로 전달
타입(detail:FlowLinesHitDetail)=>string
기본값undefined

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

crosshair

JavaScript 프로퍼티로 전달합니다. 타입: CartesianCrosshairInput.

항목값
JavaScript 프로퍼티crosshair
HTML attribute객체·배열·콜백은 JavaScript 프로퍼티로 전달
타입CartesianCrosshairInput
기본값undefined

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

crosshairSnapDistance

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: number.

항목값
JavaScript 프로퍼티crosshairSnapDistance
HTML attributecrosshair-snap-distance
타입number
기본값12

zoom

확대·축소와 표시 범위의 동작 설정입니다.

항목값
JavaScript 프로퍼티zoom
HTML attribute객체·배열·콜백은 JavaScript 프로퍼티로 전달
타입CartesianZoomInput
기본값undefined
타입에 포함된 리터럴auto, off, true, false, x, y, xy, inside

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

animated

초기 표시와 데이터 변경의 애니메이션 사용 여부입니다.

항목값
JavaScript 프로퍼티animated
HTML attributeanimate
타입boolean
기본값false

animationDuration

애니메이션 지속 시간(ms).

항목값
JavaScript 프로퍼티animationDuration
HTML attributeanimation-duration
타입number
기본값600

animationEasing

허용값: linear, ease-out, ease-in, ease-in-out. 기본값: 'ease-out'.

항목값
JavaScript 프로퍼티animationEasing
HTML attributeanimation-easing
타입GeoMapEasing
기본값'ease-out'
허용값linear, ease-out, ease-in, ease-in-out

animationType

허용값: initial, update. 기본값: undefined.

항목값
JavaScript 프로퍼티animationType
HTML attributeanimation-type
타입GeoMapAnimationType
기본값undefined
허용값initial, update

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

streamSource

실시간 데이터를 전달하는 스트림 소스입니다. 해당 타입의 계약을 확인하세요.

항목값
JavaScript 프로퍼티streamSource
HTML attribute객체·배열·콜백은 JavaScript 프로퍼티로 전달
타입FlowLinesStreamSource
기본값undefined

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

streamMax

보관할 스트리밍 데이터의 최대 수입니다.

항목값
JavaScript 프로퍼티streamMax
HTML attributestream-max
타입number
기본값undefined

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

streamWindow

화면에 유지할 스트리밍 데이터 구간입니다.

항목값
JavaScript 프로퍼티streamWindow
HTML attributestream-window
타입number
기본값undefined

undefined는 이 속성을 명시하지 않은 상태입니다. 실제 표시 값은 차트 종류와 다른 설정에 따라 결정될 수 있습니다.

engine

auto·standard·pro 렌더러 선택입니다. 엔진 선택은 차트 종류의 Pro 사용 권한과 별개입니다.

항목값
JavaScript 프로퍼티engine
HTML attributeengine
타입GeoMapEngineMode
기본값'auto'
허용값auto, standard, pro

unavailable

허용값: fallback, error. 기본값: 'fallback'.

항목값
JavaScript 프로퍼티unavailable
HTML attributeunavailable
타입GeoMapUnavailableBehaviour
기본값'fallback'
허용값fallback, error

showEmpty

HTML attribute 또는 JavaScript 프로퍼티로 설정합니다. 타입: boolean.

항목값
JavaScript 프로퍼티showEmpty
HTML attributeshow-empty
타입boolean
기본값true

Events

pointClick

점 선택 이벤트입니다. CustomEvent.detail에서 선택한 데이터와 인덱스를 읽습니다.

이벤트 이름: pointClick. 대소문자를 구분합니다. payload는 CustomEvent<FlowLinesHitDetail>의 detail에서 읽습니다.

javascript
chart.addEventListener('pointClick', event => {
  console.log(event.detail); // FlowLinesHitDetail
});

pointHover

CustomEvent.detail 타입: FlowLinesHitDetail|null. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: pointHover. 대소문자를 구분합니다. payload는 CustomEvent<FlowLinesHitDetail|null>의 detail에서 읽습니다.

javascript
chart.addEventListener('pointHover', event => {
  console.log(event.detail); // FlowLinesHitDetail|null
});

selectionChanged

CustomEvent.detail 타입: FlowLinesSelectionChangeEventDetail. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: selectionChanged. 대소문자를 구분합니다. payload는 CustomEvent<FlowLinesSelectionChangeEventDetail>의 detail에서 읽습니다.

javascript
chart.addEventListener('selectionChanged', event => {
  console.log(event.detail); // FlowLinesSelectionChangeEventDetail
});

pointContextMenu

CustomEvent.detail 타입: ChartPointContextMenuEventDetail<FlowLinesHitDetail>. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: pointContextMenu. 대소문자를 구분합니다. payload는 CustomEvent<ChartPointContextMenuEventDetail<FlowLinesHitDetail>>의 detail에서 읽습니다.

javascript
chart.addEventListener('pointContextMenu', event => {
  console.log(event.detail); // ChartPointContextMenuEventDetail<FlowLinesHitDetail>
});

rendered

차트 그리기가 완료되면 렌더링 결과를 detail로 전달합니다.

이벤트 이름: rendered. 대소문자를 구분합니다. payload는 CustomEvent<FlowLinesRenderResult&{tier:GeoMapEngineTier}>의 detail에서 읽습니다.

javascript
chart.addEventListener('rendered', event => {
  console.log(event.detail); // FlowLinesRenderResult&{tier:GeoMapEngineTier}
});

appended

CustomEvent.detail 타입: {count:number;replaced:number}. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: appended. 대소문자를 구분합니다. payload는 CustomEvent<{count:number;replaced:number}>의 detail에서 읽습니다.

javascript
chart.addEventListener('appended', event => {
  console.log(event.detail); // {count:number;replaced:number}
});

windowSlid

CustomEvent.detail 타입: {dropped:number}. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: windowSlid. 대소문자를 구분합니다. payload는 CustomEvent<{dropped:number}>의 detail에서 읽습니다.

javascript
chart.addEventListener('windowSlid', event => {
  console.log(event.detail); // {dropped:number}
});

dataValidationError

CustomEvent.detail 타입: {message:string;source:'data'|'stream'}. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: dataValidationError. 대소문자를 구분합니다. payload는 CustomEvent<{message:string;source:'data'|'stream'}>의 detail에서 읽습니다.

javascript
chart.addEventListener('dataValidationError', event => {
  console.log(event.detail); // {message:string;source:'data'|'stream'}
});

tooltipShow

내장 툴팁 표시 여부입니다.

이벤트 이름: tooltipShow. 대소문자를 구분합니다. payload는 CustomEvent<CartesianTooltipEventDetail>의 detail에서 읽습니다.

javascript
chart.addEventListener('tooltipShow', event => {
  console.log(event.detail); // CartesianTooltipEventDetail
});

tooltipHide

CustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: tooltipHide. 대소문자를 구분합니다. payload는 CustomEvent<void>의 detail에서 읽습니다.

javascript
chart.addEventListener('tooltipHide', event => {
  console.log(event.detail); // void
});

tooltipAction

CustomEvent.detail 타입: CartesianTooltipActionEventDetail. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: tooltipAction. 대소문자를 구분합니다. payload는 CustomEvent<CartesianTooltipActionEventDetail>의 detail에서 읽습니다.

javascript
chart.addEventListener('tooltipAction', event => {
  console.log(event.detail); // CartesianTooltipActionEventDetail
});

crosshairMove

CustomEvent.detail 타입: CartesianCrosshairEventDetail|null. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: crosshairMove. 대소문자를 구분합니다. payload는 CustomEvent<CartesianCrosshairEventDetail|null>의 detail에서 읽습니다.

javascript
chart.addEventListener('crosshairMove', event => {
  console.log(event.detail); // CartesianCrosshairEventDetail|null
});

zoomChange

CustomEvent.detail 타입: CartesianZoomChangeEventDetail. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: zoomChange. 대소문자를 구분합니다. payload는 CustomEvent<CartesianZoomChangeEventDetail>의 detail에서 읽습니다.

javascript
chart.addEventListener('zoomChange', event => {
  console.log(event.detail); // CartesianZoomChangeEventDetail
});

mapViewChange

CustomEvent.detail 타입: GeoMapViewChangeEventDetail. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: mapViewChange. 대소문자를 구분합니다. payload는 CustomEvent<GeoMapViewChangeEventDetail>의 detail에서 읽습니다.

javascript
chart.addEventListener('mapViewChange', event => {
  console.log(event.detail); // GeoMapViewChangeEventDetail
});

mapLayerChange

CustomEvent.detail 타입: GeoMapLayerChangeEventDetail. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: mapLayerChange. 대소문자를 구분합니다. payload는 CustomEvent<GeoMapLayerChangeEventDetail>의 detail에서 읽습니다.

javascript
chart.addEventListener('mapLayerChange', event => {
  console.log(event.detail); // GeoMapLayerChangeEventDetail
});

chartAnimationStart

CustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: chartAnimationStart. 대소문자를 구분합니다. payload는 CustomEvent<void>의 detail에서 읽습니다.

javascript
chart.addEventListener('chartAnimationStart', event => {
  console.log(event.detail); // void
});

chartAnimationEnd

CustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: chartAnimationEnd. 대소문자를 구분합니다. payload는 CustomEvent<void>의 detail에서 읽습니다.

javascript
chart.addEventListener('chartAnimationEnd', event => {
  console.log(event.detail); // void
});

chartAnimationInterrupted

CustomEvent.detail 타입: void. 이벤트 이름은 대소문자를 구분합니다.

이벤트 이름: chartAnimationInterrupted. 대소문자를 구분합니다. payload는 CustomEvent<void>의 detail에서 읽습니다.

javascript
chart.addEventListener('chartAnimationInterrupted', event => {
  console.log(event.detail); // void
});

Methods

setData

Replace the bar set.

typescript
setData(data: FlowLinesData): Promise<void>
인수타입필수 여부
dataFlowLinesData필수

반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

getData

비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.

typescript
getData(): Promise<FlowLinesData>

반환 타입: Promise<FlowLinesData>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

getDiagnostics

Normalization diagnostics for the effective base and stream source.

typescript
getDiagnostics(): Promise<FlowLinesDiagnostics>

반환 타입: Promise<FlowLinesDiagnostics>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

getLayout

Host-local geometry as shown. Scale fields preserve ellipses under non-uniform viewport zoom.

typescript
getLayout(): Promise<FlowLinesLayout>

반환 타입: Promise<FlowLinesLayout>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

appendPoint

스트림에 값 하나를 추가합니다. 메서드 인수 타입과 스트리밍 기능의 라이선스 조건을 확인하세요.

typescript
appendPoint(flow: FlowLinesRouteInput): Promise<void>
인수타입필수 여부
flowFlowLinesRouteInput필수

반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

appendBatch

스트림에 여러 값을 한 번에 추가합니다. 메서드 인수 타입과 스트리밍 기능의 라이선스 조건을 확인하세요.

typescript
appendBatch(flows: ReadonlyArray<FlowLinesRouteInput>): Promise<void>
인수타입필수 여부
flowsReadonlyArray<FlowLinesRouteInput>필수

반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

replace

Swap the streamed set (replace([]) clears it); the base values never leave. Without chart.streaming the dies upsert into the base like a batch (quietly: no appended, no binChanged, as a ring replace).

typescript
replace(flows: ReadonlyArray<FlowLinesRouteInput>): Promise<void>
인수타입필수 여부
flowsReadonlyArray<FlowLinesRouteInput>필수

반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

shift

Drop the oldest streamed categories (the data boxes are not the stream).

typescript
shift(count: number): Promise<void>
인수타입필수 여부
countnumber필수

반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

getStreamSource

The stream session's source (Chart Pro): like the stream methods it waits for a license still being confirmed.

typescript
getStreamSource(): Promise<FlowLinesStreamSource|undefined>

반환 타입: Promise<FlowLinesStreamSource|undefined>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

clearStream

비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.

typescript
clearStream(): Promise<void>

반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

hitTest

The box under a host-local CSS point (the nearest slot, within half a pitch), or null.

typescript
hitTest(cssX: number, cssY: number): Promise<FlowLinesHitDetail|null>
인수타입필수 여부
cssXnumber필수
cssYnumber필수

반환 타입: Promise<FlowLinesHitDetail|null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

selectFlowAt

비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.

typescript
selectFlowAt(index: number): Promise<FlowLinesHitDetail|null>
인수타입필수 여부
indexnumber필수

반환 타입: Promise<FlowLinesHitDetail|null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

selectLocationAt

비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.

typescript
selectLocationAt(index: number): Promise<FlowLinesHitDetail|null>
인수타입필수 여부
indexnumber필수

반환 타입: Promise<FlowLinesHitDetail|null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

selectById

비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.

typescript
selectById(id: FlowLinesId, kind?: 'flow'|'location'): Promise<FlowLinesHitDetail|null>
인수타입필수 여부
idFlowLinesId필수
kind'flow'|'location'선택

반환 타입: Promise<FlowLinesHitDetail|null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

getSelection

The selection: the selected node's / link's detail (null = none); its anchors are Pro-derived, refused without a valid license.

typescript
getSelection(): Promise<FlowLinesSelection>

반환 타입: Promise<FlowLinesSelection>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

clearSelection

Release the selection (emits selectionChanged when there was one).

typescript
clearSelection(): Promise<void>

반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

showTooltipAtFlow

비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.

typescript
showTooltipAtFlow(index: number): Promise<CartesianTooltipEventDetail|null>
인수타입필수 여부
indexnumber필수

반환 타입: Promise<CartesianTooltipEventDetail|null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

showTooltipAtLocation

비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.

typescript
showTooltipAtLocation(index: number): Promise<CartesianTooltipEventDetail|null>
인수타입필수 여부
indexnumber필수

반환 타입: Promise<CartesianTooltipEventDetail|null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

hideTooltip

현재 표시 중인 툴팁을 닫습니다.

typescript
hideTooltip(): Promise<void>

반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

showCrosshairAtData

Quiet source-category synchronization. Categories retain their original string or number type.

typescript
showCrosshairAtData(request: {dataX:number;dataY:number}): Promise<boolean>
인수타입필수 여부
request{dataX:number;dataY:number}필수

반환 타입: Promise<boolean>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

hideCrosshair

hide the crosshair shown by showCrosshairAt (or the pointer's).

typescript
hideCrosshair(): Promise<void>

반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

zoomTo

zoom to explicit windows: x / y as { min, max } or [min, max] (null clears that orientation); xAxis / yAxis name the axis by id or slot index (default: the primary axis).

typescript
zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail|null>
인수타입필수 여부
requestCartesianZoomRequest필수

반환 타입: Promise<CartesianZoomChangeEventDetail|null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

zoomBy

scale the current windows by factor (< 1 zooms in) around anchorFraction (0..1, default centre).

typescript
zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail|null>
인수타입필수 여부
factornumber필수
anchorFractionnumber선택

반환 타입: Promise<CartesianZoomChangeEventDetail|null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

panBy

slide the zoomed windows by data units ({ x?, y? }); a no-op at the full extent.

typescript
panBy(delta: {x?:number;y?:number}): Promise<CartesianZoomChangeEventDetail|null>
인수타입필수 여부
delta{x?:number;y?:number}필수

반환 타입: Promise<CartesianZoomChangeEventDetail|null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

resetZoom

확대·이동한 범위를 초기 데이터 범위로 되돌립니다.

typescript
resetZoom(): Promise<CartesianZoomChangeEventDetail|null>

반환 타입: Promise<CartesianZoomChangeEventDetail|null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

resetMapView

Restore the configured projection/region and clear map movement and zoom.

typescript
resetMapView(): Promise<void>

반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

getZoom

현재 확대 범위를 읽습니다. 반환 타입의 null 허용 여부와 축별 범위를 확인하세요.

typescript
getZoom(): Promise<CartesianZoomState|null>

반환 타입: Promise<CartesianZoomState|null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

getZoomExtent

the full extent (and key) of the primary — or the named — master axes (null before the first layout).

typescript
getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail|null>
인수타입필수 여부
requestCartesianZoomExtentRequest선택

반환 타입: Promise<CartesianZoomExtentDetail|null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

getMapView

Owned geographic camera, effective region and viewport state.

typescript
getMapView(): Promise<GeoMapViewDetail|null>

반환 타입: Promise<GeoMapViewDetail|null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

fitMap

Fit current point/feature geometry with a uniform scale. Empty candidates leave the view unchanged.

typescript
fitMap(options?: GeoMapFitOptions): Promise<GeoMapFitDetail|null>
인수타입필수 여부
optionsGeoMapFitOptions선택

반환 타입: Promise<GeoMapFitDetail|null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

getMapLayers

비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.

typescript
getMapLayers(): Promise<GeoMapLayerDetail[]>

반환 타입: Promise<GeoMapLayerDetail[]>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

setMapLayerVisible

Immediately mask a layer without restarting active animations, rescaling or reframing. Unknown keys return null.

typescript
setMapLayerVisible(layer: GeoMapLayer, visible: boolean): Promise<GeoMapLayerDetail|null>
인수타입필수 여부
layerGeoMapLayer필수
visibleboolean필수

반환 타입: Promise<GeoMapLayerDetail|null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

setAnimation

비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.

typescript
setAnimation(options: {enabled?:boolean;duration?:number;easing?:GeoMapEasing;type?:GeoMapAnimationType}): Promise<void>
인수타입필수 여부
options{enabled?:boolean;duration?:number;easing?:GeoMapEasing;type?:GeoMapAnimationType}필수

반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

pauseAnimation

진행 중인 애니메이션을 일시 정지합니다.

typescript
pauseAnimation(): Promise<void>

반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

resumeAnimation

일시 정지한 애니메이션을 다시 진행합니다.

typescript
resumeAnimation(): Promise<void>

반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

replayAnimation

Replay the initial sweep from min → value(s). No-op when animation is off / reduced.

typescript
replayAnimation(): Promise<void>

반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

recycleGpu

Without this element's grant (or while it is frozen) nothing is recycled: the refusal is reported here and no GPU work starts.

typescript
recycleGpu(): Promise<void>

반환 타입: Promise<void>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

redraw

현재 데이터와 옵션으로 차트를 다시 그립니다. 반환되는 Promise가 완료되면 렌더링 결과를 확인할 수 있습니다.

typescript
redraw(): Promise<FlowLinesRenderResult>

반환 타입: Promise<FlowLinesRenderResult>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

getEngineStatus

The inner map's status while the proxy runs; otherwise the proxy's own license outcome (engine is forwarded unchanged).

typescript
getEngineStatus(): Promise<ChartEngineStatus>

반환 타입: Promise<ChartEngineStatus>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

getActiveTier

비동기 메서드입니다. 아래 인수 타입과 반환 타입을 확인하세요.

typescript
getActiveTier(): Promise<GeoMapEngineTier>

반환 타입: Promise<GeoMapEngineTier>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

getUnavailableReason

Why the WebGPU renderer could not run (the fallback notice's reason); undefined when nothing fell back.

typescript
getUnavailableReason(): Promise<string|undefined>

반환 타입: Promise<string|undefined>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

getDataTable

Current normalized table, including the retained stream; independent of GPU availability.

typescript
getDataTable(): Promise<ChartDataTable>

반환 타입: Promise<ChartDataTable>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.