Word Cloud

values

[단어, 가중치] 또는 { name, weight } 배열입니다.

• WordCloudValues

  타입 정의

width

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

height

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

brandLogo

기본값은 Syidax 심볼과 워드마크입니다. Pro의 chart.branding 권한으로 none을 지정해 제거하거나 PNG·JPEG·WebP data URL로 교체할 수 있습니다.

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

brandPosition

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

palette

허용값: tableau10, tableau20, observable10, paired12, set3_12. 기본값: 'tableau10'.

• WordCloudPaletteName

  타입 정의

colors

JavaScript 프로퍼티로 전달합니다. 타입: ReadonlyArray<string>.

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

minFontSize

Smallest rendered font in px (Highcharts minFontSize).

maxFontSize

Font of the heaviest word in px (Highcharts maxFontSize).

weightScale

가중치를 크기로 변환하는 척도입니다.

• WordCloudWeightScale

  타입 정의

spiral

Spiral search pattern; rectangular = Highcharts default.

• WordCloudSpiral

  타입 정의

orientations

Number of distinct orientations in the rotation cycle (Highcharts rotation.orientations).

rotationFrom

Rotation cycle start in degrees (Highcharts rotation.from).

rotationTo

Rotation cycle end in degrees (Highcharts rotation.to).

wordPadding

Empty px kept between word boxes.

fontFamily

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

fontWeight

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

chartTitle

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

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

chartSubtitle

차트 내부 부제목입니다.

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

tooltipShow

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

tooltipFormat

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

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

• WordCloudResolvedWord

  타입 정의

tooltip

Rich tooltip configuration object — the word-flavoured counterpart of the item .tooltip API (trigger/openMode/connector/draggable/interactive/ format/html/style/side/sizing). When set it wins over the flat tooltip-show / tooltipFormat props. Property-only.

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

• WordCloudTooltipInput

  타입 정의

enableMouseTracking

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

zoom

Viewport zoom — the zoom attribute the cartesian charts carry: a mode ('x' | 'y' | 'xy'), true (x) or an object; off by default. The drawing rectangle (the cloud below the title band) is the plot — x runs 0 → 1 left to right, y 0 → 1 bottom to top — and the words are magnified into the window; words outside it leave the rectangle. Property-only (a mode string also works as an attribute).

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

• CartesianZoomInput

  타입 정의

engine

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

• WordCloudEngineMode

  타입 정의

unavailable

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

• WordCloudUnavailableBehaviour

  타입 정의

streamSource

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

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

• WordCloudStreamSource

  타입 정의

streamWindow

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

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

streamMax

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

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

animated

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

animationDuration

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

animationEasing

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

• WordCloudEasing

  타입 정의

animationType

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

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

• WordCloudAnimationType

  타입 정의

rendered

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

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

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

• WordCloudRenderResult

  타입 정의

• WordCloudEngineTier

  타입 정의

pointClick

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

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

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

• WordCloudPointEventDetail

  타입 정의

pointHover

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

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

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

• WordCloudPointEventDetail

  타입 정의

pointContextMenu

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

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

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

• ChartPointContextMenuEventDetail

  타입 정의

• WordCloudPointEventDetail

  타입 정의

appended

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

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

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

windowSlid

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

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

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

chartAnimationStart

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

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

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

chartAnimationEnd

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

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

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

chartAnimationInterrupted

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

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

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

tooltipShow

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

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

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

• WordCloudTooltipShowEventDetail

  타입 정의

tooltipHide

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

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

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

tooltipAction

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

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

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

• WordCloudTooltipActionEventDetail

  타입 정의

zoomChange

Every zoom / pan change (drag, pan, wheel, pinch, keyboard, API, reset).

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

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

• CartesianZoomChangeEventDetail

  타입 정의

redraw

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

redraw(): Promise<WordCloudRenderResult>

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

• WordCloudRenderResult

  타입 정의

getActiveTier

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

getActiveTier(): Promise<WordCloudEngineTier>

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

• WordCloudEngineTier

  타입 정의

addWord

Word-cloud-only — add a word datum.

addWord(datum: WordCloudDatum, opts?: { insertAt?: number }): Promise<number>

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

• WordCloudDatum

  타입 정의

removeWord

Word-cloud-only — remove a word by id, name, or index.

removeWord(idOrIndex: string | number): Promise<boolean>

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

