Class: Legend

Legend

new Legend()

Legend 클래스는 차트상에 범례를 표현합니다.

차트의 하단에 출력되는 것이 기본(default)이며, 차트를 기준으로 상, 하, 좌, 우에 표시가 가능합니다.

레이아웃은 다음과 같은 형식으로 작성됩니다.

...
<Options>
  <Legend defaultMouseOverAction="true" useVisibleCheck="true" />
</Options>
...

Members

backgroundAlphaNumber

배경의 투명도를 설정합니다.

유효값은 0 과 1 사이의 값입니다.

Default Value:
  • 1

backgroundColorHexadecimal

범례의 배경색을 설정합니다.

Default Value:
  • #FFFFFF

borderColorHexadecimal

범례의 테두리 선 색상을 설정합니다.

Default Value:
  • #e9e9e9

borderStyleString

범례의 테두리 선의 스타일을 설정합니다.

유효값은 다음과 같습니다.


  • none - 테두리 선을 그리지 않도록 설정합니다.

  • solid - 테두리를 기준으로 테두리 자체에 선을 그리도록 설정합니다.

  • inset - 테두리를 기준으로 테두리 안쪽에 선을 그리도록 설정합니다.

  • outset - 테두리를 기준으로 테두리 바깥쪽에 선을 그리도록 설정합니다.

Default Value:
  • solid

borderWidthNumber

범례 테두리 선의 두께를 설정합니다.

borderStyle 속성이 solid 로 설정된 경우에만 적용됩니다.

Default Value:
  • 1

bornerRadiusNumber

범례 테두리 모서리선의 둥근 정도를 설정합니다.

Default Value:
  • 0

changeItemOrderBoolean

범례 항목을 역순으로 표시합니다.

Default Value:
  • false

defaultMouseOverActionBoolean

범례 항목에 대한 마우스 오버시 차트에서 제공하는 기본(default) 동작을 실행할 지 여부를 설정합니다.

차트에서 제공하는 기본(default) 동작은 범례 항목에 마우스 오버시 해당되는 시리즈만 표시하는 것입니다.

Default Value:
  • false

directionString

범례 항목들에 대한 가로(세로) 출력여부를 설정합니다.

유효값은 horizontal, vertical 입니다.

Default Value:
  • horizontal

hAlignString

범례 항목의 가로 정렬 방식을 설정합니다.

position 속성이 top 또는 bottom 일 경우 적용됩니다.

유효값은 left, center, right 입니다.

Default Value:
  • center

heightNumber

범례의 세로 크기를 설정합니다.

horizontalGapNumber

체크박스, 마커, 텍스트 사이의 가로 여백의 크기를 픽셀 단위로 설정합니다.

Default Value:
  • 6

itemClickEmphasizeTypeString

범례 항목 클릭 시 강조 효과의 유형을 설정합니다.

유효값은 appearance, focus 입니다.

Default Value:
  • appearance

labelPlacementString

범례 텍스트가 마커와 체크박스를 기준으로 어디에 위치할 지 설정합니다.

유효값은 right, left, top, bottom 입니다.

Default Value:
  • right

markerHeightNumber

범례 항목에 대한 마커(marker)의 세로 크기를 설정합니다.

Default Value:
  • NaN

markerWidthNumber

범례 항목에 대한 마커(marker)의 가로 크기를 설정합니다.

Default Value:
  • NaN

paddingBottomNumber

하단 여백의 크기를 픽셀 단위로 설정합니다.

Default Value:
  • 5

paddingLeftNumber

왼쪽 여백의 크기를 픽셀 단위로 설정합니다.

Default Value:
  • 5

paddingRightNumber

오른쪽 여백의 크기를 픽셀 단위로 설정합니다.

Default Value:
  • 5

paddingTopNumber

상단 여백의 크기를 픽셀 단위로 설정합니다.

Default Value:
  • 5

positionString

범례가 차트를 기준으로 어디에 위치할 지 설정합니다.

유효값은 left, right, top, bottom 입니다.

Default Value:
  • bottom

useAxisVisibleCheckBoolean

범례 항목 클릭 시 화면에 보이지 않는 시리즈에 대응하는 축을 표시할 지 여부를 설정합니다.

Default Value:
  • false

useVisibleCheckBoolean

범례에서 체크박스를 사용할 지 여부를 설정합니다.

Default Value:
  • false

vAlignString

범례 항목의 세로 정렬 방식을 설정합니다.

position 속성이 left 또는 right 일 경우 적용됩니다.

유효값은 top, middle, bottom 입니다.

Default Value:
  • middle

verticalGapNumber

범례 항목들 사이의 세로 여백의 크기를 픽셀 단위로 설정합니다.

Default Value:
  • 6

verticalScrollPolicyString

수직 방향의 스크롤 정책을 설정합니다.

유효값은 다음과 같습니다.


  • auto - 박스 내부에 표시될 요소들의 크기를 고려하여 스크롤 여부가 결정됩니다.

  • off - 박스 내부에 표시될 요소들의 크기와 상관없이 스크롤을 하지 않습니다.

  • on - 박스 내부에 표시될 요소들의 크기와 상관없이 스크롤을 합니다.

Default Value:
  • off

widthNumber

범례의 가로 크기를 설정합니다.

Methods

itemClickJsFunction(index, displayName)

범례 항목 클릭 시 실행되는 자바스크립트 함수명을 설정합니다.

<Legend useVisibleCheck="true" itemClickJsFunction="legendItemClick" />
...
legendItemClick(index, displayName) {
  ...
}
Name Type Description
index Number

범례 항목의 인덱스

displayName String

범례 항목의 라벨

titleJsFunction(index, displayName)

범례 항목에 마우스 오버시 표시되는 데이터 팁을 출력하는 자바스크립트 함수명을 설정합니다.

<Legend useVisibleCheck="true" titleJsFunction="titleJsFunc" />
...
titleJsFunc(index, displayName) {
  ...
}
Name Type Description
index Number

범례 항목의 인덱스

displayName String

범례 항목의 라벨