Class StringRenderer

Render to a string

Hierarchy

Renderer<string>
- StringRenderer

Index

Constructors

Properties

_callback _chars defaultRenderAs renderInfo

Methods

get_height get_width modifyElement renderPixel reset set_height set_width update

Constructors

constructor

new StringRenderer(callback: ((string: string) => void)): StringRenderer
Parameters
- callback: ((string: string) => void)
  
  A function called on update. Passed a string with the renderable state of the PixelManipulator
  - - (string: string): void
    - Parameters
      
      string: string
      
      Returns void
Returns StringRenderer
Overrides Renderer.constructor
- Defined in renderers.ts:204

Properties

`Readonly` _callback

_callback: ((string: string) => void)

Type declaration

- (string: string): void
- The callback function passed to the constructor. Called on update
  Parameters
  - string: string
  Returns void

`Private` _chars

_chars: string[][] = []

defaultRenderAs

defaultRenderAs: string = ' '

The renderAs value for the default element

renderInfo

renderInfo: string[] = []

Ordered by ID, the renderAs info for each element.

Methods

get_height

get_height(): number
Returns
the height of the canvas

Returns number
Inherited from Renderer.get_height
- Defined in renderers.ts:111

get_width

get_width(): number
Returns
the width of the canvas

Returns number
Inherited from Renderer.get_width
- Defined in renderers.ts:100

modifyElement

modifyElement(id: number, newRenderAs: string): string
Parameters
- id: number
- newRenderAs: string
  
  The proposed character to use. Must be 1 char long and unique
Returns string
Overrides Renderer.modifyElement
- Defined in renderers.ts:210

renderPixel

renderPixel(__namedParameters: Location, id: number): void
Parameters
- __namedParameters: Location
- id: number
  
  The id of the pixel
Returns void
Overrides Renderer.renderPixel
- Defined in renderers.ts:232

reset

reset(): void
Reset the render target.

Returns void
Overrides Renderer.reset
- Defined in renderers.ts:220

set_height

set_height(value: number): void
Parameters
- value: number
  
  The new height of the canvas
Returns void
Inherited from Renderer.set_height
- Defined in renderers.ts:106

set_width

set_width(value: number): void
Parameters
- value: number
  
  The new width of the canvas
Returns void
Inherited from Renderer.set_width
- Defined in renderers.ts:95

update

update(): void
Update the render target. Draws all changes queued up by renderPixel.

Returns void
Overrides Renderer.update
- Defined in renderers.ts:236

Generated using TypeDoc