stz-util Documentation - v2.0.3
    Preparing search index...

    Variable customDatasetPluginsConst Beta

    customDatasetPlugins: {
        _tooltips: WeakMap<WeakKey, any>;
        id: string;
        _handleGroupVisibility(chart: any, datasets: any[]): void;
        _handleLegendClick(
            e: any,
            legendItem: any,
            legend: any,
            toggleBehavior: string,
        ): void;
        _hideTooltip(chart: any): void;
        _hitTestLegend(chart: any, x: number, y: number): any;
        _setupLegendTooltip(chart: any): void;
        _showTooltip(
            chart: any,
            e: MouseEvent,
            tooltipContent: string | ((context: any) => string),
            legendItem: any,
        ): void;
        afterDestroy(chart: any): void;
        afterInit(chart: any, args: any, options: any): void;
        beforeUpdate(chart: any, args: any, options: any): void;
    } = ...

    Type Declaration

    • _tooltips: WeakMap<WeakKey, any>
    • id: string
    • _handleGroupVisibility: function
      • _handleGroupVisibility(chart: any, datasets: any[]): void

        Parameters

        • chart: any
        • datasets: any[]

        Returns void

    • _handleLegendClick: function
      • _handleLegendClick(
            e: any,
            legendItem: any,
            legend: any,
            toggleBehavior: string,
        ): void

        Parameters

        • e: any
        • legendItem: any
        • legend: any
        • toggleBehavior: string

        Returns void

    • _hideTooltip: function
      • _hideTooltip(chart: any): void

        Parameters

        • chart: any

        Returns void

    • _hitTestLegend: function
      • _hitTestLegend(chart: any, x: number, y: number): any

        Parameters

        • chart: any
        • x: number
        • y: number

        Returns any

    • _setupLegendTooltip: function
      • _setupLegendTooltip(chart: any): void

        Parameters

        • chart: any

        Returns void

    • _showTooltip: function
      • _showTooltip(
            chart: any,
            e: MouseEvent,
            tooltipContent: string | ((context: any) => string),
            legendItem: any,
        ): void

        Parameters

        • chart: any
        • e: MouseEvent
        • tooltipContent: string | ((context: any) => string)
        • legendItem: any

        Returns void

    • afterDestroy: function

      • Parameters

        • chart: any

        Returns void

    • afterInit: function

      • Parameters

        • chart: any
        • args: any
        • options: any

        Returns void

    • beforeUpdate: function

      • Parameters

        • chart: any
        • args: any
        • options: any

        Returns void

    커스텀 데이터셋 속성을 읽어서 핸들링하는 플러그인 지원하는 커스텀 데이터셋 속성:

    • _aux: boolean - 차트에는 그려지지만 범례에서 제외
    • _group: string | number - 같은 그룹의 데이터셋들이 함께 show/hide
    • _visible: boolean - false면 범례에서 아예 제외하고 데이터셋도 숨김
    • _legendOrder: number - 범례 표시 순서 제어 (작을수록 앞에 표시)
    • _groupLabel: string - 같은 그룹을 하나의 범례 항목으로 통합
    • _toggleBehavior: 'normal' | 'radio' | 'disabled' - 클릭 동작 방식
    • _tooltip: string | function - 범례 항목 마우스 오버 시 툴팁 표시

    1.3.0

    // 기본 사용법
    const datasets = [
      {
        label: 'Revenue',
        data: [100, 150, 200],
        _legendOrder: 1,
        _tooltip: 'Monthly revenue data'
      },
      {
        label: 'Background Process',
        data: [10, 15, 20],
        _aux: true // 차트에는 보이지만 범례에서 제외
      },
      {
        label: 'Team A',
        data: [80, 85, 90],
        _groupLabel: 'Team Performance',
        _group: 'teams'
      },
      {
        label: 'Team B',
        data: [75, 80, 85],
        _groupLabel: 'Team Performance',
        _group: 'teams'
      }
    ];

    const chart = ChartWrapper
      .create('bar', ['Jan', 'Feb', 'Mar'], datasets)
      .build('advanced-chart');

    // 라디오 버튼 방식 (하나만 선택 가능)
    const datasets = [
      {
        label: 'Option A',
        data: [10, 20, 30],
        _toggleBehavior: 'radio'
      },
      {
        label: 'Option B',
        data: [15, 25, 35],
        _toggleBehavior: 'radio'
      }
    ];
    • customLegend 플러그인이 등록되어 있으면 자동으로 비활성화됩니다
    • 범례가 비활성화된 경우에는 동작하지 않습니다
    • 모든 차트 타입에서 사용 가능합니다
    • 메모리 누수 방지를 위해 차트 파괴 시 자동으로 정리됩니다

    (aux 정상동작 , _group : 에러 , groupLabel : 정상 , _tooltip : 에러 , _toggleBehavior : 정상 , _visible : 정상 , _legendOrder : 확인중)

    Settings

    Member Visibility