src/component/legend/scrollableLegendAction.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.
*/

import ScrollableLegendModel from './ScrollableLegendModel';
import { EChartsExtensionInstallRegisters } from '../../extension';

export default function installScrollableLegendAction(registers: EChartsExtensionInstallRegisters) {
    /**
     * @event legendScroll
     * @type {Object}
     * @property {string} type 'legendScroll'
     * @property {string} scrollDataIndex
     */
    registers.registerAction(
        'legendScroll', 'legendscroll',
        function (payload, ecModel) {
            const scrollDataIndex = payload.scrollDataIndex;

            scrollDataIndex != null && ecModel.eachComponent(
                {mainType: 'legend', subType: 'scroll', query: payload},
                function (legendModel: ScrollableLegendModel) {
                    legendModel.setScrollDataIndex(scrollDataIndex);
                }
            );
        }
    );
}