Class ArcChartWrapper<TType>`Abstract`

Type Parameters

TType extends ArcChartType

Hierarchy (View Summary)

ChartWrapper<TType>
- ArcChartWrapper
  - DoughnutChartWrapper
  - PieChartWrapper

Implements

ArcChartBuilder<TType>

Index

Chart

build

build(id?: string): ChartConfig
Beta
Parameters
- Optionalid: string
Returns ChartConfig
Description
차트 설정 객체를 생성합니다. 이 메소드는 차트의 구성 요소를 종합하여 Chart.js에서 사용할 수 있는 형식으로 반환합니다.

Since
1.0.0
Implementation of ArcChartBuilder.build
Overrides ChartWrapper.build
- Defined in src/ArcChartWrapper.ts:145

Dataset

`Protected`decorateDataset

decorateDataset(ds: any, idx: number): void
Protected Beta
Parameters
- ds: any
- idx: number
Returns void
Description
데이터셋의 기본적인 옵션을 추가하거나 부여합니다. (Arc 차트용)

Returns
Since
1.0.1
- Defined in src/ArcChartWrapper.ts:67

setAllBorderColor

setAllBorderColor(borderColor: string | string[]): this
Beta
Parameters
- borderColor: string | string[]
  경계선 색상
Returns this
Description
모든 데이터셋의 경계선 색상을 설정합니다.

Since
1.0.0
Implementation of ArcChartBuilder.setAllBorderColor
- Defined in src/ArcChartWrapper.ts:294

setAllBorderWidth

setAllBorderWidth(borderWidth: number): this
Beta
Parameters
- borderWidth: number
  경계선 너비
Returns this
Description
모든 데이터셋의 경계선 너비를 설정합니다.

Since
1.0.0
Implementation of ArcChartBuilder.setAllBorderWidth
- Defined in src/ArcChartWrapper.ts:261

setBorderColor

setBorderColor(datasetIndex: number, borderColor: string | string[]): this
Beta
Parameters
- datasetIndex: number
  데이터셋 인덱스
- borderColor: string | string[]
  경계선 색상
Returns this
Description
데이터셋의 경계선 색상을 설정합니다.

Since
1.0.0
Implementation of ArcChartBuilder.setBorderColor
- Defined in src/ArcChartWrapper.ts:279

setBorderWidth

setBorderWidth(datasetIndex: number, borderWidth: number): this
Beta
Parameters
- datasetIndex: number
  데이터셋 인덱스
- borderWidth: number
  경계선 너비
Returns this
Description
데이터셋의 경계선 너비를 설정합니다.

Since
1.0.0
Implementation of ArcChartBuilder.setBorderWidth
- Defined in src/ArcChartWrapper.ts:246

setSegmentImages

setSegmentImages(
images: string[] | UidImageMapping[],
config?: Partial<Omit<SegmentImageConfig, "images">>,
): this
Beta
Parameters
- images: string[] | UidImageMapping[]
  이미지 URL 배열 (URL, Base64, SVG, Emoji 등) 또는 UID 매핑 배열
- Optionalconfig: Partial<Omit<SegmentImageConfig, "images">>
  이미지 설정 옵션
Returns this
Description
각 세그먼트에 이미지를 설정합니다.

Since
1.6.0
Example
```
// URL 방식 (순서대로 매핑)
chart.setSegmentImages([
  'https://example.com/icon1.png',
  'https://example.com/icon2.png'
]);

// UID 매핑 방식
chart.setSegmentImages([
  { _uid: 'chart_id_ds_0', image: 'public/assets/image1.png' },
  { _uid: 'chart_id_ds_1', image: 'public/assets/image2.png' }
]);

// 크기 조절
chart.setSegmentImages(
  ['image1.png', 'image2.png'],
  { width: 40, height: 40, backgroundColor: 'transparent' }
);
```
Implementation of ArcChartBuilder.setSegmentImages
- Defined in src/ArcChartWrapper.ts:330

Options

setCircumference

setCircumference(circumference: number): this
Beta
Parameters
- circumference: number
  원주각 (도 단위, 360 = 완전한 원)
Returns this
Description
도넛/파이 차트의 원주각을 설정합니다.

