Class RepresentationElement

Element wrapping a Representation object

Hierarchy

Element
- RepresentationElement

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new RepresentationElement(stage: Stage, repr: Representation, params?: Partial<RepresentationElementParameters>, parent: Component): RepresentationElement

Overrides Element.constructor
- Defined in src/component/representation-element.ts:33
Create representation component

Parameters
- stage: Stage
  
  stage object the component belongs to
- repr: Representation
  
  representation object to wrap
- Default value params: Partial<RepresentationElementParameters> = {}
- parent: Component
Returns RepresentationElement

Properties

parameters

parameters: RepresentationElementParameters

parent

parent: Component

repr

repr: Representation

signals

signals: RepresentationElementSignals

stage

stage: Stage

stage object the component belongs to

uuid

uuid: string

Accessors

defaultParameters

get defaultParameters(): { visible: true } & { name: string; status: string }

Overrides Element.defaultParameters
- Defined in src/component/representation-element.ts:31
Returns { visible: true } & { name: string; status: string }

name

get name(): string

Inherited from Element.name
- Defined in src/component/element.ts:53
Returns string

type

get type(): string

Overrides Element.type
- Defined in src/component/representation-element.ts:59
Component type

Returns string

visible

get visible(): boolean

- Defined in src/component/representation-element.ts:53
Returns boolean

Methods

_disposeRepresentation

_disposeRepresentation(): void

- Defined in src/component/representation-element.ts:73
Returns void

build

build(params?: any): this

- Defined in src/component/representation-element.ts:136
Parameters
- Optional params: any
Returns this

dispose

dispose(): void

Overrides Element.dispose
- Defined in src/component/representation-element.ts:80
Returns void

getParameters

getParameters(): Partial<RepresentationParameters>

- Defined in src/component/representation-element.ts:175
Get representation parameters

Returns Partial<RepresentationParameters>

parameter object

getType

getType(): string

- Defined in src/component/representation-element.ts:61
Returns string

getVisibility

getVisibility(): boolean

- Defined in src/component/representation-element.ts:102
Returns boolean

setColor

setColor(value: string | number | Color): this

- Defined in src/component/representation-element.ts:184
Set color

Parameters
- value: string | number | Color
  
  color value
Returns this

this object

setName

setName(value: string): this

Inherited from Element.setName
- Defined in src/component/element.ts:62
Parameters
- value: string
Returns this

setParameters

setParameters(params: any): this

- Defined in src/component/representation-element.ts:162
Set representation parameters

Parameters
- params: any
  
  parameter object
Returns this

this object

setRepresentation

setRepresentation(repr: Representation): void

- Defined in src/component/representation-element.ts:65
Parameters
- repr: Representation
Returns void

setSelection

setSelection(string: string): this

- Defined in src/component/representation-element.ts:147
Set selection

Parameters
- string: string
  
  selection string
Returns this

this object

setStatus

setStatus(value: string): this

Inherited from Element.setStatus
- Defined in src/component/element.ts:55
Parameters
- value: string
Returns this

setVisibility

setVisibility(value: boolean): this

- Defined in src/component/representation-element.ts:94
Set the visibility of the component, takes parent visibility into account

Parameters
- value: boolean
  
  visibility flag
Returns this

this object

toggleVisibility

toggleVisibility(): this

- Defined in src/component/representation-element.ts:114
Toggle visibility of the component, takes parent visibility into account

Returns this

this object

update

update(what: any): this

- Defined in src/component/representation-element.ts:130
Set selection

Parameters
- what: any
  
  flags indicating what attributes to update
Returns this

this object

updateVisibility

updateVisibility(): void

- Defined in src/component/representation-element.ts:118
Returns void

Generated using TypeDoc