Class VectorProperties

allowPicking

• get allowPicking(): boolean

• Returns boolean

• set allowPicking(allowPicking): void

• Parameters

  • allowPicking: boolean

  Returns void

altitudeMode

• get altitudeMode(): HeightReference

• Returns HeightReference

• set altitudeMode(altitudeMode): void

• Parameters

  • altitudeMode: HeightReference

  Returns void

baseUrl

• get baseUrl(): undefined | string

• Returns undefined | string

• set baseUrl(value): void

• Parameters

  • value: undefined | string

  Returns void

classificationType

• get classificationType(): undefined | ClassificationType

• Returns undefined | ClassificationType

• set classificationType(classificationType): void

• Parameters

  • classificationType: undefined | ClassificationType

  Returns void

extrudedHeight

• get extrudedHeight(): number

• Returns number

• set extrudedHeight(value): void

• Parameters

  • value: number

  Returns void

eyeOffset

• get eyeOffset(): undefined | Cartesian3

• Returns undefined | Cartesian3

• set eyeOffset(value): void

• Parameters

  • value: undefined | Cartesian3

  Returns void

groundLevel

• get groundLevel(): undefined | number

• Returns undefined | number

• set groundLevel(value): void

• Parameters

  • value: undefined | number

  Returns void

heightAboveGround

• get heightAboveGround(): undefined | number

• Returns undefined | number

• set heightAboveGround(value): void

• Parameters

  • value: undefined | number

  Returns void

modelAutoScale

• get modelAutoScale(): boolean

• Returns boolean

• set modelAutoScale(value): void

• Parameters

  • value: boolean

  Returns void

modelHeading

• get modelHeading(): number

• Returns number

• set modelHeading(value): void

• Parameters

  • value: number

  Returns void

modelOptions

• get modelOptions(): undefined | Record<string, unknown>

• Model options are merged with the model definition from model url, scale and orientation and accepts any option passed to a Cesium.Model.

  Returns undefined | Record<string, unknown>
• set modelOptions(modelOptions): void

• Parameters

  • modelOptions: undefined | Record<string, unknown>

  Returns void

modelPitch

• get modelPitch(): number

• Returns number

• set modelPitch(value): void

• Parameters

  • value: number

  Returns void

modelRoll

• get modelRoll(): number

• Returns number

• set modelRoll(value): void

• Parameters

  • value: number

  Returns void

modelScaleX

• get modelScaleX(): number

• Returns number

• set modelScaleX(value): void

• Parameters

  • value: number

  Returns void

modelScaleY

• get modelScaleY(): number

• Returns number

• set modelScaleY(value): void

• Parameters

  • value: number

  Returns void

modelScaleZ

• get modelScaleZ(): number

• Returns number

• set modelScaleZ(value): void

• Parameters

  • value: number

  Returns void

modelUrl

• get modelUrl(): undefined | string

• Returns undefined | string

• set modelUrl(value): void

• Parameters

  • value: undefined | string

  Returns void

primitiveOptions

• get primitiveOptions(): undefined | VectorPropertiesPrimitiveOptions<PrimitiveOptionsType>

• Returns undefined | VectorPropertiesPrimitiveOptions<PrimitiveOptionsType>

• set primitiveOptions(value): void

• Parameters

  • value: undefined | VectorPropertiesPrimitiveOptions<PrimitiveOptionsType>

  Returns void

scaleByDistance

• get scaleByDistance(): undefined | NearFarScalar

• Returns undefined | NearFarScalar

• set scaleByDistance(value): void

• Parameters

  • value: undefined | NearFarScalar

  Returns void

skirt

• get skirt(): number

• Returns number

• set skirt(value): void

• Parameters

  • value: number

  Returns void

storeyHeightsAboveGround

• get storeyHeightsAboveGround(): number[]

• Returns number[]

• set storeyHeightsAboveGround(value): void

• Parameters

  • value: number[]

  Returns void

storeyHeightsBelowGround

• get storeyHeightsBelowGround(): number[]

• Returns number[]

• set storeyHeightsBelowGround(value): void

• Parameters

  • value: number[]

  Returns void

storeysAboveGround

• get storeysAboveGround(): number

• Returns number

• set storeysAboveGround(value): void

• Parameters

  • value: number

  Returns void

storeysBelowGround

• get storeysBelowGround(): number

• Returns number

• set storeysBelowGround(value): void

• Parameters

  • value: number

  Returns void

constructor

• new VectorProperties(options): VectorProperties

• Parameters

  • options: VectorPropertiesOptions

  Returns VectorProperties

destroy

• destroy(): void

• destroys the vectorProperties and removes all listeners

  Returns void

getAllowPicking

• getAllowPicking(feature): boolean

• Parameters

  • feature: Feature<Geometry>

  Returns boolean

getAltitudeMode

• getAltitudeMode(feature): HeightReference

• Parameters

  • feature: Feature<Geometry>

  Returns HeightReference

getBaseUrl

• getBaseUrl(feature): undefined | string

• Parameters

  • feature: Feature<Geometry>

  Returns undefined | string

getClassificationType

• getClassificationType(feature): undefined | ClassificationType

• Parameters

  • feature: Feature<Geometry>

  Returns undefined | ClassificationType

getExtrudedHeight

• getExtrudedHeight(feature): number

