0.0.7 • Published 8 months ago

@hsu-canvas/renderer v0.0.7

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

Canvas Renderer

前言

canvas-renderer 一些生成 canvas 的渲染器

安装

npm install --save @hsu-canvas/renderer
# 或
yarn add @hsu-canvas/renderer

方法

TextGraphics API

参数说明类型默认值备注
options文本渲染参数TextGraphicsOptions--

TextGraphicsOptions

参数说明类型默认值备注
content渲染文本string | string[]--
borderStyle边框样式BorderStyle--
backgroundStyle背景样式BackgroundStyle--
fontStyle字体样式FontStyle--
padding内距Padding0-
sizecanvas 大小Size | Size, Size'auto', 'auto'bgImg 只在 backgroundStyle 中设置了 image 时生效
align对齐方式Aligncenter-
rowGap文本间隔number0-

BorderStyle

参数说明类型默认值备注
color边框颜色string--
width边框宽度number0-
radius边框圆角Radius0-

BackgroundStyle

参数说明类型默认值备注
color背景颜色string | LinearGradient-与 image 互斥
colorDirection背景颜色方向Directionhorizontal-
image背景图片string-与 color 互斥
imageSize背景图片大小string, string | string-百分比或数字
imagePosition背景图片位置number, number | number--
imageFill背景填充Fillctx会被 imageSize 覆盖

FontStyle

参数说明类型默认值备注
font字体Font--
color颜色string | LinearGradient#000-
textAlign文字对齐TextAligncenter-
letterSpacing文字间隔number0-
border文字边框TextBorderStyle--
shadow文字阴影TextShadowStyle | TextShadowStyle[]--

Padding

type Padding = number | number, number | number, number, number, number

Size

type Size = number | 'auto' | 'bgImg'

Align

type Align = 'top' | 'center' | 'bottom'

Radius

type Radius = number | number, number, number, number

LinearGradient

interface LinearGradient {
  [key: number]: string
}

key 的范围为 0 - 1

Direction

type Direction = 'vertical' | 'horizontal'

Fill

type Fill = 'ctx' | 'img'

类型说明
ctx图片大小为 canvas 大小
img图片大小为图片自身大小

Font

参数说明类型默认值备注
size字体大小number10-
style字体样式stringnormal-
variant字体变体stringnormal-
weight字体粗细stringnormal-
family字体系列stringsans-serif-

TextAlign

type TextAlign = 'left' | 'center' | 'right'

TextBorderStyle

参数说明类型默认值备注
color边框颜色string#000-
width边框宽度number0-

TextShadowStyle

参数说明类型默认值备注
color阴影颜色string#000-
blur阴影模糊度number0-
offsetX阴影水平偏移距离number0-
offsetY阴影垂直偏移距离number0-

ImageGraphics API

参数说明类型默认值备注
options图片渲染参数ImageGraphicsOptions--

ImageGraphicsOptions

参数说明类型默认值备注
imgs图片string | ImageItem | Array<string | ImageItem>-必填
padding内边距Padding0-
direction布局样式Directionvertical-
gap间隔number0-
imgAlign对齐方式ImgAligncenter-
widthcanvas 宽度number | 'auto'autoauto 时为图片最大宽度
heightcanvas 高度number | 'auto'autoauto 时为图片最大高度

ImageItem

参数说明类型默认值备注
url图片地址string-必填
width宽度number图片宽度-
height高度number图片高度-
zIndex图片层级number0-

Padding(Image)

type Padding = number | number, number | number, number, number, number

Direction(Image)

type Direction = 'vertical' | 'horizontal'

ImgAlign

type ImgAlign = 'start' | 'center' | 'end'

loadImage API

参数说明类型默认值备注
url图片地址string-必填

License

MIT

0.0.7

8 months ago

0.0.6

8 months ago

0.0.5

8 months ago

0.0.4

8 months ago

0.0.3

8 months ago

0.0.2

8 months ago

0.0.1

8 months ago