class.ProfileModule
API > ProfileModule
Class: ProfileModule
Module for converting parametric data to profiles. which can easily be used for charts and graphs
Extends
BaseModule
Constructors
constructor
new ProfileModule(
worker
,parent
):ProfileModule
Parameters
Parameter | Type |
---|---|
worker | MeasureWorker |
parent | MeasureView |
Returns
Inherited from
BaseModule.constructor
Source
@novorender/measure/modules/base.ts:4
Properties
parent
readonly
parent:MeasureView
Inherited from
BaseModule.parent
Source
@novorender/measure/modules/base.ts:4
worker
readonly
worker:MeasureWorker
Inherited from
BaseModule.worker
Source
@novorender/measure/modules/base.ts:4
Methods
reverse
reverse(
inProfile
):Profile
Parameters
Parameter | Type |
---|---|
inProfile | Profile |
Returns
Source
@novorender/measure/modules/profile/module.ts:65
viewFromEntity
viewFromEntity(
entity
,setting
?):Promise
\<undefined
|Profile
>
Returns the profile view of a linestrip where x is the length of the line and y is the height This function can be used if an object contains multiple unconnected entities.
Parameters
Parameter | Type | Description |
---|---|---|
entity | MeasureEntity | The parametric entity used to create the profile |
setting ? | MeasureSettings | Settings |
Returns
Promise
\< undefined
| Profile
>
Profile where x is the length of the line and y is the height, it supports curve segments and cylinders, othwerwise it retuns undefiend
Source
@novorender/measure/modules/profile/module.ts:20
viewFromMultiSelect
viewFromMultiSelect(
products
,setting
?):Promise
\<undefined
|Profile
>
Returns the profile view of selected objects where x is the length of the line and y is the height, currently only supports cylinders
Parameters
Parameter | Type | Description |
---|---|---|
products | number [] | Products used to create a profile, this can be a list of line segments, line strips or connected cylinders * |
setting ? | MeasureSettings | Settings |
Returns
Promise
\< undefined
| Profile
>
Profile where x is the length of the line and y is the height, it supports curve segments and cylinders, othwerwise it retuns undefiend