src/component/legend/legendAction.ts - master - githubmirror/echarts

src/component/legend/legendAction.ts
138 строк5 KB
Zhongxiang Wang
fix(legend): return allSelectedMap rather than selectedMap
11 июл 2024, 17:57
11 июл 2024, 17:5713fe1d9
/*
* 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.
*/

import {curry, each, hasOwn} from 'zrender/src/core/util';
import { EChartsExtensionInstallRegisters } from '../../extension';
import { Payload } from '../../util/types';
import type GlobalModel from '../../model/Global';
import type LegendModel from './LegendModel';

type LegendSelectMethodNames = 'select' | 'unSelect' | 'toggleSelected' | 'allSelect' | 'inverseSelect';

function legendSelectActionHandler(methodName: LegendSelectMethodNames, payload: Payload, ecModel: GlobalModel) {
    const isAllSelect = methodName === 'allSelect' || methodName === 'inverseSelect';
    const selectedMap: Record<string, boolean> = {};

    const actionLegendIndices: number[] = [];
    ecModel.eachComponent({ mainType: 'legend', query: payload }, function (legendModel: LegendModel) {
        if (isAllSelect) {
            legendModel[methodName]();
        }
        else {
            legendModel[methodName](payload.name);
        }

        makeSelectedMap(legendModel, selectedMap);

        actionLegendIndices.push(legendModel.componentIndex);
    });

    const allSelectedMap: Record<string, boolean> = {};

    // make selectedMap from all legend components
    ecModel.eachComponent('legend', function (legendModel: LegendModel) {
        each(selectedMap, function (isSelected, name) {
            // Force other legend has same selected status
            // Or the first is toggled to true and other are toggled to false
            // In the case one legend has some item unSelected in option. And if other legend
            // doesn't has the item, they will assume it is selected.
            legendModel[isSelected ? 'select' : 'unSelect'](name);
        });

        makeSelectedMap(legendModel, allSelectedMap);
    });

    // Return the event explicitly
    return isAllSelect
        ? {
            selected: allSelectedMap,
            // return legendIndex array to tell the developers which legends are allSelect / inverseSelect
            legendIndex: actionLegendIndices
        }
        : {
            name: payload.name,
            selected: allSelectedMap
        };
}

function makeSelectedMap(legendModel: LegendModel, out?: Record<string, boolean>) {
    const selectedMap: Record<string, boolean> = out || {};
    each(legendModel.getData(), function (model) {
        const name = model.get('name');
        // Wrap element
        if (name === '\n' || name === '') {
            return;
        }
        const isItemSelected = legendModel.isSelected(name);
        if (hasOwn(selectedMap, name)) {
            // Unselected if any legend is unselected
            selectedMap[name] = selectedMap[name] && isItemSelected;
        }
        else {
            selectedMap[name] = isItemSelected;
        }
    });
    return selectedMap;
}

export function installLegendAction(registers: EChartsExtensionInstallRegisters) {
    /**
     * @event legendToggleSelect
     * @type {Object}
     * @property {string} type 'legendToggleSelect'
     * @property {string} [from]
     * @property {string} name Series name or data item name
     */
    registers.registerAction(
        'legendToggleSelect', 'legendselectchanged',
        curry(legendSelectActionHandler, 'toggleSelected')
    );

    registers.registerAction(
        'legendAllSelect', 'legendselectall',
        curry(legendSelectActionHandler, 'allSelect')
    );

    registers.registerAction(
        'legendInverseSelect', 'legendinverseselect',
        curry(legendSelectActionHandler, 'inverseSelect')
    );

    /**
     * @event legendSelect
     * @type {Object}
     * @property {string} type 'legendSelect'
     * @property {string} name Series name or data item name
     */
    registers.registerAction(
        'legendSelect', 'legendselected',
        curry(legendSelectActionHandler, 'select')
    );

    /**
     * @event legendUnSelect
     * @type {Object}
     * @property {string} type 'legendUnSelect'
     * @property {string} name Series name or data item name
     */
    registers.registerAction(
        'legendUnSelect', 'legendunselected',
        curry(legendSelectActionHandler, 'unSelect')
    );
}