Since
1.0.0
Implementation of ArcChartBuilder.setCircumference
- Defined in src/ArcChartWrapper.ts:197

setCutout

setCutout(cutout: string | number): this
Beta
Parameters
- cutout: string | number
  구멍 크기 (퍼센트 문자열 또는 픽셀 숫자)
Returns this
Description
도넛 차트의 중앙 구멍 크기를 설정합니다.

Since
1.0.0
Implementation of ArcChartBuilder.setCutout
- Defined in src/ArcChartWrapper.ts:213

setRadius

setRadius(radius: string | number): this
Beta
Parameters
- radius: string | number
  반지름 (퍼센트 문자열 또는 픽셀 숫자)
Returns this
Description
차트의 반지름을 설정합니다.

Since
1.0.0
Implementation of ArcChartBuilder.setRadius
- Defined in src/ArcChartWrapper.ts:229

setRotation

setRotation(rotation: number): this
Beta
Parameters
- rotation: number
  시작 각도 (도 단위)
Returns this
Description
도넛/파이 차트의 회전 각도를 설정합니다.

Since
1.0.0
Implementation of ArcChartBuilder.setRotation
- Defined in src/ArcChartWrapper.ts:181

Other

`Protected`constructor

new ArcChartWrapper<TType extends ArcChartType>(
    type: TType,
    labels: (string | number)[],
    datasets: ChartDataset<TType, (null | number)[]>[],
    options?: CustomArcChartOptions<TType>,
    plugins?: Plugin<keyof ChartTypeRegistry, AnyObject>,
): ArcChartWrapper<TType>
Type Parameters
- TType extends ArcChartType
Parameters
- type: TType
- labels: (string | number)[]
- datasets: ChartDataset<TType, (null | number)[]>[]
- Optionaloptions: CustomArcChartOptions<TType>
- Optionalplugins: Plugin<keyof ChartTypeRegistry, AnyObject>
Returns ArcChartWrapper<TType>
Overrides ChartWrapper.constructor
- Defined in src/ArcChartWrapper.ts:29

`Private` `Optional`_chartId

_chartId?: string

`Protected`labels

labels: undefined | (string | number)[]

`Protected`options

options: CustomChartOptions

`Protected` `Optional`plugins

plugins?: any

`Readonly`type

type: TType

`Static`registry

registry: Map<string, Constructor<any, any>> = ...

chartId

get chartId(): string
Returns string
- Defined in src/ArcChartWrapper.ts:39
set chartId(value: string): void
Parameters
- value: string
Returns void
- Defined in src/ArcChartWrapper.ts:46

`Protected`datasets

get datasets(): CustomChartDatasets<TType>[]
Returns CustomChartDatasets<TType>[]
Inherited from ChartWrapper.datasets
- Defined in src/ChartWrapper.ts:47
set datasets(value: CustomChartDatasets<TType>[]): void
Parameters
- value: CustomChartDatasets<TType>[]
Returns void
Inherited from ChartWrapper.datasets
- Defined in src/ChartWrapper.ts:50

`Protected`configAop

configAop(config: any): any
Parameters
- config: any
Returns any
Overrides ChartWrapper.configAop
- Defined in src/ArcChartWrapper.ts:105

`Protected`mustHavePlugins

mustHavePlugins(): {
    id: string;
    afterDestroy(chart: any): void;
    afterDraw(chart: any, args: any, options: any): void;
}[]
Returns {
    id: string;
    afterDestroy(chart: any): void;
    afterDraw(chart: any, args: any, options: any): void;
}[]
- Defined in src/ArcChartWrapper.ts:86

`Protected`normalize

normalize(): void
Returns void
Overrides ChartWrapper.normalize
- Defined in src/ArcChartWrapper.ts:90

`Protected`requireLabels

requireLabels(): boolean
Returns boolean
- Defined in src/ArcChartWrapper.ts:53

`Static`create

create<TType extends keyof ChartTypeRegistry>(
    type: TType,
    labels: (string | number)[],
    datasets: CustomChartDatasets<TType>[],
    options?: CustomChartOptions<TType>,
    plugins?: Plugin<keyof ChartTypeRegistry, AnyObject>,
): TType extends keyof ChartBuilderMap
    ? ChartBuilderMap[TType<TType>]
    : ChartBuilder<TType>
