Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PointTechniqueParams

Possible parameters of [[PointTechnique]].

Hierarchy

Index

Properties

Optional category

category: DynamicProperty<string>

The category of this technique.

remarks

The category is used in conjunction with Theme.priorities to assign render orders to the objects created by this Style.

Optional color

Color of a point in hexadecimal or CSS-style notation, for example: "#e4e9ec", "#fff", "rgb(255, 0, 0)", or "hsl(35, 11%, 88%)".

format

color-hex

Optional constantHeight

constantHeight: DynamicProperty<boolean>

If true, geometry height won't be scaled on projection. Enable it for projections with variable scale factor (e.g. mercator) to avoid distortions in geometry with great heights and latitude spans. E.g. a large object with even height would look oblique to the ground plane on mercator unless this property is set to true.

defaultvalue

true for geometries stored at level less than 12.

Optional enablePicking

enablePicking: undefined | false | true

Whether to enable picking on these points.

Optional enabled

enabled: DynamicProperty<boolean>

Runtime filtering of techniques.

Use with ['dynamic-properties'] operator for dynamic feature highlight, highlighig etc.

see

Picking example

Optional fadeFar

fadeFar: DynamicProperty<number>

Distance to the camera (0.0 = camera position, 1.0 = farPlane) at which the object has zero opacity and stops fading out. An undefined value disables fading.

Optional fadeNear

fadeNear: DynamicProperty<number>

Distance to the camera `(0.0 = camera position, 1.0 = farPlane) at which the object start fading out (opacity decreases).

Optional id

id: undefined | string

The name used to identify materials created from this technique.

Optional kind

Specified kind of geometry.

remarks

One kind is set as default in the technique, and can be overridden in the style.

deprecated

Use enabled with expressions based on ['dynamic-properties'] operator. See "object picking" example.

Optional maxZoomLevel

maxZoomLevel: DynamicProperty<number>

Maximum zoom level. If the current zoom level is equal to or greater, the technique will not be used.

Optional minZoomLevel

minZoomLevel: DynamicProperty<number>

Minimal zoom level. If the current zoom level is smaller, the technique will not be used.

Optional opacity

opacity: DynamicProperty<number>

For transparent lines, set a value between 0.0 for totally transparent, to 1.0 for totally opaque.

Optional renderOrder

renderOrder: DynamicProperty<number>

The render order of the objects created using this technique.

remarks

If not specified in style file monotonically increasing values according to style position in file.

Optional side

side: DynamicProperty<number>

Defines which side of faces will be rendered - front, back or both. See https://threejs.org/docs/#api/en/materials/Material.side.

Optional size

size: DynamicProperty<number>

Size of point in pixels.

Optional texture

texture: undefined | string

URL of a texture image to be loaded.

Optional transient

transient: boolean | Pickability

Optional. If true or Pickability.transient, no IDs will be saved for the geometry this style creates. Default is Pickability.onlyVisible, which allows all pickable and visible objects to be picked, Pickability.all, will also allow invisible objects to be picked.

defaultvalue

Pickability.onlyVisible The boolean option is for backwardscompatibilty, please use the Pickability.

TODO: deprecate and rename to something that makes more sense

Optional transparent

transparent: DynamicProperty<boolean>

Set to 'true' if line should appear transparent.

remarks

Rendering transparent lines may come with a slight performance impact. See https://threejs.org/docs/#api/en/materials/Material.transparent.

Generated using TypeDoc