Class GridStyleManager

utility for custom generated CSS rules with a focus on dynamically generated grid layouts

Hierarchy (view full)

StyleManager
- GridStyleManager

Index

Constructors

Properties

cssClasses id ids

Accessors

Methods

addRule deleteRule destroy remove update updateRule

Constructors

constructor

new GridStyleManager(root, id): GridStyleManager
Parameters
- root: HTMLElement
- id: string
Returns GridStyleManager
Overrides StyleManager.constructor
- Defined in src/style/GridStyleManager.ts:86

Properties

`Readonly` cssClasses

cssClasses: ISelectors

`Readonly` id

id: string

`Readonly` ids

ids: ISelectors

Accessors

`Protected` ruleNames

get ruleNames(): string[]
get a list of all registered rule ids

Returns string[]
Inherited from StyleManager.ruleNames
- Defined in src/style/StyleManager.ts:179

Methods

addRule

addRule(id, selector, style): null | string
add a custom css rule
Parameters
- id: string
  unique id of the rule for later identification
- selector: string
  the css selector
- style: Partial<CSSStyleDeclaration>
  the style attributes
Returns null | string
the id again
Inherited from StyleManager.addRule
- Defined in src/style/StyleManager.ts:115

deleteRule

deleteRule(id): void
deletes the given rule by id
Parameters
- id: string
  the rule to delete
Returns void
Inherited from StyleManager.deleteRule
- Defined in src/style/StyleManager.ts:163

destroy

destroy(): void
Returns void
Inherited from StyleManager.destroy
- Defined in src/style/StyleManager.ts:56

remove

remove(tableId): void
removes a given tableId if not needed anymore
Parameters
- tableId: string
  tableId to remove
Returns void
- Defined in src/style/GridStyleManager.ts:155

update

update(defaultRowHeight, columns, padding, frozenShift, tableId, unit?): void
updates the column widths and default row height for a table
Parameters
- defaultRowHeight: number
- columns: IColumn[]
- padding: ((index) => number)
  - - (index): number
    - Parameters
      index: number
      Returns number
- frozenShift: number
  shift frozen columns
- tableId: string
  optional tableId in case of multiple tables within the same engine
- unit: string = 'px'
Returns void
- Defined in src/style/GridStyleManager.ts:126

updateRule

updateRule(id, selector, style): null | string
updates or add a rule, see
Parameters
- id: string
  unique id of the rule for later identification
- selector: string
  the css selector
- style: Partial<CSSStyleDeclaration>
  the style attributes
Returns null | string
the id again

Add Rule
Inherited from StyleManager.updateRule
- Defined in src/style/StyleManager.ts:137