src/chart/sunburst/sunburstAction.ts

/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements.  See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership.  The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License.  You may obtain a copy of the License at
*
*   http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied.  See the License for the
* specific language governing permissions and limitations
* under the License.
*/

/**
 * @file Sunburst action
 */

import SunburstSeriesModel from './SunburstSeries';
import { Payload } from '../../util/types';
import GlobalModel from '../../model/Global';
import ExtensionAPI from '../../core/ExtensionAPI';
import { extend } from 'zrender/src/core/util';
import { deprecateReplaceLog } from '../../util/log';
import { EChartsExtensionInstallRegisters } from '../../extension';
import { retrieveTargetInfo, aboveViewRoot } from '../helper/treeHelper';

export const ROOT_TO_NODE_ACTION = 'sunburstRootToNode';

interface SunburstRootToNodePayload extends Payload {}


const HIGHLIGHT_ACTION = 'sunburstHighlight';

interface SunburstHighlightPayload extends Payload {}


const UNHIGHLIGHT_ACTION = 'sunburstUnhighlight';

interface SunburstUnhighlightPayload extends Payload {}

export function installSunburstAction(registers: EChartsExtensionInstallRegisters) {
    registers.registerAction(
        {type: ROOT_TO_NODE_ACTION, update: 'updateView'},
        function (payload: SunburstRootToNodePayload, ecModel: GlobalModel) {

            ecModel.eachComponent(
                {mainType: 'series', subType: 'sunburst', query: payload},
                handleRootToNode
            );

            function handleRootToNode(model: SunburstSeriesModel, index: number) {
                const targetInfo = retrieveTargetInfo(payload, [ROOT_TO_NODE_ACTION], model);

                if (targetInfo) {
                    const originViewRoot = model.getViewRoot();
                    if (originViewRoot) {
                        payload.direction = aboveViewRoot(originViewRoot, targetInfo.node)
                            ? 'rollUp' : 'drillDown';
                    }
                    model.resetViewRoot(targetInfo.node);
                }
            }
        }
    );

    registers.registerAction(
        {type: HIGHLIGHT_ACTION, update: 'none'},
        function (payload: SunburstHighlightPayload, ecModel: GlobalModel, api: ExtensionAPI) {
            // Clone
            payload = extend({}, payload);
            ecModel.eachComponent(
                {mainType: 'series', subType: 'sunburst', query: payload},
                handleHighlight
            );

            function handleHighlight(model: SunburstSeriesModel) {
                const targetInfo = retrieveTargetInfo(payload, [HIGHLIGHT_ACTION], model);
                if (targetInfo) {
                    payload.dataIndex = targetInfo.node.dataIndex;
                }
            }

            if (__DEV__) {
                deprecateReplaceLog('sunburstHighlight', 'highlight');
            }

            // Fast forward action
            api.dispatchAction(extend(payload, {
                type: 'highlight'
            }));
        }
    );

    registers.registerAction(
        {type: UNHIGHLIGHT_ACTION, update: 'updateView'},
        function (payload: SunburstUnhighlightPayload, ecModel: GlobalModel, api: ExtensionAPI) {
            payload = extend({}, payload);

            if (__DEV__) {
                deprecateReplaceLog('sunburstUnhighlight', 'downplay');
            }

            api.dispatchAction(extend(payload, {
                type: 'downplay'
            }));
        }
    );

}