Class DrawPolylineDto<T>

Type parameters

T

Hierarchy

DrawPolylineDto

Index

Constructors

constructor

Properties

Constructors

constructor

new DrawPolylineDto<T>(polyline?: PolylinePropertiesDto, opacity?: number, colours?: string | string[], size?: number, updatable?: boolean, polylineMesh?: T): DrawPolylineDto<T>

- Defined in bitbybit-docs.d.ts:16499
Provide options without default values

Type parameters
- T
Parameters
- Optional polyline: PolylinePropertiesDto
- Optional opacity: number
- Optional colours: string | string[]
- Optional size: number
- Optional updatable: boolean
- Optional polylineMesh: T
Returns DrawPolylineDto<T>

Properties

Optional colours

colours: string | string[]

Hex colour string

default: #444444

Optional opacity

opacity: number

Value between 0 and 1

default: 1
minimum: 0
maximum: 1
step: 0.1

Optional polyline

polyline: PolylinePropertiesDto

Polyline

default: undefined

Optional polylineMesh

polylineMesh: T

Line mesh variable in case it already exists and needs updating

default: undefined

Optional size

size: number

Width of the polyline

default: 3
minimum: 0
maximum: Infinity
step: 0.1

Optional updatable

updatable: boolean

Indicates wether the position of this polyline will change in time

default: false

Generated using TypeDoc