WordCloudSeriesOptions extends WidgetSeriesOptions

WordCloudSeriesOptions의 기능을 사용하기 위해서는 'wordcloud'모듈이 필요하다. 자세한 설명은 guide/modules에서 확인할 수 있다.

Word cloud 시리즈.
type은 'wordcloud'이다.
빈도(weight, 또는 중용도)와 함께 지정된 단어 묶음에 포함된 단어들을 빈도에 따라 텍스트 크기를 비례적으로 표시한다. 전체 텍스트나 단어 목록 내에서 중요한 용어나 핵심 키워드, 또는 주제 등을 강조하는 용도로 사용된다. 'tag cloud'로도 불린다.
data 대신 text 속성을 지정하면 단어들을 추출해서 data를 구성한다.

data는 아래 형식들로 전달할 수 있다.

단일값 또는 단일값 배열

json 배열

Properties

autoScale: boolean (opens in a new tab)

배치된 전체 영역이 시리즈 영역보다 작은 경우 시리즈 크기에 맞게 확대한다.

default :true

center: string (opens in a new tab) | number (opens in a new tab)

centerX, centerY를 지정하지 않으면 이 속성값을 사용한다.
즉, 이 속성으로 두 속성값을 동시에 지정할 수 있다.

default :undefined

centerX: string (opens in a new tab) | number (opens in a new tab)

body 영역을 기준으로 'pie', 'funnel' 시리즈들의 수평 중심 위치
숫자나 body 영역 너비에 대한 상대값을 '%'로 지정할 수 있다.

default :'50%'

centerY: string (opens in a new tab) | number (opens in a new tab)

body 영역을 기준으로 'pie', 'funnel' 시리즈들의 수직 중심 위치
숫자나 body 영역 높이에 대한 상대값을 '%'로 지정할 수 있다.

default :'50%'

col: number (opens in a new tab)

분할 모드일 때 시리즈가 표시될 pane의 수평 index.

default :undefined

color: string (opens in a new tab) | number (opens in a new tab)

데이터 포인트 기본 색.
숫자로 지정하면 정수로 변환된 값에 해당하는 팔레트 색상으로 설정된다. 'var(--color-n)'으로 지정한 것과 동일하며, 1 ~ 12 사이의 값으로 지정한다.
pointColors나 pointStyleCallback으로 설정된 색상이 이 속성으로 설정한 색상보다 우선한다.

default :undefined

colorByPoint: boolean (opens in a new tab)

true로 지정하면 단어 마다 다른 색으로 표시한다.
색상들은 palette나 colors로 지정할 수 있다.

default :true

colorField: string (opens in a new tab)

undefined이면, data point의 값이 객체일 때 'color'.

default :undefined

data: any (opens in a new tab)

데이터포인터들을 생성하는 데 사용되는 값 목록.

default :undefined

excludes: Array (opens in a new tab)<string (opens in a new tab)>

text에서 단어를 추출할 때 제외할 단어들을 배열로 지정한다.

default :undefined

frame: 'square' | 'circle' | 'ellipse' | 'rectangle'

default :'rectangle'

hoverEffect: 'none' | 'default'

데이터포인트 hover 효과.

default :undefined

hoverStyle: SVGStyles | string (opens in a new tab)

데이터포인트 위에 마우스가 있을 때 적용되는 스타일셋 또는 css selector (opens in a new tab).

default :undefined

label: string (opens in a new tab)

이 시리즈를 나타내는 텍스트.
레전드나 툴팁에서 시리즈를 대표한다. 이 속성이 지정되지 않으면 name이 사용된다.

default :undefined

legendByPoint: boolean (opens in a new tab)

true로 지정하면 'pie', 'funnel' 시리즈들의 데이터포인트별 legend 항목을 표시한다.

default :false

loadAnimation: 'default' | 'reveal' | 'grow' | 'spread' | 'fadein'

차트 설정 로드 시 실행되는 animation 종류.

default :undefined

logBase: number (opens in a new tab)

지정한 값을 log base로 한 로그 연산으로 값들을 계산한다.
2 이상 값으로 지정해야 한다.

default :undefined

maxCount: number (opens in a new tab)

text에서 단어를 추출한 후 표시할 단어들의 최대 개수.
빈도수가 작은 단어들이 제외된다.

default :100

