RealRenderer | SVG Real Renderer

General Real Renderer with no specific purpose. Should be extended to use.

Type parameters

EventTypes: IRealRendererEvents = IRealRendererEvents

Hierarchy

EventEmitter<EventTypes>
- RealRenderer
  - RealDrawBoard

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RealRenderer<EventTypes>(options: RealRendererOptions, eventList?: keyof EventTypes[]): RealRenderer<EventTypes>

Overrides EventEmitter<EventTypes>.constructor
- Defined in src/renderers/RealRenderer/RealRenderer.ts:67
Type parameters
- EventTypes: IRealRendererEvents = IRealRendererEvents
Parameters
- options: RealRendererOptions
- eventList: keyof EventTypes[] = ...
Returns RealRenderer<EventTypes>

Properties

_doRender

_doRender: boolean

_offsetX

_offsetX: number = 0

_offsetY

_offsetY: number = 0

_strokeIndex

_strokeIndex: number = -1

attach

attach: (svg: SVGSVGElement, dimensions: GraphDimensions) => RealRenderer<IRealRendererEvents> = ...

Type declaration

- (svg: SVGSVGElement, dimensions: GraphDimensions): RealRenderer<IRealRendererEvents>
- Attaches to a DOM SVG element to render to.
  
  Parameters
  - svg: SVGSVGElement
    
    The SVG element to attach.
  - dimensions: GraphDimensions
    
    Dimensions of the graph.
  Returns RealRenderer<IRealRendererEvents>
  
  Self for chaining.

bgColor

bgColor: Color

bgType

bgType: BGType

changeBackground

changeBackground: (newBG: BGType) => RealRenderer<IRealRendererEvents> = ...

Type declaration

- (newBG: BGType): RealRenderer<IRealRendererEvents>
- Changes the background of the graph.
  
  Parameters
  - newBG: BGType
    
    New background.
  Returns RealRenderer<IRealRendererEvents>
  
  Self for chaining.

changeOffsets

changeOffsets: (xOffset: number, yOffset: number) => RealRenderer<IRealRendererEvents> = ...

Type declaration

- (xOffset: number, yOffset: number): RealRenderer<IRealRendererEvents>
- Change the offsets of the graph (for panning)
  
  Parameters
  - xOffset: number
    
    Offset in the x-direction.
  - yOffset: number
    
    Offset in the y-direction.
  Returns RealRenderer<IRealRendererEvents>
  
  Self for chaining.

dimensions

dimensions: GraphDimensions

draw

draw: (numDraws: number) => RealRenderer<IRealRendererEvents> = ...

Type declaration

- (numDraws: number): RealRenderer<IRealRendererEvents>
- Draw a certain number of frames.
  
  Parameters
  - numDraws: number
    
    Number of frames to draw.
  Returns RealRenderer<IRealRendererEvents>
  
  Self for chaining.

drawsPerFrame

drawsPerFrame: number

eventHandlers

eventHandlers: {[ Event in string | number | symbol]: Map<string, (params: EventTypes[Event]) => void> } = {}

exportData

exportData: () => IRealExportV2 = ...

Type declaration

- (): IRealExportV2
- Export the data of the graph in a certain format that can be used to load the data later. Load using .importData().
  
  Returns IRealExportV2
  
  Data of the graph in a storable and loadable format.

importData

importData: (data: RealExport) => RealRenderer<IRealRendererEvents> = ...

Type declaration

- (data: RealExport): RealRenderer<IRealRendererEvents>
- Import the data exported by .export() method.
  
  Parameters
  - data: RealExport
    
    Data exported by .export()
  Returns RealRenderer<IRealRendererEvents>
  
  Self for chaining.

originalDimensions

originalDimensions: GraphDimensions

redo

redo: (numRedo: number) => RealRenderer<IRealRendererEvents> = ...

Type declaration

- (numRedo: number): RealRenderer<IRealRendererEvents>
- Redos a certain number of strokes drawn on the graph.
  
  Parameters
  - numRedo: number
    
    Number of strokes to redo.
  Returns RealRenderer<IRealRendererEvents>
  
  Self for chaining.

scale

scale: (scaleFactor: number) => RealRenderer<IRealRendererEvents> = ...

Type declaration

- (scaleFactor: number): RealRenderer<IRealRendererEvents>
- Scale/zoom the graph.
  
  Parameters
  - scaleFactor: number
    
    Factor to scale the graph by. Larger number zooms in.
  Returns RealRenderer<IRealRendererEvents>
  
  Self for chaining.

