Skip to main content

Interface: ColorBarOptions

Defined in: ColorBar.ts:12

Options for ColorBars

Properties

PropertyTypeDescriptionDefined in
fontface?stringA font face to use for the label and tick values. Default 'sans-serif'ColorBar.ts:51
label?stringThe label to place along the color barColorBar.ts:14
orientation?ColorbarOrientationThe orientation for the color bar. Valid values are 'horizontal' and 'vertical'. Default 'vertical'ColorBar.ts:45
outline_and_text_color?stringThe color for the color bar outline and the text Default '#000000'ColorBar.ts:63
size_long?numberThe size in pixels along the long axis of the colorbar Default 600ColorBar.ts:20
size_short?numberThe size in pixels along the short axis of the colorbar Default size_long / 9ColorBar.ts:26
tick_direction?ColorbarTickDirectionThe direction the ticks should face. Valid values are 'left' and 'right' if orientation is 'vertical' and 'top' and 'bottom' if orientation is 'horizontal'. Default 'left' if orientation is 'vertical' and 'bottom' if orientation is 'horizontal'ColorBar.ts:39
ticklabelsize?numberThe font size (in points) to use for the tick labels Default 12ColorBar.ts:57
ticks?number[]An array of numbers to use as the tick locations. Default Use all the levels in the color map provided to makeColorBar.ColorBar.ts:32