LegendVisualProvider.js 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. /*
  2. * Licensed to the Apache Software Foundation (ASF) under one
  3. * or more contributor license agreements. See the NOTICE file
  4. * distributed with this work for additional information
  5. * regarding copyright ownership. The ASF licenses this file
  6. * to you under the Apache License, Version 2.0 (the
  7. * "License"); you may not use this file except in compliance
  8. * with the License. You may obtain a copy of the License at
  9. *
  10. * http://www.apache.org/licenses/LICENSE-2.0
  11. *
  12. * Unless required by applicable law or agreed to in writing,
  13. * software distributed under the License is distributed on an
  14. * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  15. * KIND, either express or implied. See the License for the
  16. * specific language governing permissions and limitations
  17. * under the License.
  18. */
  19. /*
  20. * Licensed to the Apache Software Foundation (ASF) under one
  21. * or more contributor license agreements. See the NOTICE file
  22. * distributed with this work for additional information
  23. * regarding copyright ownership. The ASF licenses this file
  24. * to you under the Apache License, Version 2.0 (the
  25. * "License"); you may not use this file except in compliance
  26. * with the License. You may obtain a copy of the License at
  27. *
  28. * http://www.apache.org/licenses/LICENSE-2.0
  29. *
  30. * Unless required by applicable law or agreed to in writing,
  31. * software distributed under the License is distributed on an
  32. * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  33. * KIND, either express or implied. See the License for the
  34. * specific language governing permissions and limitations
  35. * under the License.
  36. */
  37. /**
  38. * LegendVisualProvider is an bridge that pick encoded color from data and
  39. * provide to the legend component.
  40. * @param {Function} getDataWithEncodedVisual Function to get data after filtered. It stores all the encoding info
  41. * @param {Function} getRawData Function to get raw data before filtered.
  42. */
  43. function LegendVisualProvider(getDataWithEncodedVisual, getRawData) {
  44. this.getAllNames = function () {
  45. var rawData = getRawData(); // We find the name from the raw data. In case it's filtered by the legend component.
  46. // Normally, the name can be found in rawData, but can't be found in filtered data will display as gray.
  47. return rawData.mapArray(rawData.getName);
  48. };
  49. this.containName = function (name) {
  50. var rawData = getRawData();
  51. return rawData.indexOfName(name) >= 0;
  52. };
  53. this.indexOfName = function (name) {
  54. // Only get data when necessary.
  55. // Because LegendVisualProvider constructor may be new in the stage that data is not prepared yet.
  56. // Invoking Series#getData immediately will throw an error.
  57. var dataWithEncodedVisual = getDataWithEncodedVisual();
  58. return dataWithEncodedVisual.indexOfName(name);
  59. };
  60. this.getItemVisual = function (dataIndex, key) {
  61. // Get encoded visual properties from final filtered data.
  62. var dataWithEncodedVisual = getDataWithEncodedVisual();
  63. return dataWithEncodedVisual.getItemVisual(dataIndex, key);
  64. };
  65. }
  66. var _default = LegendVisualProvider;
  67. module.exports = _default;