scaleFactor

scaleFactor: number

strokes

strokes: Stroke[] = []

svg

svg: SVGSVGElement

svgSections

svgSections: SVGSections

time

time: number

timeStep

timeStep: number

toggleRender

toggleRender: () => RealRenderer<IRealRendererEvents> = ...

Type declaration

- (): RealRenderer<IRealRendererEvents>
- Toggle rendering.
  
  Returns RealRenderer<IRealRendererEvents>
  
  Self for chaining.

undo

undo: (numUndo: number) => RealRenderer<IRealRendererEvents> = ...

Type declaration

- (numUndo: number): RealRenderer<IRealRendererEvents>
- Undos a certain number of strokes drawn on the graph.
  
  Parameters
  - numUndo: number
    
    Number of strokes to undo.
  Returns RealRenderer<IRealRendererEvents>
  
  Self for chaining.

Static getExportVersion

getExportVersion: (data: RealExport) => 2 | 1 = ...

Type declaration

- (data: RealExport): 2 | 1
- Parameters
  - data: RealExport
  Returns 2 | 1

Methods

emit

emit<Event>(eventName: Event, parameters: EventTypes[Event]): void

Inherited from EventEmitter.emit
- Defined in src/renderers/RealRenderer/events/eventEmitter.ts:28
Type parameters
- Event: string | number | symbol
Parameters
- eventName: Event
- parameters: EventTypes[Event]
Returns void

off

off<Event>(eventName: Event, handlerName: string): void

Inherited from EventEmitter.off
- Defined in src/renderers/RealRenderer/events/eventEmitter.ts:21
Type parameters
- Event: string | number | symbol
Parameters
- eventName: Event
- handlerName: string
Returns void

on

on<Event>(eventName: Event, handlerName: string, handler: (params: EventTypes[Event]) => void): void

Inherited from EventEmitter.on
- Defined in src/renderers/RealRenderer/events/eventEmitter.ts:12
Type parameters
- Event: string | number | symbol
Parameters
- eventName: Event
- handlerName: string
- handler: (params: EventTypes[Event]) => void
  - - (params: EventTypes[Event]): void
    - Parameters
      - params: EventTypes[Event]
      Returns void
Returns void

reset

reset(): RealRenderer<EventTypes>

- Defined in src/renderers/RealRenderer/RealRenderer.ts:112
Resets everything regarding the graph.

Returns RealRenderer<EventTypes>

Self for chaining.

resetTime

resetTime(): RealRenderer<EventTypes>

- Defined in src/renderers/RealRenderer/RealRenderer.ts:102
Resets the internal time counter.

Returns RealRenderer<EventTypes>

Self for chaining.

Type parameters

EventTypes: IRealRendererEvents = IRealRendererEvents

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

EventTypes: IRealRendererEvents = IRealRendererEvents

Parameters

options: RealRendererOptions

eventList: keyof EventTypes[] = ...

Returns RealRenderer<EventTypes>

Properties

_doRender

_offsetX

_offsetY

_strokeIndex

attach

Type declaration

Parameters

svg: SVGSVGElement

dimensions: GraphDimensions

Returns RealRenderer<IRealRendererEvents>

bgColor

bgType

changeBackground

Type declaration

Parameters

newBG: BGType

Returns RealRenderer<IRealRendererEvents>

changeOffsets

Type declaration

Parameters

xOffset: number

yOffset: number

Returns RealRenderer<IRealRendererEvents>

dimensions

draw

Type declaration

Parameters

numDraws: number

Returns RealRenderer<IRealRendererEvents>

drawsPerFrame

eventHandlers

exportData

Type declaration

Returns IRealExportV2

importData

Type declaration

Parameters

data: RealExport

Returns RealRenderer<IRealRendererEvents>

originalDimensions

redo

Type declaration

Parameters

numRedo: number

Returns RealRenderer<IRealRendererEvents>

scale

Type declaration

Parameters

scaleFactor: number

Returns RealRenderer<IRealRendererEvents>

scaleFactor

settings

startRender

Type declaration

Returns RealRenderer<IRealRendererEvents>

stopRender

Type declaration

Returns RealRenderer<IRealRendererEvents>

strokes

svg

svgSections

time

timeStep

toggleRender