API / geotoolkit3d / widgets / scatter / ScatterPlot / ScatterPlot
scatter.ScatterPlot.ScatterPlot
Type Aliases
Type Aliases
Ƭ Data: DataTable | { size?: DataSeries | number[] ; value?: DataSeries | number[] ; visible?: DataSeries | number[] | boolean[] ; x?: DataSeries | number[] ; y?: DataSeries | number[] ; z?: DataSeries | number[] }
The datatable or data object
Ƭ Options: Options & OptionsBase & { data: DataTable | { name?: string ; size?: DataSeries | number[] ; value?: DataSeries | number[] ; visible?: DataSeries | number[] | boolean[] ; x?: DataSeries | number[] ; y?: DataSeries | number[] ; z?: DataSeries | number[] } ; symbol?: string | SymbolTexture | SymbolGeometry }
Ƭ OptionsBase: Object
| Name | Type | Description |
|---|---|---|
colorprovider? | ColorProvider | string | Color | A color provider or a single color in css string or Three.Color format, define the general points color. Will internally get converted into a ColorProvider. |
gridoption | Options | The options for the ScatterPlot Grid. See Grid |
opacity? | number | Define the points opacity. |
projection? | { enable?: boolean ; frontback?: ProjectionMaterialOptions ; leftright?: ProjectionMaterialOptions ; opacity?: number ; sizefactor?: number ; topbottom?: ProjectionMaterialOptions } | Define the options for the points projection on the grid planes. |
projection.enable? | boolean | Enable/disable the projection of points on the grid planes. This option result in create or dispose projection of points. If user just want to toggle the visibility of the projection of points, please use toggleProjection method. By default is true. |
projection.frontback? | ProjectionMaterialOptions | If provided, it will add front and back projections |
projection.leftright? | ProjectionMaterialOptions | If provided, it will add left and right projections |
projection.opacity? | number | The opacity for projection. By default is 1.0. |
projection.sizefactor? | number | To manually adjust projection size. By default is 0.66. |
projection.topbottom? | ProjectionMaterialOptions | If provided, it will add top and bottom projections |
Ƭ OptionsBaseIn: Options & Partial<OptionsBase>
Ƭ OptionsBaseOut: Required<Options> & OptionsBase
Ƭ PointData: Object
The point datas retrieved from the ScatterPlot.
| Name | Type | Description |
|---|---|---|
color | RgbaColor | The color of the point. |
datasetname | string | The dataset name this point belongs to, if defined. If it was not specified, it will be named "default". |
index | number | The index of this point in its dataset. |
position | Vector3 | The 3D coordinates of this point. |
size | number | The relative size of the point. |
value | number | The value of the point. |
visible | boolean | If this point is flagged as visible or not. |
Ƭ ProjectionMaterialOptions: Merge<Options & { symbol?: SymbolTexture }, ProjectionOptions>
Ƭ ProjectionOptions: Object
| Name | Type | Description |
|---|---|---|
color? | string | Color | The color of the projection |
opacity? | number | The projection opacity |
sizefactor? | number | The size factor of the projection of the points |
symbol? | BASETexture | The Symbol texture used for the projection drawing |
Ƭ ShaderOptionsOut: Object
| Name | Type | Description |
|---|---|---|
alphatest | number | The opacity threshold until the pixel get discarded |
color | Color | The color of the projection |
opacity | number | The projection opacity |
symbol | BASETexture | The Symbol texture used for the projection drawing |