visualize_isochrone
- visualize_isochrone(
graph_name: string,
source_node: string,
max_solution_radius: number | undefined,
weights_on_edges: string[] | undefined,
restrictions: string[] | undefined,
num_levels: number | undefined,
generate_image: boolean | undefined,
levels_table: string | undefined,
style_options: Record<string, string>,
solve_options?: Record<string, string>,
contour_options?: Record<string, string>,
options?: Record<string, string>,
callback?: GPUdbCallback,
): Promise<VisualizeIsochroneResponse>Parameters
- graph_name: string
Name of the graph on which the isochrone is to be computed.
- source_node: string
Starting vertex on the underlying graph from/to which the isochrones are created.
- max_solution_radius: number | undefined
Extent of the search radius around
source_node. Set to ‘-1.0’ for unrestricted search radius. - weights_on_edges: string[] | undefined
Additional weights to apply to the edges of an existing graph. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., ‘table.column AS WEIGHTS_EDGE_ID’, or expressions, e.g., ‘ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED’. Any provided weights will be added (in the case of ‘WEIGHTS_VALUESPECIFIED’) to or multiplied with (in the case of ‘WEIGHTS_FACTORSPECIFIED’) the existing weight(s).
- restrictions: string[] | undefined
Additional restrictions to apply to the nodes/edges of an existing graph. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., ‘table.column AS RESTRICTIONS_EDGE_ID’, or expressions, e.g., ‘column/2 AS RESTRICTIONS_VALUECOMPARED’. If remove_previous_restrictions is set to true, any provided restrictions will replace the existing restrictions. If remove_previous_restrictions is set to false, any provided restrictions will be added (in the case of ‘RESTRICTIONS_VALUECOMPARED’) to or replaced (in the case of ‘RESTRICTIONS_ONOFFCOMPARED’).
- num_levels: number | undefined
Number of equally-separated isochrones to compute.
- generate_image: boolean | undefined
If set to true, generates a PNG image of the isochrones in the response.
- levels_table: string | undefined
Name of the table to output the isochrones to, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. The table will contain levels and their corresponding WKT geometry. If no value is provided, the table is not generated.
- style_options: Record<string, string>
Various style related options of the isochrone image.
Optionalsolve_options: Record<string, string>Solver specific parameters.
Optionalcontour_options: Record<string, string>Contour specific parameters.
Optionaloptions: Record<string, string>Additional parameters.
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<VisualizeIsochroneResponse>
Promise<Types.VisualizeIsochroneResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:15821
- graph_name: string
visualize_isochrone_request
- visualize_isochrone_request(
request: VisualizeIsochroneRequest,
callback?: GPUdbCallback,
): Promise<VisualizeIsochroneResponse>Generate an image containing isolines for travel results using an existing graph. Isolines represent curves of equal cost, with cost typically referring to the time or distance assigned as the weights of the underlying graph. See Graphs and Solvers for more information on graphs.
Parameters
- request: VisualizeIsochroneRequest
Request object containing the parameters for the operation
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<VisualizeIsochroneResponse>
Promise<Types.VisualizeIsochroneResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:15774
- request: VisualizeIsochroneRequest
Generate an image containing isolines for travel results using an existing graph. Isolines represent curves of equal cost, with cost typically referring to the time or distance assigned as the weights of the underlying graph. See Graphs and Solvers for more information on graphs.