@seatmap.pro/renderer 0.0.1

package/README.md

@@ -0,0 +1,788 @@
+<a name="readmemd"></a>
+
+# Seatmap Renderer
+
+## Index
+
+### Classes
+
+- [Renderer](#classesrenderermd)
+
+### Interfaces
+
+- [ICart](#interfacesicartmd)
+- [ICartGa](#interfacesicartgamd)
+- [ICartSeat](#interfacesicartseatmd)
+- [IColoredPrice](#interfacesicoloredpricemd)
+- [IExtendedSeat](#interfacesicoordcartseatmd)
+- [IExternalSector](#interfacesiexternalsectormd)
+- [IPoint](#interfacesipointmd)
+- [IPrice](#interfacesipricemd)
+- [IRendererSettings](#interfacesirenderersettingsmd)
+
+### Type aliases
+
+- [ColorSequenceSettings](#colorsequencesettings)
+- [SeatFilter](#seatfilter)
+
+### Functions
+
+- [convertPricesToColored](#const-convertpricestocolored)
+- [convertPricesToColoredById](#const-convertpricestocoloredbyid)
+- [sortPrices](#const-sortprices)
+
+## Type aliases
+
+### ColorSequenceSettings
+
+Ƭ **ColorSequenceSettings**: _string[][]_
+
+---
+
+### SeatFilter
+
+Ƭ **SeatFilter**: _function_
+
+#### Type declaration:
+
+▸ (`seat`: ISeat): _boolean_
+
+**Parameters:**
+
+| Name   | Type  |
+| ------ | ----- |
+| `seat` | ISeat |
+
+## Functions
+
+### `Const` convertPricesToColored
+
+▸ **convertPricesToColored**(`prices`: [IPrice](#interfacesipricemd)[], `colorSettings`: [ColorSequenceSettings](#colorsequencesettings)): _[IColoredPrice](#interfacesicoloredpricemd)[]_
+
+**Parameters:**
+
+| Name            | Type                                            |
+| --------------- | ----------------------------------------------- |
+| `prices`        | [IPrice](#interfacesipricemd)[]                 |
+| `colorSettings` | [ColorSequenceSettings](#colorsequencesettings) |
+
+**Returns:** _[IColoredPrice](#interfacesicoloredpricemd)[]_
+
+---
+
+### `Const` convertPricesToColoredById
+
+▸ **convertPricesToColoredById**(`prices`: [IPrice](#interfacesipricemd)[], `colorSettings`: [ColorSequenceSettings](#colorsequencesettings)): _ById‹[IColoredPrice](#interfacesicoloredpricemd)›_
+
+**Parameters:**
+
+| Name            | Type                                            |
+| --------------- | ----------------------------------------------- |
+| `prices`        | [IPrice](#interfacesipricemd)[]                 |
+| `colorSettings` | [ColorSequenceSettings](#colorsequencesettings) |
+
+**Returns:** _ById‹[IColoredPrice](#interfacesicoloredpricemd)›_
+
+---
+
+### `Const` sortPrices
+
+▸ **sortPrices**<**T**>(`prices`: T[]): _T[]_
+
+**Type parameters:**
+
+▪ **T**: _[IPrice](#interfacesipricemd)_
+
+**Parameters:**
+
+| Name     | Type |
+| -------- | ---- |
+| `prices` | T[]  |
+
+**Returns:** _T[]_
+
+# Classes
+
+<a name="classesrenderermd"></a>
+
+## Class: Renderer
+
+### Hierarchy
+
+- **Renderer**
+
+### Implements
+
+- IRenderer
+
+### Index
+
+#### Constructors
+
+- [constructor](#constructor)
+
+#### Methods
+
+- [addGaToCart](#addgatocart)
+- [addSeatsToCart](#addseatstocart)
+- [clearCart](#clearcart)
+- [destroy](#destroy)
+- [disableSeatsByIds](#disableseatsbyids)
+- [disableSeatsByKeys](#disableseatsbykeys)
+- [getCart](#getcart)
+- [getMaxZoom](#getmaxzoom)
+- [getMinZoom](#getminzoom)
+- [getPrices](#getprices)
+- [getZoom](#getzoom)
+- [initCart](#initcart)
+- [removeSeatsFromCartByIds](#removeseatsfromcartbyids)
+- [seatToCoordCartSeat](#seattocoordcartseat)
+- [updateSeatLocks](#updateseatlocks)
+- [zoomIn](#zoomin)
+- [zoomOut](#zoomout)
+- [zoomToFit](#zoomtofit)
+
+### Constructors
+
+#### constructor
+
+\+ **new Renderer**(`element`: HTMLElement, `settings?`: [IRendererSettings](#interfacesirenderersettingsmd)): _[Renderer](#classesrenderermd)_
+
+**Parameters:**
+
+| Name        | Type                                                |
+| ----------- | --------------------------------------------------- |
+| `element`   | HTMLElement                                         |
+| `settings?` | [IRendererSettings](#interfacesirenderersettingsmd) |
+
+**Returns:** _[Renderer](#classesrenderermd)_
+
+### Methods
+
+#### addGaToCart
+
+▸ **addGaToCart**(`ga`: [ICartGa](#interfacesicartgamd)): _void_
+
+**Parameters:**
+
+| Name | Type                            |
+| ---- | ------------------------------- |
+| `ga` | [ICartGa](#interfacesicartgamd) |
+
+**Returns:** _void_
+
+---
+
+#### addSeatsToCart
+
+▸ **addSeatsToCart**(`seats`: [ICartSeat](#interfacesicartseatmd)[]): _void_
+
+**Parameters:**
+
+| Name    | Type                                  |
+| ------- | ------------------------------------- |
+| `seats` | [ICartSeat](#interfacesicartseatmd)[] |
+
+**Returns:** _void_
+
+---
+
+#### clearCart
+
+▸ **clearCart**(): _void_
+
+**Returns:** _void_
+
+---
+
+#### destroy
+
+▸ **destroy**(): _void_
+
+**Returns:** _void_
+
+---
+
+#### disableSeatsByIds
+
+▸ **disableSeatsByIds**(`ids`: number[]): _void_
+
+**Parameters:**
+
+| Name  | Type     |
+| ----- | -------- |
+| `ids` | number[] |
+
+**Returns:** _void_
+
+---
+
+#### disableSeatsByKeys
+
+▸ **disableSeatsByKeys**(`keys`: string[]): _void_
+
+**Parameters:**
+
+| Name   | Type     |
+| ------ | -------- |
+| `keys` | string[] |
+
+**Returns:** _void_
+
+---
+
+#### getCart
+
+▸ **getCart**(): _[ICart](#interfacesicartmd)_
+
+**Returns:** _[ICart](#interfacesicartmd)_
+
+---
+
+#### getMaxZoom
+
+▸ **getMaxZoom**(): _number_
+
+**Returns:** _number_
+
+---
+
+#### getMinZoom
+
+▸ **getMinZoom**(): _number_
+
+**Returns:** _number_
+
+---
+
+#### getPrices
+
+▸ **getPrices**(): _[IColoredPrice](#interfacesicoloredpricemd)[]_
+
+**Returns:** _[IColoredPrice](#interfacesicoloredpricemd)[]_
+
+---
+
+#### getZoom
+
+▸ **getZoom**(): _number_
+
+**Returns:** _number_
+
+---
+
+#### initCart
+
+▸ **initCart**(`cart`: [ICart](#interfacesicartmd)): _void_
+
+**Parameters:**
+
+| Name   | Type                        |
+| ------ | --------------------------- |
+| `cart` | [ICart](#interfacesicartmd) |
+
+**Returns:** _void_
+
+---
+
+#### removeSeatsFromCartByIds
+
+▸ **removeSeatsFromCartByIds**(`ids`: number[]): _void_
+
+**Parameters:**
+
+| Name  | Type     |
+| ----- | -------- |
+| `ids` | number[] |
+
+**Returns:** _void_
+
+---
+
+#### seatToCoordCartSeat
+
+▸ **seatToCoordCartSeat**(`seat`: ISeat): _[IExtendedSeat](#interfacesicoordcartseatmd)_
+
+**Parameters:**
+
+| Name   | Type  |
+| ------ | ----- |
+| `seat` | ISeat |
+
+**Returns:** _[IExtendedSeat](#interfacesicoordcartseatmd)_
+
+---
+
+#### updateSeatLocks
+
+▸ **updateSeatLocks**(`filter`: [SeatFilter](#seatfilter)): _void_
+
+**Parameters:**
+
+| Name     | Type                      |
+| -------- | ------------------------- |
+| `filter` | [SeatFilter](#seatfilter) |
+
+**Returns:** _void_
+
+---
+
+#### zoomIn
+
+▸ **zoomIn**(): _void_
+
+**Returns:** _void_
+
+---
+
+#### zoomOut
+
+▸ **zoomOut**(): _void_
+
+**Returns:** _void_
+
+---
+
+#### zoomToFit
+
+▸ **zoomToFit**(): _void_
+
+**Returns:** _void_
+
+# Interfaces
+
+<a name="interfacesicartmd"></a>
+
+## Interface: ICart
+
+### Hierarchy
+
+- **ICart**
+
+### Index
+
+#### Properties
+
+- [ga](#ga)
+- [seats](#seats)
+
+### Properties
+
+#### ga
+
+• **ga**: _[ICartGa](#interfacesicartgamd)[]_
+
+---
+
+#### seats
+
+• **seats**: _[ICartSeat](#interfacesicartseatmd)[]_
+
+<a name="interfacesicartgamd"></a>
+
+## Interface: ICartGa
+
+### Hierarchy
+
+- **ICartGa**
+
+### Index
+
+#### Properties
+
+- [count](#count)
+- [key](#key)
+- [price](#price)
+- [sectorId](#optional-sectorid)
+
+### Properties
+
+#### count
+
+• **count**: _number_
+
+---
+
+#### key
+
+• **key**: _string_
+
+---
+
+#### price
+
+• **price**: _number_
+
+---
+
+#### `Optional` sectorId
+
+• **sectorId**? : _undefined | number_
+
+<a name="interfacesicartseatmd"></a>
+
+## Interface: ICartSeat
+
+### Hierarchy
+
+- **ICartSeat**
+
+  ↳ [IExtendedSeat](#interfacesicoordcartseatmd)
+
+### Index
+
+#### Properties
+
+- [id](#optional-id)
+- [key](#key)
+- [price](#optional-price)
+
+### Properties
+
+#### `Optional` id
+
+• **id**? : _undefined | number_
+
+---
+
+#### key
+
+• **key**: _string_
+
+---
+
+#### `Optional` price
+
+• **price**? : _undefined | number_
+
+<a name="interfacesicoloredpricemd"></a>
+
+## Interface: IColoredPrice
+
+### Hierarchy
+
+- [IPrice](#interfacesipricemd)
+
+  ↳ **IColoredPrice**
+
+### Index
+
+#### Properties
+
+- [color](#color)
+- [id](#id)
+- [name](#name)
+
+### Properties
+
+#### color
+
+• **color**: _string_
+
+---
+
+#### id
+
+• **id**: _number_
+
+_Inherited from [IPrice](#interfacesipricemd).[id](#id)_
+
+---
+
+#### name
+
+• **name**: _string_
+
+_Inherited from [IPrice](#interfacesipricemd).[name](#name)_
+
+<a name="interfacesicoordcartseatmd"></a>
+
+## Interface: IExtendedSeat
+
+### Hierarchy
+
+- [ICartSeat](#interfacesicartseatmd)
+
+  ↳ **IExtendedSeat**
+
+### Index
+
+#### Properties
+
+- [id](#optional-id)
+- [key](#key)
+- [price](#optional-price)
+- [x](#x)
+- [y](#y)
+
+### Properties
+
+#### `Optional` id
+
+• **id**? : _undefined | number_
+
+_Inherited from [ICartSeat](#interfacesicartseatmd).[id](#optional-id)_
+
+---
+
+#### key
+
+• **key**: _string_
+
+_Inherited from [ICartSeat](#interfacesicartseatmd).[key](#key)_
+
+---
+
+#### `Optional` price
+
+• **price**? : _undefined | number_
+
+_Inherited from [ICartSeat](#interfacesicartseatmd).[price](#optional-price)_
+
+---
+
+#### x
+
+• **x**: _number_
+
+---
+
+#### y
+
+• **y**: _number_
+
+<a name="interfacesiexternalsectormd"></a>
+
+## Interface: IExternalSector
+
+### Hierarchy
+
+- **IExternalSector**
+
+### Index
+
+#### Properties
+
+- [ga](#ga)
+- [id](#optional-id)
+- [name](#name)
+- [price](#optional-price)
+- [rect](#rect)
+
+### Properties
+
+#### ga
+
+• **ga**: _boolean_
+
+---
+
+#### `Optional` id
+
+• **id**? : _undefined | number_
+
+---
+
+#### name
+
+• **name**: _string_
+
+---
+
+#### `Optional` price
+
+• **price**? : _undefined | number_
+
+---
+
+#### rect
+
+• **rect**: _ISectorRect_
+
+<a name="interfacesipointmd"></a>
+
+## Interface: IPoint
+
+### Hierarchy
+
+- **IPoint**
+
+### Index
+
+#### Properties
+
+- [x](#x)
+- [y](#y)
+
+### Properties
+
+#### x
+
+• **x**: _number_
+
+---
+
+#### y
+
+• **y**: _number_
+
+<a name="interfacesipricemd"></a>
+
+## Interface: IPrice
+
+### Hierarchy
+
+- **IPrice**
+
+  ↳ [IColoredPrice](#interfacesicoloredpricemd)
+
+### Index
+
+#### Properties
+
+- [id](#id)
+- [name](#name)
+
+### Properties
+
+#### id
+
+• **id**: _number_
+
+---
+
+#### name
+
+• **name**: _string_
+
+<a name="interfacesirenderersettingsmd"></a>
+
+## Interface: IRendererSettings
+
+### Hierarchy
+
+- **IRendererSettings**
+
+### Index
+
+#### Properties
+
+- [debounceDelay](#optional-debouncedelay)
+- [onCartChange](#optional-oncartchange)
+- [onPan](#optional-onpan)
+- [onRedrawEnd](#optional-onredrawend)
+- [onRedrawStart](#optional-onredrawstart)
+- [onSeatDebouncedEnter](#optional-onseatdebouncedenter)
+- [onSeatDeselect](#optional-onseatdeselect)
+- [onSeatMouseEnter](#optional-onseatmouseenter)
+- [onSeatMouseLeave](#optional-onseatmouseleave)
+- [onSeatSelect](#optional-onseatselect)
+- [onSectorClick](#optional-onsectorclick)
+- [onSectorMouseEnter](#optional-onsectormouseenter)
+- [onSectorMouseLeave](#optional-onsectormouseleave)
+- [onZoomEnd](#optional-onzoomend)
+- [onZoomStart](#optional-onzoomstart)
+- [selectionLimit](#optional-selectionlimit)
+- [zoomAnimationDuration](#optional-zoomanimationduration)
+
+### Properties
+
+#### `Optional` debounceDelay
+
+• **debounceDelay**? : _undefined | number_
+
+---
+
+#### `Optional` onCartChange
+
+• **onCartChange**? : _undefined | function_
+
+---
+
+#### `Optional` onPan
+
+• **onPan**? : _undefined | function_
+
+---
+
+#### `Optional` onRedrawEnd
+
+• **onRedrawEnd**? : _undefined | function_
+
+---
+
+#### `Optional` onRedrawStart
+
+• **onRedrawStart**? : _undefined | function_
+
+---
+
+#### `Optional` onSeatDebouncedEnter
+
+• **onSeatDebouncedEnter**? : _undefined | function_
+
+---
+
+#### `Optional` onSeatDeselect
+
+• **onSeatDeselect**? : _undefined | function_
+
+---
+
+#### `Optional` onSeatMouseEnter
+
+• **onSeatMouseEnter**? : _undefined | function_
+
+---
+
+#### `Optional` onSeatMouseLeave
+
+• **onSeatMouseLeave**? : _undefined | function_
+
+---
+
+#### `Optional` onSeatSelect
+
+• **onSeatSelect**? : _undefined | function_
+
+---
+
+#### `Optional` onSectorClick
+
+• **onSectorClick**? : _undefined | function_
+
+---
+
+#### `Optional` onSectorMouseEnter
+
+• **onSectorMouseEnter**? : _undefined | function_
+
+---
+
+#### `Optional` onSectorMouseLeave
+
+• **onSectorMouseLeave**? : _undefined | function_
+
+---
+
+#### `Optional` onZoomEnd
+
+• **onZoomEnd**? : _undefined | function_
+
+---
+
+#### `Optional` onZoomStart
+
+• **onZoomStart**? : _undefined | function_
+
+---
+
+#### `Optional` selectionLimit
+
+• **selectionLimit**? : _undefined | number_
+
+---
+
+#### `Optional` zoomAnimationDuration
+
+• **zoomAnimationDuration**? : _undefined | number_