• Parameters

  • feature: Feature<Geometry>

  Returns number

getEyeOffset

• getEyeOffset(feature): undefined | Cartesian3

• Parameters

  • feature: Feature<Geometry>

  Returns undefined | Cartesian3

getGroundLevel

• getGroundLevel(feature): undefined | number

• Parameters

  • feature: Feature<Geometry>

  Returns undefined | number

getHeightAboveGround

• getHeightAboveGround(feature): number

• Parameters

  • feature: Feature<Geometry>

  Returns number

getModel

• getModel(feature): null | VectorPropertiesModelOptions

• Parameters

  • feature: Feature<Geometry>

  Returns null | VectorPropertiesModelOptions

getModelAutoScale

• getModelAutoScale(feature): boolean

• Parameters

  • feature: Feature<Geometry>

  Returns boolean

getModelHeading

• getModelHeading(feature): number

• Parameters

  • feature: Feature<Geometry>

  Returns number

getModelOptions

• getModelOptions(feature): undefined | Record<string, unknown>

• Get the features or the properties modelOptions.

  Parameters

  • feature: Feature<Geometry>

  Returns undefined | Record<string, unknown>

getModelPitch

• getModelPitch(feature): number

• Parameters

  • feature: Feature<Geometry>

  Returns number

getModelRoll

• getModelRoll(feature): number

• Parameters

  • feature: Feature<Geometry>

  Returns number

getModelScaleX

• getModelScaleX(feature): number

• Parameters

  • feature: Feature<Geometry>

  Returns number

getModelScaleY

• getModelScaleY(feature): number

• Parameters

  • feature: Feature<Geometry>

  Returns number

getModelScaleZ

• getModelScaleZ(feature): number

• Parameters

  • feature: Feature<Geometry>

  Returns number

getModelUrl

• getModelUrl(feature): undefined | string

• Parameters

  • feature: Feature<Geometry>

  Returns undefined | string

getPrimitive

• getPrimitive(feature): null | VectorPropertiesPrimitive

• Returns the primive definition of this feature

  Parameters

  • feature: Feature<Geometry>

  Returns null | VectorPropertiesPrimitive

getPrimitiveOptions

• getPrimitiveOptions(feature): undefined | VectorPropertiesPrimitiveOptions<PrimitiveOptionsType>

• Parameters

  • feature: Feature<Geometry>

  Returns undefined | VectorPropertiesPrimitiveOptions<PrimitiveOptionsType>

getScaleByDistance

• getScaleByDistance(feature): undefined | NearFarScalar

• Parameters

  • feature: Feature<Geometry>

  Returns undefined | NearFarScalar

getSkirt

• getSkirt(feature): number

• Parameters

  • feature: Feature<Geometry>

  Returns number

getStoreyHeightsAboveGround

• getStoreyHeightsAboveGround(feature): number[]

• Parameters

  • feature: Feature<Geometry>

  Returns number[]

getStoreyHeightsBelowGround

• getStoreyHeightsBelowGround(feature): number[]

• Parameters

  • feature: Feature<Geometry>

  Returns number[]

getStoreysAboveGround

• getStoreysAboveGround(feature): number

• Parameters

  • feature: Feature<Geometry>

  Returns number

getStoreysBelowGround

• getStoreysBelowGround(feature): number

• Parameters

  • feature: Feature<Geometry>

  Returns number

getValues

• getValues(): VectorPropertiesOptions

• Returns VectorPropertiesOptions

getValuesForFeatures

• getValuesForFeatures(features): VectorPropertiesOptions

• The common vector properties for the input features.

  Parameters

  • features: Feature<Geometry>[]

    Features for which the vector property values should be returned.

  Returns VectorPropertiesOptions

  The common vector properties for the features. When a/all feature(s) does not has a property set, the layer or, if not set, the default value is returned. If features have different values for a property, the property key is not added to the returned obeject. If feature array is empty, an empty object is returned.

getVcsMeta

• getVcsMeta(defaultOptions?): Omit<VcsMeta, "version">

• Parameters

  • OptionaldefaultOptions: VectorPropertiesOptions

  Returns Omit<VcsMeta, "version">

renderAs

• renderAs(feature): "primitive" | "geometry" | "model"

• Determines if a feature (in general with a point geometry) should be rendered as a geometry (billboard & label etc) or a model or a primitive

  Parameters

  • feature: Feature<Geometry>

  Returns "primitive" | "geometry" | "model"

setValues

• setValues(options): void

• sets given values only raises propertyChanged event if a value has been set;

  Parameters

  • options: VectorPropertiesOptions

  Returns void

setValuesForFeatures

• setValuesForFeatures(options, features): void

• Sets vector property options on a array of features. When a property equals the value that is returned from the getter of the VectorProperties instance, the property is unset from the feature(s).

  Parameters

  • options: VectorPropertiesOptions

    The vector property options to be set on the features.
  • features: Feature<Geometry>[]

    The features to set the vector property options on.

  Returns void

setVcsMeta

• setVcsMeta(vcsMeta): void

• resets values, either given, or default Value raises propertyChanged event once;

  Parameters

  • vcsMeta: VcsMeta

  Returns void

StaticgetDefaultOptions

• getDefaultOptions(): VectorPropertiesOptions

• Returns the default options for VectorProperties

  Returns VectorPropertiesOptions

ReadonlypropertyChanged