heatmap-filter

Adams
1,348
Install
npm install heatmap-filter
Latest Version:1.9.7
Vue:3
Last Updated:Nov 5, 2024
Links: GitHub  ·  npm
Maintainer: adams-eugene
## Adams

Heatmap filter component

A filter component to be used only by heatmap.com devs component export tutorial.

🚀 Installation

Install using your package manager of choice:

pnpm add heatmap-filter

📺 Demo

https://matija-components.vercel.app/tri-state-checkbox

⚙️ Usage

Import the component locally or define it globally and include the css file:

<template>
  <!-- create a reset button that dispatched  "reset-all-filters-event"-->
  <button @click="resetAll">reset</button> 
  <!-- disabled comparison mode -->
    <button @click="disabledComparison">disabled Comparison</button>
  <!-- enabled comparison mode -->
  <button @click="enabledComparison">enabled Comparison</button>
  <!-- call the HeatmapFilter -->
  <HeatmapFilter @on-filter-values-change="filterValueChanged" />
  
</template>

<script lang="ts" setup>
import { HeatmapFilter } from "heatmap-filter";

const filterValueChanged = (value: ReturnData[]) => {
  console.log(value);
  // do your stuff here
};

// when ever reset button is clicked, dispatch this event
const resetAll = () => {
  const resetAllEvent = new CustomEvent("reset-all-filters-event");
  document.dispatchEvent(resetAllEvent);
};

const disabledComparison = () => {
  const resetAllEvent = new CustomEvent("disable-comparison-event", {
    detail: { disabled: true },
  });
  document.dispatchEvent(resetAllEvent);
};

const enabledComparison = () => {
  const resetAllEvent = new CustomEvent("disable-comparison-event", {
    detail: { disabled: false },
  });
  document.dispatchEvent(resetAllEvent);
};

</script>

📃 Emitters

Name Type Default Description
on-filter-values-change func get the selected filters by listening to this event

📃 Custom Events

Name Type Default Description
reset-all-filters-event func for resetting all filters

Related Packages

@opengis/filter

A flexible and extensible filter component system for Vue 3. Ideal for building...

10,212 0
vue-timeago

A timeago filter for Vue.

467,807 717
vue-truncate-filter

A filter for VueJs to truncate string

78,257 56
vue-filter

A collection of Vue.js filter.

35,738

Version History

Version Released Vue License
1.9.7 ^3.0.0
1.9.6 ^3.0.0
1.9.5 ^3.0.0
1.9.4 ^3.0.0
1.9.3 ^3.0.0