Type Parameters
- TType extends keyof ChartTypeRegistry
Parameters
- type: TType
- labels: (string | number)[]
- datasets: CustomChartDatasets<TType>[]
- Optionaloptions: CustomChartOptions<TType>
- Optionalplugins: Plugin<keyof ChartTypeRegistry, AnyObject>
Returns TType extends keyof ChartBuilderMap
? ChartBuilderMap[TType<TType>]
: ChartBuilder<TType>
Inherited from ChartWrapper.create
- Defined in src/ChartWrapper.ts:63

`Static`has

has(type: keyof ChartTypeRegistry): boolean
Parameters
- type: keyof ChartTypeRegistry
Returns boolean
Inherited from ChartWrapper.has
- Defined in src/ChartWrapper.ts:79

`Static`register

register<TType extends keyof ChartTypeRegistry, TInstance>(
type: TType,
wrapperClass: Constructor<TType, TInstance>,
): void
Type Parameters
- TType extends keyof ChartTypeRegistry
- TInstance
Parameters
- type: TType
- wrapperClass: Constructor<TType, TInstance>
Returns void
Inherited from ChartWrapper.register
- Defined in src/ChartWrapper.ts:74

config

makeConfig

makeConfig(id?: string): ChartConfig
Parameters
- Optionalid: string
Returns ChartConfig
Description
레거시 지원용 차트 설정 객체를 생성합니다.

Since
1.0.0
Implementation of ArcChartBuilder.makeConfig
Inherited from ChartWrapper.makeConfig
- Defined in src/ChartWrapper.ts:124

dataset

getChartData

getChartData(uid: string): CustomChartDatasets<TType>
Beta
Parameters
- uid: string
Returns CustomChartDatasets<TType>
Description
특정 데이터셋을 식별자(UID 또는 라벨)로 조회합니다.

Since
1.0.0
Example
```
const dataset = chart.getChartData('dataset-uid-or-label');
console.log(dataset);
@beta
```
Implementation of ArcChartBuilder.getChartData
Inherited from ChartWrapper.getChartData
- Defined in src/ChartWrapper.ts:249

setChartData

setChartData(uid: string, newDataset: CustomChartDatasets<TType>): void
Beta
Parameters
- uid: string
- newDataset: CustomChartDatasets<TType>
Returns void
Description
특정 데이터셋을 식별자(UID 또는 라벨)로 찾아 새로운 데이터셋으로 교체합니다.

Since
1.0.0
Example
```
chart.setChartData('dataset-uid-or-label', { label: 'New Dataset', data: [10, 20, 30] });
@beta
```
Implementation of ArcChartBuilder.setChartData
Inherited from ChartWrapper.setChartData
- Defined in src/ChartWrapper.ts:277

options

onResize

onResize(
    callback: (
        chart: Chart<TType>,
        size: { height: number; width: number },
    ) => void,
): this
Beta
Parameters
- callback: (chart: Chart<TType>, size: { height: number; width: number }) => void
Returns this
Description
차트 리사이즈 이벤트 콜백 함수를 설정합니다.

Since
1.0.0
Implementation of ArcChartBuilder.onResize
Inherited from ChartWrapper.onResize
- Defined in src/ChartWrapper.ts:168

setLegend

setLegend(legendOptions: DeepPartial<LegendOptions<TType>>): this

Parameters

legendOptions: DeepPartial<LegendOptions<TType>>

Returns this

Description

차트의 범례를 설정합니다.

Since

1.0.0

Example

chart.setLegend({
position: 'bottom',
  align: 'center',
  labels: {
    boxWidth: 40,
    padding: 15,
    font: {
      size: 14,
      weight: 'bold'
    },
    color: '#333',
    usePointStyle: true
  }
  onClick: (e, legendItem, legend) => {
    console.log('Legend clicked:', legendItem);
  }
});

setTitle

setTitle(titleOptions: DeepPartial<CommonCartesianTitleConfig>): this
Parameters
- titleOptions: DeepPartial<CommonCartesianTitleConfig>
Returns this
Description
차트의 제목을 설정합니다.

