pencil.js / text / TextOptions
Interface: TextOptions
Defined in: text.ts:12
Text options
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
align | CanvasTextAlign | Text horizontal alignment | - | text.ts:18 |
bold | boolean | Use bold font-weight | - | text.ts:20 |
cap? | CanvasLineCap | How lines end | RectangleOptions.cap | component.ts:85 |
clip | | Component<ComponentOptions> | null | Other component used to clip the rendering | RectangleOptions.clip | container.ts:26 |
cursor | string | null | Cursor to use when hover | RectangleOptions.cursor | component.ts:81 |
dashed | boolean | number[] | Should the line be dashed, you can also specify the dash pattern (ex: [4, 4] or Component.dashes.dots) | RectangleOptions.dashed | component.ts:79 |
fill | Style | Color used to fill, set to null for transparent | RectangleOptions.fill | component.ts:73 |
font | string | Font to use (can be a URL) | - | text.ts:14 |
fontSize | number | Size of the text in pixels | - | text.ts:16 |
italic | boolean | Use italic font-style | - | text.ts:22 |
join | CanvasLineJoin | How lines join between them | RectangleOptions.join | component.ts:83 |
lineHeight | number | Ratio of line height (1 is normal, 2 is twice the space) | - | text.ts:26 |
opacity | number | null | Opacity level from 0 to 1 (multiplied with its parents opacity, null means 1) | RectangleOptions.opacity | container.ts:16 |
origin | | string | PositionDefinition | Relative offset (Rectangle based shapes also accept named origins like "center") | RectangleOptions.origin | component.ts:87 |
rotation | number | Rotation ratio from 0 to 1 (clockwise) | RectangleOptions.rotation | container.ts:18 |
rotationCenter | PositionDefinition | Center of rotation relative to this position | RectangleOptions.rotationCenter | container.ts:20 |
rounded | number | DOMPointInit | (number | DOMPointInit)[] | Radius of the corners (or a list of radii, see https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/roundRect) | RectangleOptions.rounded | rectangle.ts:10 |
scale | | number | PositionDefinition | Scaling ratio or a pair of value for horizontal and vertical scaling | RectangleOptions.scale | container.ts:22 |
shadow | Partial<ShadowOptions> | Set of options to set a shadow | RectangleOptions.shadow | component.ts:89 |
shown | boolean | Is shown | RectangleOptions.shown | container.ts:14 |
stroke | Style | Color used to stroke, set to null for transparent | RectangleOptions.stroke | component.ts:75 |
strokeWidth | number | Stroke line thickness in pixels | RectangleOptions.strokeWidth | component.ts:77 |
underscore | boolean | Draw a line under the text | - | text.ts:24 |
zIndex | number | Depth ordering | RectangleOptions.zIndex | container.ts:24 |