Heatmap chart

Category: Visualisation

Status: Registered and callable in the CyberChef 11.3.0 compatibility inventory.

Input / output: string → html

Background: https://wikipedia.org/wiki/Heat_map

What it does

A heatmap is a graphical representation of data where the individual values contained in a matrix are represented as colors.

Note

Status here means the operation name is implemented and callable. It does not by itself promise byte-for-byte parity for every upstream option. See Compatibility and current status for the verified scope and known boundaries.

Arguments and options

Arguments are positional. Keep their order when using bake() or Pipeline.then().

Index	Name	UI type	PyChef default	Accepted values / format
`0`	Record delimiter	`option`	`'Line feed'`	`'Line feed'`, `'CRLF'`
`1`	Field delimiter	`option`	`'Comma'`	`'Space'`, `'Comma'`, `'Semi-colon'`, `'Colon'`, `'Tab'`
`2`	Number of vertical bins	`number`	`25`	A Python integer or floating-point value
`3`	Number of horizontal bins	`number`	`25`	A Python integer or floating-point value
`4`	Use column headers as labels	`boolean`	`True`	`True` or `False`
`5`	X label	`string`	`''`	`''`
`6`	Y label	`string`	`''`	`''`
`7`	Draw bin edges	`boolean`	`False`	`True` or `False`
`8`	Min colour value	`string`	`'white'`	A Python string
`9`	Max colour value	`string`	`'black'`	A Python string

Recipe template

Important

This is a call template built from the documented defaults. Replace placeholder values such as empty keys, paths, patterns, or lookup data before running it.

from pychef import bake

input_value = "example"
args = ['Line feed', 'Comma', 25, 25, True, '', '', False, 'white', 'black']
result = bake(input_value, [{"op": 'Heatmap chart', "args": args}])
print(result)

Pipeline example

from pychef import Pipeline

args = ['Line feed', 'Comma', 25, 25, True, '', '', False, 'white', 'black']
transform = Pipeline().then('Heatmap chart', *args)
result = transform("example")

Dedicated operation module

The registered entry point lives in pychef.operations.by_operation.heatmap_chart. Direct calls receive the input value and a positional argument tuple:

from pychef.operations.by_operation.heatmap_chart import run

result = run("example", tuple(['Line feed', 'Comma', 25, 25, True, '', '', False, 'white', 'black']))

pychef.operations.by_operation.heatmap_chart.run(value, args)

Run this operation using its shared internal implementation.

Parameters:

value (str | bytes)
args (Sequence[Any])

Return type:

str | bytes