Class VectorLayer<G, P>

constructor

• new VectorLayer<
      G extends Geometry = Geometry,
      P extends GeoJsonProperties = GeoJsonProperties,
  >(
      opt?: { coordinates?: G["coordinates"]; properties?: P },
  ): VectorLayer<G, P>

  Type Parameters

  • G extends Geometry = Geometry
  • P extends GeoJsonProperties = GeoJsonProperties

  Parameters

  • Optionalopt: { coordinates?: G["coordinates"]; properties?: P }

  Returns VectorLayer<G, P>

Optionalid

StaticgeometryType

coordinates

• get coordinates(): G["coordinates"]

  Returns G["coordinates"]

• set coordinates(coordinates: G["coordinates"]): void

  Parameters

  • coordinates: G["coordinates"]

  Returns void

geom

• get geom(): G

  Returns G

• set geom(geom: G): void

  Parameters

  • geom: G

  Returns void

getConstructor

• getConstructor(): typeof VectorLayer

  Returns typeof VectorLayer

hasId

• hasId(): boolean

  Checks if entity has an id.

  Returns boolean

save

• save(): Promise<VectorLayer<G, P>>

  Saves current entity in the NGW target layer. If entity does not exist in the NGW layer then inserts, otherwise updates.

  Returns Promise<VectorLayer<G, P>>

toGeoJson

• toGeoJson(): Feature<G, VectorLayer<G, P>>

  Returns Feature<G, VectorLayer<G, P>>

toJSON

• toJSON(): string

  Returns string

Staticcount

• count<T extends VectorLayer<Geometry, GeoJsonProperties>>(
      this: ObjectType<T>,
      optionsOrConditions?: FindManyOptions<T> | PropertiesFilter<T>,
  ): Promise<number>

  Counts entities that match given find options or conditions.

  Type Parameters

  • T extends VectorLayer<Geometry, GeoJsonProperties>

  Parameters

  • this: ObjectType<T>
  • OptionaloptionsOrConditions: FindManyOptions<T> | PropertiesFilter<T>

  Returns Promise<number>

Staticfind

• find<T extends VectorLayer<Geometry, GeoJsonProperties>>(
      this: ObjectType<T>,
      optionsOrConditions?: FindManyOptions<T> | PropertiesFilter<T>,
  ): Promise<T[]>

  Finds entities that match given find options or conditions.

  Type Parameters

  • T extends VectorLayer<Geometry, GeoJsonProperties>

  Parameters

  • this: ObjectType<T>
  • OptionaloptionsOrConditions: FindManyOptions<T> | PropertiesFilter<T>

  Returns Promise<T[]>

StaticfindOne

• findOne<T extends VectorLayer<Geometry, GeoJsonProperties>>(
      this: ObjectType<T>,
      optionsOrConditions?: number | FindOneOptions<T> | FindConditions<T>,
      maybeOptions?: FindOneOptions<T>,
  ): Promise<undefined | T>

  Finds first entity that matches given conditions.

  Type Parameters

  • T extends VectorLayer<Geometry, GeoJsonProperties>

  Parameters

  • this: ObjectType<T>
  • OptionaloptionsOrConditions: number | FindOneOptions<T> | FindConditions<T>
  • OptionalmaybeOptions: FindOneOptions<T>

  Returns Promise<undefined | T>

StaticfindOneOrFail

• findOneOrFail<T extends VectorLayer<Geometry, GeoJsonProperties>>(
      this: ObjectType<T>,
      optionsOrConditions?: number | FindOneOptions<T> | FindConditions<T>,
      maybeOptions?: FindOneOptions<T>,
  ): Promise<T>

  Finds first entity that matches given conditions.

  Type Parameters

  • T extends VectorLayer<Geometry, GeoJsonProperties>

  Parameters

  • this: ObjectType<T>
  • OptionaloptionsOrConditions: number | FindOneOptions<T> | FindConditions<T>
  • OptionalmaybeOptions: FindOneOptions<T>

  Returns Promise<T>

StaticgetNgwPayload

• getNgwPayload(
      resource: typeof VectorLayer,
      parent: number,
      options: SyncOptions,
  ):
      | undefined
      | DeepPartial<VectorResourceSyncItem | VectorResourceUpdateItem>

  Parameters

  • resource: typeof VectorLayer
  • parent: number
  • options: SyncOptions

  Returns undefined | DeepPartial<VectorResourceSyncItem | VectorResourceUpdateItem>

Staticreceive

• receive(item: CompositeRead): typeof VectorLayer

  Parameters

  • item: CompositeRead

  Returns typeof VectorLayer

Staticsave

• save<T extends VectorLayer<Geometry, GeoJsonProperties>>(
      this: ObjectType<T>,
      entityOrEntities: T | T[],
      options?: UpdateOptions,
  ): Promise<T[]>

  Saves one or many given entities.

  Type Parameters

  • T extends VectorLayer<Geometry, GeoJsonProperties>

  Parameters

  • this: ObjectType<T>
  • entityOrEntities: T | T[]
  • Optionaloptions: UpdateOptions

  Returns Promise<T[]>

StatictoTypescript

• toTypescript(opt?: ToTypescriptOptions): ToTypescript

  Parameters

  • Optionalopt: ToTypescriptOptions

  Returns ToTypescript

Staticvalidate

• validate(): ValidateErrorType[]

  Returns ValidateErrorType[]