@targomo/core
Advanced tools
Comparing version 0.7.1 to 0.7.2
@@ -5,3 +5,3 @@ { | ||
"author": "Targomo", | ||
"version": "0.7.1", | ||
"version": "0.7.2", | ||
"license": "MIT", | ||
@@ -8,0 +8,0 @@ "repository": "github:targomo/targomo-js", |
/** | ||
* @targomo/core "0.7.1" http://targomo.com | ||
* @targomo/core "0.7.2" http://targomo.com | ||
* The JavaScript (& TypeScript) API for Targomo's time-based access mapping services. | ||
@@ -4,0 +4,0 @@ * (c) 2022 Targomo |
@@ -7,2 +7,3 @@ import { TargomoClient } from './targomoClient'; | ||
* @Topic Optimizations | ||
* @deprecated | ||
*/ | ||
@@ -9,0 +10,0 @@ export declare class OptimizationsClient { |
import type { Geometry } from 'geojson'; | ||
import type { Location, OSMType, PoiGroup, TravelMode, TravelTimeFactors } from '..'; | ||
import type { TravelType } from '../types'; | ||
export declare type CriterionType = 'statisticsSum' | 'statisticsSumInZone' | 'statisticsDistance' | 'poiCoverageCount' | 'poiCoverageDistance' | 'closestPoiDistance' | 'poiCountInZone' | 'gravitationSum' | 'poiGravitationSum' | 'staypointCount' | 'mathAggregation' | 'edgeStatistics' | 'transitStopsSum' | 'transitStopsDistance'; | ||
export declare type CriterionType = 'statisticsSum' | 'statisticsSumInZone' | 'statisticsDistance' | 'poiCoverageCount' | 'poiCoverageDistance' | 'closestPoiDistance' | 'poiCountInZone' | 'gravitationSum' | 'poiGravitationSum' | 'staypointCount' | 'mathAggregation' | 'edgeStatistics' | 'transitStopsSum' | 'transitStopsDistance' | 'statsOnEnclosingCell' | 'polygonArea'; | ||
/** | ||
* Base inteface with the properties that all criteria share | ||
*/ | ||
interface BaseCriterion { | ||
export interface BaseCriterion { | ||
/** | ||
@@ -23,3 +23,3 @@ * Determines what quality criterion we want to supply | ||
*/ | ||
interface BaseReachabilityCriterion extends BaseCriterion { | ||
export interface BaseReachabilityCriterion extends BaseCriterion { | ||
/** | ||
@@ -50,5 +50,7 @@ * URL to targomo core service | ||
*/ | ||
interface BaseStatisticsCriterion extends BaseCriterion { | ||
export interface BaseStatisticsCriterion extends BaseCriterion { | ||
/** The Statistic Group to be used as data source */ | ||
statisticGroupId: number; | ||
statisticGroupId?: number; | ||
/** The Statistic colleciton (== ensemble) to be used as data source */ | ||
statisticCollectionId?: number; | ||
/** List of statistic ids to consider for the reachability calculation. | ||
@@ -60,3 +62,3 @@ * If the list contains several elements, the score will be the sum of the statistics data of each statisticId */ | ||
} | ||
interface BasePoiCriterion extends BaseCriterion { | ||
export interface BasePoiCriterion extends BaseCriterion { | ||
/** list of Osm Types to consider for this criterion */ | ||
@@ -70,3 +72,3 @@ osmTypes: (OSMType | PoiGroup)[]; | ||
} | ||
interface BaseGravitationCriterion { | ||
export interface BaseGravitationCriterion { | ||
/** This attribute specifies the exponential power to be applied on values based on proximity to any source. | ||
@@ -124,2 +126,31 @@ * When customized, it is advised to be a negative value to express correctly the gravitation attraction. | ||
} | ||
export interface StatisticsOnEnclosingCellCriterion extends BaseStatisticsCriterion { | ||
type: 'statsOnEnclosingCell'; | ||
} | ||
export interface PolygonAreaCriterion extends BaseStatisticsCriterion, BaseReachabilityCriterion { | ||
type: 'polygonArea'; | ||
/** | ||
* Srid of the polygon | ||
*/ | ||
srid: number; | ||
/** | ||
* The simplify (meters) parameter needs to be larger than 0m and smaller or equal to 500m. | ||
* If not specified it will be calculated from the buffer size (if it was specified). | ||
*/ | ||
simplify: number; | ||
/** | ||
* Determines the geometry buffer size of the original polygon edges. | ||
* The newly created polygon is wider by that margin. | ||
* If specified it has to be greater than 0.0; | ||
* If no simplify is specified it will force a simplify value. | ||
* If nothing is specified no buffer will be added. | ||
*/ | ||
buffer: number; | ||
/** | ||
* Due to the buffer the vertices of the polygon are extended in semi-circle way. | ||
* This value determines into how many segments a 90 degree angle is translated. | ||
* A low value means less polygon points but also less smooth corners. Cannot be higher than 8. | ||
*/ | ||
quadrantSegments: number; | ||
} | ||
export interface StaypointCriterion extends BaseCriterion { | ||
@@ -164,3 +195,3 @@ type: 'staypointCount'; | ||
} | ||
export declare type QualityCriterion = PointOfInterestReachabilityCriterion | PointOfInterestInZoneCriterion | PointOfInterestGravitationCriterion | StatisticsReachabilityCriterion | StatisticsInZoneCriterion | StatisticsGravitationCriterion | StaypointCriterion | MathCriterion | EdgeStatisticsCriterion | TransitCriterion; | ||
export declare type QualityCriterion = PointOfInterestReachabilityCriterion | PointOfInterestInZoneCriterion | PointOfInterestGravitationCriterion | StatisticsReachabilityCriterion | StatisticsOnEnclosingCellCriterion | StatisticsInZoneCriterion | StatisticsGravitationCriterion | StaypointCriterion | MathCriterion | EdgeStatisticsCriterion | TransitCriterion | PolygonAreaCriterion; | ||
/** Criterion definitions | ||
@@ -167,0 +198,0 @@ * For each criterion, a key must be set to be able to identify the different criteria in the response */ |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
1285115
9678