Area
Basic Configuration
- React
- Angular
- Svelte
- Vue
- TypeScript
import { VisXYContainer, VisArea } from '@unovis/react'
function Component(props) {
const data: DataRecord[] = props.data
const x = (d: DataRecord) => d.x
const y = (d: DataRecord) => d.y
return (
<VisXYContainer data={data}>
<VisArea x={x} y={y}/>
</VisXYContainer>
)
}
@Component({
templateUrl: 'template.html'
})
export class Component {
@Input data: DataRecord[];
x = (d: DataRecord) => d.x
y = (d: DataRecord) => d.y
}
<vis-xy-container [data]="data">
<vis-area [x]="x" [y]="y"></vis-area>
</vis-xy-container>
<script lang='ts'>
import { VisXYContainer, VisArea } from '@unovis/svelte'
export let data: DataRecord[]
const x = (d: DataRecord) => d.x
const y = (d: DataRecord) => d.y
</script>
<VisXYContainer {data}>
<VisArea {x} {y}/>
</VisXYContainer>
<script setup lang="ts">
import { VisXYContainer, VisArea } from '@unovis/vue'
const props = defineProps<{ data: DataRecord[] }>()
const x = (d: DataRecord) => d.x
const y = (d: DataRecord) => d.y
</script>
<template>
<VisXYContainer :data="data">
<VisArea :x="x" :y="y" />
</VisXYContainer>
</template>
import { XYContainer, Area } from '@unovis/ts'
import { data, DataRecord } from './data'
const container = new XYContainer<DataRecord>(node, {
components: [
new Area<DataRecord>({
x: (d: DataRecord) => d.x,
y: (d: DataRecord) => d.y
})
]
}, data)
Curve Types
Using the curveType: CurveType
property you can set various curve type options. For example:
- React
- Angular
- Svelte
- Vue
- TypeScript
<VisArea curveType="basis" x={x} y={y}/>
<vis-area curveType="basis" [x]="x" [y]="y"></vis-area>
<VisArea curveType="basis" {x} {y}/>
<VisArea curveType="basis" :x="x" :y="y" />
const area = new Area<DataRecord>({ curveType: "basis", x, y })
Learn more about configurable curves from D3's documentation
Color
Setting color for a single Area component is simple, you can achieve that just by setting the color
property of the component to a hex string.
- React
- Angular
- Svelte
- Vue
- TypeScript
<VisArea color="#19cb9a" x={x} y={y}/>
<vis-area color="#19cb9a" [x]="x" [y]="y"></vis-area>
<VisArea color="#19cb9a" {x} {y}/>
<VisArea color="#19cb9a" :x="x" :y="y" />
const area = new Area<DataRecord>({ color: "#19cb9a", x, y })
Stacked Areas
Y Accessors
Area can accept an array of y
accessors to display stacked areas from your provided data.
Note: It is important that an array of accessors or provided, not a single accessor which returns an array. For example, if you wanted to generate a chart with three areas of random data:
/* ✅ Do this */
const y = [
() => Math.random(),
() => Math.random(),
() => Math.random(),
]
/* ⛔ Not this */
const y = d => [Math.random(), Math.random(), Math.random()]
Multiple Colors
If you want to configure multiple colors for your Area component, you'll have to supply a single accessor. A common configuration is to utilize the data's index:
- React
- Angular
- Svelte
- Vue
- TypeScript
import { VisXYContainer, VisArea } from '@unovis/react'
function Component(props) {
const data: DataRecord[] = props.data
const x = (d: DataRecord) => d.x
const y = [
(d: DataRecord) => d.y,
(d: DataRecord) => d.y1,
(d: DataRecord) => d.y2
]
const color = (d: DataRecord, i: number) => ['red','green','blue'][i]
return (
<VisXYContainer data={data}>
<VisArea x={x} y={y} color={color}/>
</VisXYContainer>
)
}
@Component({
templateUrl: 'template.html'
})
export class Component {
@Input data: DataRecord[];
x = (d: DataRecord) => d.x
y = [
(d: DataRecord) => d.y,
(d: DataRecord) => d.y1,
(d: DataRecord) => d.y2
]
color = (d: DataRecord, i: number) => ['red','green','blue'][i]
}
<vis-xy-container [data]="data">
<vis-area [x]="x" [y]="y" [color]="color"></vis-area>
</vis-xy-container>
<script lang='ts'>
import { VisXYContainer, VisArea } from '@unovis/svelte'
export let data: DataRecord[]
const x = (d: DataRecord) => d.x
const y = [
(d: DataRecord) => d.y,
(d: DataRecord) => d.y1,
(d: DataRecord) => d.y2
]
const color = (d: DataRecord, i: number) => ['red','green','blue'][i]
</script>
<VisXYContainer {data}>
<VisArea {x} {y} {color}/>
</VisXYContainer>
<script setup lang="ts">
import { VisXYContainer, VisArea } from '@unovis/vue'
const props = defineProps<{ data: DataRecord[] }>()
const x = (d: DataRecord) => d.x
const y = [
(d: DataRecord) => d.y,
(d: DataRecord) => d.y1,
(d: DataRecord) => d.y2
]
const color = (d: DataRecord, i: number) => ['red','green','blue'][i]
</script>
<template>
<VisXYContainer :data="data">
<VisArea :x="x" :y="y" :color="color" />
</VisXYContainer>
</template>
import { XYContainer, Area } from '@unovis/ts'
import { data, DataRecord } from './data'
const container = new XYContainer<DataRecord>(node, {
components: [
new Area<DataRecord>({
x: (d: DataRecord) => d.x,
y: [
(d: DataRecord) => d.y,
(d: DataRecord) => d.y1,
(d: DataRecord) => d.y2
],
color: (d: DataRecord, i: number) => ['red','green','blue'][i]
})
]
}, data)
Dealing with small values
If your data has small or zero values leading to some parts of the area to become invisible, you can force those area segments to have 1px height
despite their actual value by setting minHeight1Px
to true
. This can be useful if you want to visually emphasize that the data behind the chart
is defined but just very small.
- React
- Angular
- Svelte
- Vue
- TypeScript
<VisArea minHeight1Px={true} x={x} y={y}/>
<vis-area [minHeight1Px]="true" [x]="x" [y]="y"></vis-area>
<VisArea minHeight1Px={true} {x} {y}/>
<VisArea :minHeight1Px="true" :x="x" :y="y" />
const area = new Area<DataRecord>({ minHeight1Px: true, x, y })
Events
The Area component supports the following events:
import { Area } from '@unovis/ts'
events = [Area.selectors.area]: {
click: (data: DataRecord[]) => {},
mouseover: (data: DataRecord[]) => {},
mouseleave: (data: DataRecord[]) => {}
}
- React
- Angular
- Svelte
- Vue
- TypeScript
<VisArea x={x} y={y} events={events}/>
<vis-area [x]="x" [y]="y" [events]="events"></vis-area>
<VisArea {x} {y} {events}/>
<VisArea :x="x" :y="y" :events="events" />
const area = new Area<DataRecord>({ x, y, events })
CSS Variables
The Area component supports additional styling via CSS variables that you can define for your visualization container. For example:
.custom-area {
--vis-area-fill-opacity: 0.5;
--vis-area-hover-fill-opacity: 1;
--vis-area-stroke-width: 1px;
Supported CSS variables and their default values
--vis-area-cursor: default;
--vis-area-fill-opacity: 1;
--vis-area-stroke-color: none;
--vis-area-stroke-width: 0px;
--vis-area-stroke-dasharray: none;
--vis-area-stroke-opacity: 1;
--vis-area-hover-fill-opacity: none;
--vis-area-hover-stroke-width: none;
/* Dark Theme */
--vis-dark-area-stroke-color: none;
Component Props
Name | Type | Description |
---|---|---|
* required property |