maxFontSize: string (opens in a new tab) | number (opens in a new tab)

가장 큰 빈도수 단어들에 설정되는 픽셀 단위의 폰트 크기.
지정한 값이 '15%' ~ '50%' 사이의 크기가 되도록 조정된다.

default :'20%'

minFontSize: string (opens in a new tab) | number (opens in a new tab)

가장 작은 빈도수 단어들에 설정되는 픽셀 단위의 폰트 크기.

default :8

minLength: number (opens in a new tab)

text에서 단어를 추출한 후 표시할 단어들의 최소 길이.
이 값 보다 작은 길이의 단어들은 표시되지 않는다.

default :undefined

minWeight: number (opens in a new tab)

text에서 단어를 추출한 후 표시할 단어들의 최소 빈도수(데이터포인트 y값).
이 값 보다 작은 빈도수를 갖는 단어들은 표시되지 않는다.

default :undefined

name: string (opens in a new tab)

시리즈 이름.
시리즈 생성시 지정된 후 변경할 수 없다. 차트의 다른 구성 요소에서 이 시리즈를 참조할 때 사용되며, 레전드나 툴팁에서 시리즈를 나타내는 텍스트로도 사용된다.

default :undefined

noClip: boolean (opens in a new tab)

true로 지정하면 body를 벗어난 data point 영역도 표시된다.
값을 지정하지 않으면 polar 차트에서는 true, 직교 차트에서는 false이다. group에 포함되면 group의 noClip 설정을 따른다.
또, 값을 지정하지 않으면 버블시리즈는 최대한 버블들이 표시되도록 한다.

default :undefined

onPointClick: (args: DataPointCallbackArgs) => boolean (opens in a new tab)

데이터 point가 클릭될 때 호출되는 이벤트 콜백.
명시적 true를 리턴하면 기본 동작이 진행되지 않는다.

default :undefined

onPointHover: (args: DataPointCallbackArgs) => void (opens in a new tab)

마우스가 데이터 point 위에 올라가거나 빠져나갈 때 호출되는 이벤트 콜백.
빠져나가는 경우 args 매개변수는 null이다.

default :undefined

onPointsLoaded: (series: object (opens in a new tab), firstTime: boolean (opens in a new tab)) => void (opens in a new tab)

데이터포인트들이 새로 로드된 후 호출된다.

default :undefined

pointColors: string (opens in a new tab) | Array (opens in a new tab)<string (opens in a new tab)>

데이터 포인트별 색들을 지정한다.
색 배열로 지정하거나, 'colors' asset으로 등록된 이름을 지정할 수 있다.
pointStyleCallback으로 설정된 색상이나 데이터포인트별로 지정한 색상이 이 속성으로 설정한 색상보다 우선한다.

default :undefined

pointLabel: boolean (opens in a new tab) | DataPointLabelOptions

데이터포인트 label 옵션.
단순히 boolean (opens in a new tab) 값으로 설정하면 visible 속성에 적용된다.

default :undefined

pointStyle: SVGStyles | string (opens in a new tab)

모든 데이터포인트에 적용되는 스타일셋 또는 css selector (opens in a new tab).
style로 설정되는 시리즈의 inline 스타일이 데이터포인터에 적용되지 않는 경우 이 속성을 사용할 수 있다. pointColors나 color가 설정되면 이 속성으로 설정된 색상은 무시된다. 또, pointStyleCallback으로 설정된 스타일이 이 속성 스타일보다 우선한다.

default :undefined

pointStyleCallback: (args: DataPointCallbackArgs) => SVGStyles|string (opens in a new tab)

데이터포인트의 동적 스타일 콜백.

default :undefined

row: number (opens in a new tab)

분할 모드일 때 시리즈가 표시될 pane의 수직 index.

default :undefined

seed: number (opens in a new tab)

단어 배치 각도와 관련된 random 값
0 ~ 360 사이의 값으로 지정한다.

default :undefined

shuffle: boolean (opens in a new tab)

true로 지정하면 차트가 새로 표시되거나 데이터가 변경될 때, 단어들의 위치가 디르게 표시된다.

default :false

style: SVGStyles | string (opens in a new tab)

스타일셋 또는 css selector (opens in a new tab).

default :undefined

text: string (opens in a new tab)

표시할 단어들이 포함된 전체 텍스트.
이 속성에 비어 있지 않은 문자열이 설정되면 data는 무시된다.

