Class Renderer

Hierarchy

Renderer

Implements

IDisposable

Index

Constructors

Properties

backgroundElt container isDisposed options renderableItems size stage stageElt

Methods

add contains createLayer createLayers destroyLayer destroyLayers dispose getAvailableSize getContainer getLayer getSize getStage remove setCursor setSize

Constructors

constructor

new Renderer(elementSelector: string, size: Size, options: RendererOptions): Renderer
Creates new instance of renderer.
Parameters
- elementSelector: string
  
  Selector of HTML element where to create renderer.
- size: Size
  
  Renderer size
- options: RendererOptions
  
  renderer options
Returns Renderer
- Defined in projects/some-charts-lib/src/renderer/renderer.ts:34

Properties

`Private` `Readonly` backgroundElt

backgroundElt: JQuery<HTMLElement>

`Private` container

container: JQuery<HTMLElement>

`Private` isDisposed

isDisposed: boolean = false

`Private` options

options: RendererOptions

`Private` renderableItems

renderableItems: RenderableItem[]

`Private` size

size: Size

`Private` `Readonly` stage

stage: Stage

`Private` `Readonly` stageElt

stageElt: JQuery<HTMLElement>

Methods

add

add(item: RenderableItem): void
Adds specified item for rendering.
Parameters
- item: RenderableItem
  
  Item to add for rendering.
Returns void
- Defined in projects/some-charts-lib/src/renderer/renderer.ts:112

contains

contains(item: RenderableItem): boolean
Returns true if the renderer contains this renderable item.

Returns
Parameters
- item: RenderableItem
  
  renderable item;
Returns boolean
- Defined in projects/some-charts-lib/src/renderer/renderer.ts:122

createLayer

createLayer(layerConfig: LayerConfig): void
Creates layer on renderer with specified name.
Parameters
- layerConfig: LayerConfig
  
  Config of the layer.
Returns void
- Defined in projects/some-charts-lib/src/renderer/renderer.ts:187

createLayers

createLayers(layersConfigs: LayerConfig[]): void
Creates multiple layers on renderer with specified configs.
Parameters
- layersConfigs: LayerConfig[]
  
  Array of layers configs.
Returns void
- Defined in projects/some-charts-lib/src/renderer/renderer.ts:197

destroyLayer

destroyLayer(layerId: string): void
Destroys layer on renderer with specified id.
Parameters
- layerId: string
  
  Id of the layer.
Returns void
- Defined in projects/some-charts-lib/src/renderer/renderer.ts:207

destroyLayers

destroyLayers(layersIds: string[]): void
Destroys multiple layers on renderer with specified ids.
Parameters
- layersIds: string[]
  
  Array of layers ids.
Returns void
- Defined in projects/some-charts-lib/src/renderer/renderer.ts:215

dispose

dispose(): void
Disposes the renderer

Returns void
Implementation of IDisposable.dispose
- Defined in projects/some-charts-lib/src/renderer/renderer.ts:93

getAvailableSize

getAvailableSize(margin: number): Size
Returns available size on renderer for element with specified margin.

Returns
number
Parameters
- margin: number
  
  Element margin.
Returns Size
- Defined in projects/some-charts-lib/src/renderer/renderer.ts:149

getContainer

getContainer(): HTMLDivElement
Returns renderer's containing HTML element.

Returns

Returns HTMLDivElement
- Defined in projects/some-charts-lib/src/renderer/renderer.ts:172

getLayer

getLayer(layerId: string): Node<NodeConfig>
Returns layer by its id
Parameters
- layerId: string
Returns Node<NodeConfig>
- Defined in projects/some-charts-lib/src/renderer/renderer.ts:224

getSize

getSize(): Size
Returns renderer's element size.

Returns

Returns Size
- Defined in projects/some-charts-lib/src/renderer/renderer.ts:130

getStage

getStage(): Stage
Returns renderer's stage instance.

Returns

Returns Stage
- Defined in projects/some-charts-lib/src/renderer/renderer.ts:104

remove

remove(item: RenderableItem): void
Removes specified renderable item from renderer.
Parameters
- item: RenderableItem
  
  Item to remove.
Returns void
- Defined in projects/some-charts-lib/src/renderer/renderer.ts:157

setCursor

setCursor(cursor: Cursor): void
Sets renderer's cursor.
Parameters
- cursor: Cursor
Returns void
- Defined in projects/some-charts-lib/src/renderer/renderer.ts:179

setSize

setSize(newSize: Size): void
Sets size of renderer's element
Parameters
- newSize: Size
  
  New size of renderer's element
Returns void
- Defined in projects/some-charts-lib/src/renderer/renderer.ts:138

Generated using TypeDoc