DotRepresentation

Dot representation

Hierarchy

Representation
- DotRepresentation

Indexable

[key: string]: any

Dot representation

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DotRepresentation(surface: Surface, viewer: Viewer, params: Partial<DotRepresentationParameters>): DotRepresentation

Overrides Representation.constructor
- Defined in src/representation/dot-representation.ts:77
Create Dot representation object

Parameters
- surface: Surface
  
  the surface or volume to be represented
- viewer: Viewer
  
  a viewer object
- params: Partial<DotRepresentationParameters>
  
  dot representation parameters
Returns DotRepresentation

Properties

Protected alphaTest

alphaTest: number

bufferList

bufferList: Buffer[]

Protected clipCenter

clipCenter: Vector3

Protected clipNear

clipNear: number

Protected clipRadius

clipRadius: number

Protected colorDomain

colorDomain: number[]

Protected colorMode

colorMode: ColorMode

Protected colorReverse

colorReverse: boolean

Protected colorScale

colorScale: string | string[]

Protected colorScheme

colorScheme: string

Protected colorValue

colorValue: number

Protected depthWrite

depthWrite: boolean

Protected diffuse

diffuse: number

Protected Optional diffuseInterior

diffuseInterior: undefined | false | true

Protected disableImpostor

disableImpostor: boolean

Protected disablePicking

disablePicking: boolean

Protected disposed

disposed: boolean

Protected dotBuffer

dotBuffer: SphereBuffer | PointBuffer

Protected dotType

dotType: "" | "sphere" | "point"

Protected edgeBleach

edgeBleach: number

Protected flatShaded

flatShaded: boolean

Protected forceTransparent

forceTransparent: boolean

Protected interiorColor

interiorColor: number

Protected interiorDarkening

interiorDarkening: number

lazy

lazy: boolean

lazyProps

lazyProps: { bufferParams: BufferParameters | {}; build: boolean; what: {} }

Type declaration

bufferParams: BufferParameters | {}
build: boolean
what: {}

Protected manualAttach

manualAttach: () => any

Type declaration

- (): any
- Returns any

Protected matrix

matrix: Matrix4

Protected metalness

metalness: number

Protected name

name: string

Protected opacity

opacity: number

Protected openEnded

openEnded: boolean

parameters

parameters: any

Protected pointSize

pointSize: number

Protected radialSegments

radialSegments: number

Protected radius

radius: number

Protected radiusType

Protected roughness

roughness: number

Protected scale

scale: number

Protected side

side: BufferSide

Protected sizeAttenuation

sizeAttenuation: boolean

Protected sortParticles

sortParticles: boolean

Protected sphereDetail

sphereDetail: number

Protected surface

surface: Surface | undefined

tasks

tasks: Counter

Protected thresholdMax

thresholdMax: number

Protected thresholdMin

thresholdMin: number

Protected thresholdOut

thresholdOut: boolean

Protected thresholdType

thresholdType: "value" | "value" | "sigma" | "sigma"

Protected toBePrepared

toBePrepared: boolean

type

type: string

Protected Optional useInteriorColor

useInteriorColor: undefined | false | true

Protected useTexture

useTexture: boolean

viewer

viewer: Viewer

visible

visible: boolean

Protected volume

volume: FilteredVolume | undefined

Protected wireframe

wireframe: boolean

Methods

attach

attach(callback: () => void): void

Overrides Representation.attach
- Defined in src/representation/dot-representation.ts:210
Parameters
- callback: () => void
  - - (): void
    - Returns void
Returns void

build

build(updateWhat?: undefined | {}): void

Inherited from Representation.build
- Defined in src/representation/representation.ts:447
Parameters
- Optional updateWhat: undefined | {}
Returns void

clear

clear(): void

Inherited from Representation.clear
- Defined in src/representation/representation.ts:663
Returns void

create

create(): void

Overrides Representation.create
- Defined in src/representation/dot-representation.ts:219
Returns void

dispose

dispose(): void

Inherited from Representation.dispose
- Defined in src/representation/representation.ts:673
Returns void

getBufferParams

getBufferParams(p?: {}): { clipCenter: Vector3; clipNear: number; clipRadius: number; depthWrite: boolean; diffuse: number; diffuseInterior: undefined | false | true; disablePicking: boolean; flatShaded: boolean; interiorColor: number; interiorDarkening: number; matrix: Matrix4; metalness: number; opacity: number; roughness: number; side: "double" | "front" | "back"; useInteriorColor: undefined | false | true; wireframe: boolean } & {}