Since
1.0.0
Example
```
chart.setTitle({
  text: '차트 제목',
  align: 'center'  // 'start' | 'center' | 'end'
});
```
Implementation of ArcChartBuilder.setTitle
Inherited from ChartWrapper.setTitle
- Defined in src/ChartWrapper.ts:190

plugin

addStreaming

addStreaming(streamingOptions: StreamingOptions): this

Parameters

streamingOptions: StreamingOptions
chartjs-plugin-streaming 플러그인에 전달할 옵션 객체.

Returns this

Description

실시간 스트리밍 옵션을 설정합니다. 이 메서드를 사용하기 전에, 사용자는 'chartjs-plugin-streaming'을 설치하고 Chart.js에 직접 등록해야 합니다.

Since

1.8.0

Example

// 1. 사용자 측에서 웹소켓 등 데이터 소스 설정
const myWebSocket = new WebSocket('wss://my-data-source');

// 2. ChartWrapper에 스트리밍 옵션 적용
chart.addStreaming({
  duration: 20000, // 20초 분량의 데이터를 차트에 표시
  refresh: 1000,    // 1초마다 차트 업데이트
  onRefresh: (chart) => {
    // 3. 데이터 소스로부터 받은 데이터를 차트에 추가
    myWebSocket.onmessage = (event) => {
      const data = JSON.parse(event.data);
      chart.data.datasets[0].data.push({
        x: data.timestamp,
        y: data.value
      });
    };
  }
});

hasPlugin

hasPlugin(pluginId: string): boolean
Parameters
- pluginId: string
Returns boolean
Description
플러그인이 존재하는지 확인합니다.

Since
1.0.0
Implementation of ArcChartBuilder.hasPlugin
Inherited from ChartWrapper.hasPlugin
- Defined in src/ChartWrapper.ts:152

removePlugin

removePlugin(pluginId: string): this
Parameters
- pluginId: string
Returns this
Description
플러그인을 제거합니다.

Since
1.0.0
Implementation of ArcChartBuilder.removePlugin
Inherited from ChartWrapper.removePlugin
- Defined in src/ChartWrapper.ts:135

setPlugin

setPlugin(plugin: any, replaceIfExists?: boolean): this
Parameters
- plugin: any
  단일 플러그인 또는 플러그인 배열
- replaceIfExists: boolean = true
Returns this
Description
플러그인을 추가합니다. 단일 플러그인 또는 플러그인 배열을 받을 수 있습니다.

Since
1.0.0
Implementation of ArcChartBuilder.setPlugin
Inherited from ChartWrapper.setPlugin
- Defined in src/ChartWrapper.ts:94

Class ArcChartWrapper<TType>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Chart

Dataset

Options

Other

config

dataset

options

plugin

Chart

build

Parameters

Returns ChartConfig

Description

Since

Dataset

ProtecteddecorateDataset

Parameters

Returns void

Description

Returns

Since

setAllBorderColor

Parameters

Returns this

Description

Since

setAllBorderWidth

Parameters

Returns this

Description

Since

setBorderColor

Parameters

Returns this

Description

Since

setBorderWidth

Parameters

Returns this

Description

Since

setSegmentImages

Parameters

Returns this

Description

Since

Example

Options

setCircumference

Parameters

Returns this

Description

Since

setCutout

Parameters

Returns this

Description

Since

setRadius

Parameters

Returns this

Description

Since

setRotation

Parameters

Returns this

Description

Since

Other

Protectedconstructor

Type Parameters

Parameters

Returns ArcChartWrapper<TType>

Private Optional_chartId

Protectedlabels

Class ArcChartWrapper<TType>`Abstract`

`Protected`decorateDataset

`Protected`constructor

`Private` `Optional`_chartId

`Protected`labels

`Protected`options

`Protected` `Optional`plugins

`Readonly`type

`Static`registry

`Protected`datasets

`Protected`configAop

`Protected`mustHavePlugins

Returns {
id: string;
afterDestroy(chart: any): void;
afterDraw(chart: any, args: any, options: any): void;
}[]

`Protected`normalize

`Protected`requireLabels

`Static`create

Returns TType extends keyof ChartBuilderMap
? ChartBuilderMap[TType<TType>]
: ChartBuilder<TType>

`Static`has

`Static`register