/* * 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 * as zrUtil from 'zrender/src/core/util'; import {createSymbol} from '../../util/symbol'; import * as graphic from '../../util/graphic'; import { enableHoverEmphasis } from '../../util/states'; import {setLabelStyle, createTextStyle} from '../../label/labelStyle'; import {makeBackground} from '../helper/listComponent'; import * as layoutUtil from '../../util/layout'; import ComponentView from '../../view/Component'; import LegendModel, { LegendOption, LegendSelectorButtonOption, LegendTooltipFormatterParams } from './LegendModel'; import GlobalModel from '../../model/Global'; import ExtensionAPI from '../../core/ExtensionAPI'; import { ZRTextAlign, ZRColor, ItemStyleOption, ZRRectLike, CommonTooltipOption, ColorString } from '../../util/types'; import Model from '../../model/Model'; import Displayable, { DisplayableState } from 'zrender/src/graphic/Displayable'; import { PathStyleProps } from 'zrender/src/graphic/Path'; import { parse, stringify } from 'zrender/src/tool/color'; import {PatternObject} from 'zrender/src/graphic/Pattern'; import { getECData } from '../../util/innerStore'; const curry = zrUtil.curry; const each = zrUtil.each; const Group = graphic.Group; class LegendView extends ComponentView { static type = 'legend.plain'; type = LegendView.type; newlineDisabled = false; private _contentGroup: graphic.Group; private _backgroundEl: graphic.Rect; private _selectorGroup: graphic.Group; /** * If first rendering, `contentGroup.position` is [0, 0], which * does not make sense and may cause unexepcted animation if adopted. */ private _isFirstRender: boolean; init() { this.group.add(this._contentGroup = new Group()); this.group.add(this._selectorGroup = new Group()); this._isFirstRender = true; } /** * @protected */ getContentGroup() { return this._contentGroup; } /** * @protected */ getSelectorGroup() { return this._selectorGroup; } /** * @override */ render( legendModel: LegendModel, ecModel: GlobalModel, api: ExtensionAPI ) { const isFirstRender = this._isFirstRender; this._isFirstRender = false; this.resetInner(); if (!legendModel.get('show', true)) { return; } let itemAlign = legendModel.get('align'); const orient = legendModel.get('orient'); if (!itemAlign || itemAlign === 'auto') { itemAlign = ( legendModel.get('left') === 'right' && orient === 'vertical' ) ? 'right' : 'left'; } // selector has been normalized to an array in model const selector = legendModel.get('selector', true) as LegendSelectorButtonOption[]; let selectorPosition = legendModel.get('selectorPosition', true); if (selector && (!selectorPosition || selectorPosition === 'auto')) { selectorPosition = orient === 'horizontal' ? 'end' : 'start'; } this.renderInner(itemAlign, legendModel, ecModel, api, selector, orient, selectorPosition); // Perform layout. const positionInfo = legendModel.getBoxLayoutParams(); const viewportSize = {width: api.getWidth(), height: api.getHeight()}; const padding = legendModel.get('padding'); const maxSize = layoutUtil.getLayoutRect(positionInfo, viewportSize, padding); const mainRect = this.layoutInner(legendModel, itemAlign, maxSize, isFirstRender, selector, selectorPosition); // Place mainGroup, based on the calculated `mainRect`. const layoutRect = layoutUtil.getLayoutRect( zrUtil.defaults({ width: mainRect.width, height: mainRect.height }, positionInfo), viewportSize, padding ); this.group.x = layoutRect.x - mainRect.x; this.group.y = layoutRect.y - mainRect.y; this.group.markRedraw(); // Render background after group is layout. this.group.add( this._backgroundEl = makeBackground(mainRect, legendModel) ); } protected resetInner() { this.getContentGroup().removeAll(); this._backgroundEl && this.group.remove(this._backgroundEl); this.getSelectorGroup().removeAll(); } protected renderInner( itemAlign: LegendOption['align'], legendModel: LegendModel, ecModel: GlobalModel, api: ExtensionAPI, selector: LegendSelectorButtonOption[], orient: LegendOption['orient'], selectorPosition: LegendOption['selectorPosition'] ) { const contentGroup = this.getContentGroup(); const legendDrawnMap = zrUtil.createHashMap(); const selectMode = legendModel.get('selectedMode'); const excludeSeriesId: string[] = []; ecModel.eachRawSeries(function (seriesModel) { !seriesModel.get('legendHoverLink') && excludeSeriesId.push(seriesModel.id); }); each(legendModel.getData(), function (itemModel, dataIndex) { const name = itemModel.get('name'); // Use empty string or \n as a newline string if (!this.newlineDisabled && (name === '' || name === '\n')) { const g = new Group(); // @ts-ignore g.newline = true; contentGroup.add(g); return; } // Representitive series. const seriesModel = ecModel.getSeriesByName(name)[0]; if (legendDrawnMap.get(name)) { // Have been drawed return; } // Legend to control series. if (seriesModel) { const data = seriesModel.getData(); const style = data.getVisual('style'); const color = style[data.getVisual('drawType')] || style.fill; const borderColor = style.stroke; const decal = style.decal; // Using rect symbol defaultly const legendSymbolType = data.getVisual('legendSymbol') || 'roundRect'; const symbolType = data.getVisual('symbol'); const itemGroup = this._createItem( name, dataIndex, itemModel, legendModel, legendSymbolType, symbolType, itemAlign, color, borderColor, decal, selectMode ); itemGroup.on('click', curry(dispatchSelectAction, name, null, api, excludeSeriesId)) .on('mouseover', curry(dispatchHighlightAction, seriesModel.name, null, api, excludeSeriesId)) .on('mouseout', curry(dispatchDownplayAction, seriesModel.name, null, api, excludeSeriesId)); legendDrawnMap.set(name, true); } else { // Legend to control data. In pie and funnel. ecModel.eachRawSeries(function (seriesModel) { // In case multiple series has same data name if (legendDrawnMap.get(name)) { return; } if (seriesModel.legendVisualProvider) { const provider = seriesModel.legendVisualProvider; if (!provider.containName(name)) { return; } const idx = provider.indexOfName(name); const style = provider.getItemVisual(idx, 'style') as PathStyleProps; const borderColor = style.stroke; const decal = style.decal; let color = style.fill; const colorArr = parse(style.fill as ColorString); // Color may be set to transparent in visualMap when data is out of range. // Do not show nothing. if (colorArr && colorArr[3] === 0) { colorArr[3] = 0.2; // TODO color is set to 0, 0, 0, 0. Should show correct RGBA color = stringify(colorArr, 'rgba'); } const legendSymbolType = 'roundRect'; const itemGroup = this._createItem( name, dataIndex, itemModel, legendModel, legendSymbolType, null, itemAlign, color, borderColor, decal, selectMode ); // FIXME: consider different series has items with the same name. itemGroup.on('click', curry(dispatchSelectAction, null, name, api, excludeSeriesId)) // Should not specify the series name, consider legend controls // more than one pie series. .on('mouseover', curry(dispatchHighlightAction, null, name, api, excludeSeriesId)) .on('mouseout', curry(dispatchDownplayAction, null, name, api, excludeSeriesId)); legendDrawnMap.set(name, true); } }, this); } if (__DEV__) { if (!legendDrawnMap.get(name)) { console.warn( name + ' series not exists. Legend data should be same with series name or data name.' ); } } }, this); if (selector) { this._createSelector(selector, legendModel, api, orient, selectorPosition); } } private _createSelector( selector: LegendSelectorButtonOption[], legendModel: LegendModel, api: ExtensionAPI, orient: LegendOption['orient'], selectorPosition: LegendOption['selectorPosition'] ) { const selectorGroup = this.getSelectorGroup(); each(selector, function createSelectorButton(selectorItem) { const type = selectorItem.type; const labelText = new graphic.Text({ style: { x: 0, y: 0, align: 'center', verticalAlign: 'middle' }, onclick() { api.dispatchAction({ type: type === 'all' ? 'legendAllSelect' : 'legendInverseSelect' }); } }); selectorGroup.add(labelText); const labelModel = legendModel.getModel('selectorLabel'); const emphasisLabelModel = legendModel.getModel(['emphasis', 'selectorLabel']); setLabelStyle( labelText, { normal: labelModel, emphasis: emphasisLabelModel }, { defaultText: selectorItem.title } ); enableHoverEmphasis(labelText); }); } private _createItem( name: string, dataIndex: number, itemModel: LegendModel['_data'][number], legendModel: LegendModel, legendSymbolType: string, symbolType: string, itemAlign: LegendOption['align'], color: ZRColor, borderColor: ZRColor, decal: PatternObject, selectMode: LegendOption['selectedMode'] ) { const itemWidth = legendModel.get('itemWidth'); const itemHeight = legendModel.get('itemHeight'); const inactiveColor = legendModel.get('inactiveColor'); const inactiveBorderColor = legendModel.get('inactiveBorderColor'); const symbolKeepAspect = legendModel.get('symbolKeepAspect'); const legendModelItemStyle = legendModel.getModel('itemStyle'); const isSelected = legendModel.isSelected(name); const itemGroup = new Group(); const textStyleModel = itemModel.getModel('textStyle'); const itemIcon = itemModel.get('icon'); // Use user given icon first legendSymbolType = itemIcon || legendSymbolType; const legendSymbol = createSymbol( legendSymbolType, 0, 0, itemWidth, itemHeight, isSelected ? color : inactiveColor, // symbolKeepAspect default true for legend symbolKeepAspect == null ? true : symbolKeepAspect ); itemGroup.add( setSymbolStyle( legendSymbol, legendSymbolType, legendModelItemStyle, borderColor, inactiveBorderColor, decal, isSelected ) ); // Compose symbols // PENDING if (!itemIcon && symbolType // At least show one symbol, can't be all none && ((symbolType !== legendSymbolType) || symbolType === 'none') ) { const size = itemHeight * 0.8; if (symbolType === 'none') { symbolType = 'circle'; } const legendSymbolCenter = createSymbol( symbolType, (itemWidth - size) / 2, (itemHeight - size) / 2, size, size, isSelected ? color : inactiveColor, // symbolKeepAspect default true for legend symbolKeepAspect == null ? true : symbolKeepAspect ); // Put symbol in the center itemGroup.add( setSymbolStyle( legendSymbolCenter, symbolType, legendModelItemStyle, borderColor, inactiveBorderColor, decal, isSelected ) ); } const textX = itemAlign === 'left' ? itemWidth + 5 : -5; const textAlign = itemAlign as ZRTextAlign; const formatter = legendModel.get('formatter'); let content = name; if (typeof formatter === 'string' && formatter) { content = formatter.replace('{name}', name != null ? name : ''); } else if (typeof formatter === 'function') { content = formatter(name); } itemGroup.add(new graphic.Text({ style: createTextStyle(textStyleModel, { text: content, x: textX, y: itemHeight / 2, fill: isSelected ? textStyleModel.getTextColor() : inactiveColor, align: textAlign, verticalAlign: 'middle' }) })); // Add a invisible rect to increase the area of mouse hover const hitRect = new graphic.Rect({ shape: itemGroup.getBoundingRect(), invisible: true }); const tooltipModel = itemModel.getModel('tooltip') as Model>; if (tooltipModel.get('show')) { const componentIndex = legendModel.componentIndex; const formatterParams: LegendTooltipFormatterParams = { componentType: 'legend', legendIndex: componentIndex, name: name, $vars: ['name'] }; getECData(hitRect).tooltipConfig = { componentMainType: legendModel.mainType, componentIndex: componentIndex, name: name, option: zrUtil.defaults({ content: name, formatterParams: formatterParams }, tooltipModel.option) }; } itemGroup.add(hitRect); itemGroup.eachChild(function (child) { child.silent = true; }); hitRect.silent = !selectMode; this.getContentGroup().add(itemGroup); enableHoverEmphasis(itemGroup); // @ts-ignore itemGroup.__legendDataIndex = dataIndex; return itemGroup; } protected layoutInner( legendModel: LegendModel, itemAlign: LegendOption['align'], maxSize: { width: number, height: number }, isFirstRender: boolean, selector: LegendOption['selector'], selectorPosition: LegendOption['selectorPosition'] ): ZRRectLike { const contentGroup = this.getContentGroup(); const selectorGroup = this.getSelectorGroup(); // Place items in contentGroup. layoutUtil.box( legendModel.get('orient'), contentGroup, legendModel.get('itemGap'), maxSize.width, maxSize.height ); const contentRect = contentGroup.getBoundingRect(); const contentPos = [-contentRect.x, -contentRect.y]; selectorGroup.markRedraw(); contentGroup.markRedraw(); if (selector) { // Place buttons in selectorGroup layoutUtil.box( // Buttons in selectorGroup always layout horizontally 'horizontal', selectorGroup, legendModel.get('selectorItemGap', true) ); const selectorRect = selectorGroup.getBoundingRect(); const selectorPos = [-selectorRect.x, -selectorRect.y]; const selectorButtonGap = legendModel.get('selectorButtonGap', true); const orientIdx = legendModel.getOrient().index; const wh: 'width' | 'height' = orientIdx === 0 ? 'width' : 'height'; const hw: 'width' | 'height' = orientIdx === 0 ? 'height' : 'width'; const yx: 'x' | 'y' = orientIdx === 0 ? 'y' : 'x'; if (selectorPosition === 'end') { selectorPos[orientIdx] += contentRect[wh] + selectorButtonGap; } else { contentPos[orientIdx] += selectorRect[wh] + selectorButtonGap; } //Always align selector to content as 'middle' selectorPos[1 - orientIdx] += contentRect[hw] / 2 - selectorRect[hw] / 2; selectorGroup.x = selectorPos[0]; selectorGroup.y = selectorPos[1]; contentGroup.x = contentPos[0]; contentGroup.y = contentPos[1]; const mainRect = {x: 0, y: 0} as ZRRectLike; mainRect[wh] = contentRect[wh] + selectorButtonGap + selectorRect[wh]; mainRect[hw] = Math.max(contentRect[hw], selectorRect[hw]); mainRect[yx] = Math.min(0, selectorRect[yx] + selectorPos[1 - orientIdx]); return mainRect; } else { contentGroup.x = contentPos[0]; contentGroup.y = contentPos[1]; return this.group.getBoundingRect(); } } /** * @protected */ remove() { this.getContentGroup().removeAll(); this._isFirstRender = true; } } function setSymbolStyle( symbol: graphic.Path | graphic.Image, symbolType: string, legendModelItemStyle: Model, borderColor: ZRColor, inactiveBorderColor: ZRColor, decal: PatternObject, isSelected: boolean ) { let itemStyle; if (symbolType !== 'line' && symbolType.indexOf('empty') < 0) { itemStyle = legendModelItemStyle.getItemStyle(); (symbol as graphic.Path).style.stroke = borderColor; (symbol as graphic.Path).style.decal = decal; if (!isSelected) { itemStyle.stroke = inactiveBorderColor; } } else { itemStyle = legendModelItemStyle.getItemStyle(['borderWidth', 'borderColor']); } (symbol as Displayable).setStyle(itemStyle); return symbol; } function dispatchSelectAction( seriesName: string, dataName: string, api: ExtensionAPI, excludeSeriesId: string[] ) { // downplay before unselect dispatchDownplayAction(seriesName, dataName, api, excludeSeriesId); api.dispatchAction({ type: 'legendToggleSelect', name: seriesName != null ? seriesName : dataName }); // highlight after select // TODO higlight immediately may cause animation loss. dispatchHighlightAction(seriesName, dataName, api, excludeSeriesId); } function isUseHoverLayer(api: ExtensionAPI) { const list = api.getZr().storage.getDisplayList(); let emphasisState: DisplayableState; let i = 0; const len = list.length; while (i < len && !(emphasisState = list[i].states.emphasis)) { i++; } return emphasisState && emphasisState.hoverLayer; } function dispatchHighlightAction( seriesName: string, dataName: string, api: ExtensionAPI, excludeSeriesId: string[] ) { // If element hover will move to a hoverLayer. if (!isUseHoverLayer(api)) { api.dispatchAction({ type: 'highlight', seriesName: seriesName, name: dataName, excludeSeriesId: excludeSeriesId }); } } function dispatchDownplayAction( seriesName: string, dataName: string, api: ExtensionAPI, excludeSeriesId: string[] ) { // If element hover will move to a hoverLayer. if (!isUseHoverLayer(api)) { api.dispatchAction({ type: 'downplay', seriesName: seriesName, name: dataName, excludeSeriesId: excludeSeriesId }); } } export default LegendView;