Inherited from Representation.getBufferParams
- Defined in src/representation/representation.ts:382
Parameters
- Default value p: {} = {}
  - [k: string]: any
Returns { clipCenter: Vector3; clipNear: number; clipRadius: number; depthWrite: boolean; diffuse: number; diffuseInterior: undefined | false | true; disablePicking: boolean; flatShaded: boolean; interiorColor: number; interiorDarkening: number; matrix: Matrix4; metalness: number; opacity: number; roughness: number; side: "double" | "front" | "back"; useInteriorColor: undefined | false | true; wireframe: boolean } & {}

getColorParams

getColorParams(p?: undefined | {}): { scheme: string } & ColormakerParameters

Inherited from Representation.getColorParams
- Defined in src/representation/representation.ts:369
Parameters
- Optional p: undefined | {}
Returns { scheme: string } & ColormakerParameters

getParameters

getParameters(): {}

Inherited from Representation.getParameters
- Defined in src/representation/representation.ts:647
Returns {}

init

init(params: Partial<DotRepresentationParameters>): void

Overrides Representation.init
- Defined in src/representation/dot-representation.ts:184
Parameters
- params: Partial<DotRepresentationParameters>
Returns void

make

make(updateWhat?: undefined | false | true, callback?: undefined | (() => void)): void

Inherited from Representation.make
- Defined in src/representation/representation.ts:470
Parameters
- Optional updateWhat: undefined | false | true
- Optional callback: undefined | (() => void)
Returns void

prepare

prepare(cb: () => void): void

Inherited from Representation.prepare
- Defined in src/representation/representation.ts:435
Parameters
- cb: () => void
  - - (): void
    - Returns void
Returns void

setColor

setColor(value: number | string | Color | undefined, p?: Partial<RepresentationParameters>): this

Inherited from Representation.setColor
- Defined in src/representation/representation.ts:410
Parameters
- value: number | string | Color | undefined
- Optional p: Partial<RepresentationParameters>
Returns this

setParameters

setParameters(params: Partial<DotRepresentationParameters>, what?: DotDataFields, rebuild: boolean): this

Overrides Representation.setParameters
- Defined in src/representation/dot-representation.ts:326
Parameters
- params: Partial<DotRepresentationParameters>
- Default value what: DotDataFields = {}
- rebuild: boolean
Returns this

setVisibility

setVisibility(value: boolean, noRenderRequest?: undefined | false | true): Representation

Inherited from Representation.setVisibility
- Defined in src/representation/representation.ts:514
Set the visibility of the representation

Parameters
- value: boolean
  
  visibility flag
- Optional noRenderRequest: undefined | false | true
Returns Representation

this object

update

update(what?: DotDataFields): void

Overrides Representation.update
- Defined in src/representation/dot-representation.ts:286
Parameters
- Default value what: DotDataFields = {}
Returns void

updateParameters

updateParameters(bufferParams?: BufferParameters | {}, what?: any): void

Inherited from Representation.updateParameters
- Defined in src/representation/representation.ts:629
Parameters
- Default value bufferParams: BufferParameters | {} = {}
- Optional what: any
Returns void

Hierarchy

Indexable

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

surface: Surface

viewer: Viewer

params: Partial<DotRepresentationParameters>

Returns DotRepresentation

Properties

Protected alphaTest

bufferList

Protected clipCenter

Protected clipNear

Protected clipRadius

Protected colorDomain

Protected colorMode

Protected colorReverse

Protected colorScale

Protected colorScheme

Protected colorValue

Protected depthWrite

Protected diffuse

Protected Optional diffuseInterior

Protected disableImpostor

Protected disablePicking

Protected disposed

Protected dotBuffer

Protected dotType

Protected edgeBleach

Protected flatShaded

Protected forceTransparent

Protected interiorColor

Protected interiorDarkening

lazy

lazyProps

Type declaration

bufferParams: BufferParameters | {}

build: boolean

what: {}

Protected manualAttach

Type declaration

Returns any

Protected matrix

Protected metalness

Protected name

Protected opacity

Protected openEnded

parameters

Protected pointSize

Protected radialSegments

Protected radius

Protected radiusType

Protected roughness

Protected scale

Protected side

Protected sizeAttenuation

Protected sortParticles

Protected sphereDetail

Protected surface

tasks

Protected thresholdMax

Protected thresholdMin

Protected thresholdOut

Protected thresholdType

Protected toBePrepared

type

Protected Optional useInteriorColor

Protected useTexture

viewer

visible

Protected volume

Protected wireframe

Methods

attach

Parameters