default :undefined

textHeight: number (opens in a new tab) | 'auto'

시리즈 배치 기준이되는 각 단어의 높이 비율로 눈으로 보이는 폰트 높이와 계산되는 높이를 조정한다.
'auto'로 지정하면 각 텍스트이 실제 표시 높이를 계산해서 배치한다. 숫자값은 0.1 ~ 2 사이의 값으로 조정된다.

default :'auto'

tooltipCallback: (args: any (opens in a new tab)) => string (opens in a new tab)

default :undefined

tooltipText: string (opens in a new tab)

데이터포인트 툴팁 텍스트.

default :undefined

type: string (opens in a new tab)

default :undefined

viewRangeValue: 'x' | 'y' | 'z'

ranges가 적용되는 값.
지정하지 않으면 시리즈 종류에 띠라 자동 적용된다. 'line' 시리즈 계열은 'x', 나머지는 'y'가 된다. 현재 'z'은 range는 bubble 시리즈에만 적용할 수 있다.

default :undefined

viewRanges: ValueRangeList | Array (opens in a new tab)<ValueRange>

값 범위 목록.
범위별로 다른 스타일을 적용할 수 있다. 범위들은 중첩될 수 없다.

default :undefined

visible: boolean (opens in a new tab)

표시 여부.

default :true

visibleInLegend: boolean (opens in a new tab)

명시적 false로 지정하면 legend에 표시하지 않는다.

default :undefined

visibleInNavigator: boolean (opens in a new tab)

true로 지정하면 시리즈 내비게이터에 표시한다. 해당 속성은 bar, line 시리즈 에서만 적용된다.

default :undefined

visibleThreshold: number (opens in a new tab)

포인터가 차지하는 너비가 이 값 미만이면 표시하지 않는다.

default :undefined

wordGap: number (opens in a new tab)

단어 사이의 최소 수평 간격을 시리즈 내부 단위로 표시한다.

default :undefined

xAxis: string (opens in a new tab) | number (opens in a new tab)

그룹에 포함되면 그룹 설정을 따른다.

default :undefined

xField: string (opens in a new tab) | number (opens in a new tab)

json 객체나 배열로 전달되는 데이터포인트 정보에서 x 값을 지정하는 속성명이나 인덱스.
undefined이면, data point의 값이 array일 때는 0, 객체이면 'x'.

default :undefined

xStart: any (opens in a new tab)

연결된 x축이 연속 축(카테고리축이 아닌)일 때, x축 값이 설정되지 않은 첫번째 데이터 point에 설정되는 x값.
이 후에는 xStep씩 증가시키면서 설정한다. 이 속성이 지정되지 않은 경우 xStart가 적용된다.

default :undefined

xStep: string (opens in a new tab) | number (opens in a new tab)

연결된 x축이 연속 축(카테고리축이 아닌)일 때, x축 값이 설정되지 않은 데이터 point에 지정되는 x값의 간격.
첫번째 값은 xStart로 설정한다. time 축일 때, 정수 값 대신 시간 단위('y', 'm', 'w', 'd', 'h', 'n', 's')로 지정할 수 있다. 이 속성이 지정되지 않으면 xStep이 적용된다.

default :undefined

yAxis: string (opens in a new tab) | number (opens in a new tab)

그룹에 포함되면 그룹 설정을 따른다.

default :undefined

yField: string (opens in a new tab) | number (opens in a new tab) | Function (opens in a new tab)

json 객체나 배열로 전달되는 데이터포인트 정보에서 y 값을 지정하는 속성명이나 인덱스.
undefined이면, data point의 값이 array일 때는 1, 객체이면 'y'.

default :undefined

zField: string (opens in a new tab) | number (opens in a new tab) | Function (opens in a new tab)

json 객체나 배열로 전달되는 데이터포인트 정보에서 z 값을 지정하는 속성명이나 인덱스.
undefined이면, data point의 값이 array일 때는 2, 객체이면 'z'.

default :undefined

zOrder: number (opens in a new tab)

시리즈 표시 순서를 지정할 수 있다.
값이 클 수록 나중에(위에) 표시된다.

default :undefined

zeroInLegend: boolean (opens in a new tab)

값이 0인 데이터포인트를 범례 항목으로 표시할 것인 지 여부.

default :true