updateWord

Word-cloud-only — patch a word's datum fields.

updateWord(idOrIndex: string | number, patch: Partial<Exclude<WordCloudDatum, readonly [string, number]>>): Promise<boolean>

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

• WordCloudDatum

  타입 정의

setWordWeight

Word-cloud-only — set a word's weight.

setWordWeight(idOrIndex: string | number, weight: number): Promise<boolean>

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

appendPoint

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

appendPoint(datum: WordCloudDatum): Promise<void>

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

• WordCloudDatum

  타입 정의

appendBatch

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

appendBatch(datums: ReadonlyArray<WordCloudDatum>): Promise<void>

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

• WordCloudDatum

  타입 정의

shift

Drops the LIGHTEST words (a cloud has no timeline; "oldest" is meaningless).

shift(count?: number): Promise<void>

반환 타입: 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).

replace(datums: ReadonlyArray<WordCloudDatum>): Promise<void>

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

• WordCloudDatum

  타입 정의

getStreamSource

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

getStreamSource(): Promise<WordCloudStreamSource | undefined>

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

• WordCloudStreamSource

  타입 정의

setAnimation

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

setAnimation(options: { duration?: number; easing?: WordCloudEasing; enabled?: boolean; type?: WordCloudAnimationType }): Promise<void>

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

• WordCloudEasing

  타입 정의

• WordCloudAnimationType

  타입 정의

pauseAnimation

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

pauseAnimation(): Promise<void>

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

resumeAnimation

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

resumeAnimation(): Promise<void>

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

replayAnimation

Replay the initial staggered reveal. No-op when animation is off.

replayAnimation(): Promise<void>

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

hitTestWord

The word under a host px position (the zoomed view is honoured: the point is taken back to the layout first).

hitTestWord(cssX: number, cssY: number): Promise<{ index: number; id: string; name: string } | null>

반환 타입: Promise<{ index: number; id: string; name: string } | null>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

getDroppedWords

Words the spiral could not fit (diagnostics parity with the layout core).

getDroppedWords(): Promise<Array<{ index: number; id: string; name: string; weight: number }>>

반환 타입: Promise<Array<{ index: number; id: string; name: string; weight: number }>>. 요소 등록이 끝난 뒤 메서드를 호출하고 Promise 결과를 await로 기다리세요.

showTooltipAtWord

Word-cloud-only — programmatic tooltip open on a word.

showTooltipAtWord(idOrIndex: string | number): Promise<WordCloudPointEventDetail | null>

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

• WordCloudPointEventDetail

  타입 정의

hideTooltip

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

hideTooltip(): Promise<void>

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

zoomTo

Zoom to explicit windows of the drawing (x / y as { min, max } or [min, max] over 0..1; null clears that orientation).

zoomTo(request: CartesianZoomRequest): Promise<CartesianZoomChangeEventDetail | null>

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

• CartesianZoomChangeEventDetail

  타입 정의

• CartesianZoomRequest

  타입 정의

zoomBy

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

zoomBy(factor: number, anchorFraction?: number): Promise<CartesianZoomChangeEventDetail | null>

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

• CartesianZoomChangeEventDetail

  타입 정의

panBy

Slide the zoomed windows by a fraction of the drawing ({ x?, y? }); a no-op at the full extent.

panBy(delta: { x?: number; y?: number }): Promise<CartesianZoomChangeEventDetail | null>

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

• CartesianZoomChangeEventDetail

  타입 정의

resetZoom

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

resetZoom(): Promise<CartesianZoomChangeEventDetail | null>

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

• CartesianZoomChangeEventDetail

  타입 정의

getZoom

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

getZoom(): Promise<CartesianZoomState | null>

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

• CartesianZoomState

  타입 정의

getZoomExtent

The full extent of the drawing (0..1 on both orientations, the id-less slot key).

getZoomExtent(request?: CartesianZoomExtentRequest): Promise<CartesianZoomExtentDetail | null>

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

• CartesianZoomExtentDetail

  타입 정의

• CartesianZoomExtentRequest

  타입 정의

getEngineStatus

Requested engine vs what runs, and why (CHART-ADD-08): always Standard (this type has no WebGPU renderer); read without side effects, never consults the license.

getEngineStatus(): Promise<ChartEngineStatus>

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

• ChartEngineStatus

  타입 정의