Skip to main content
URL: http://<db.host>:<db.port>/visualize/isochrone
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.

Input Parameter Description

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
double
Extent of the search radius around input parameter source_node. Set to ‘-1.0’ for unrestricted search radius.The default value is -1.0.
weights_on_edges
array of strings
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).The default value is an empty array ( [] ).
restrictions
array of strings
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’).The default value is an empty array ( [] ).
num_levels
int
Number of equally-separated isochrones to compute.The default value is 1.
generate_image
boolean
If set to true, generates a PNG image of the isochrones in the response.The default value is true.The supported values are:
  • true
  • false
levels_table
string
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.The default value is ”.
style_options
map of string to strings
Various style related options of the isochrone image.
solve_options
map of string to strings
Solver specific parameters.The default value is an empty map ( {} ).
contour_options
map of string to strings
Contour specific parameters.The default value is an empty map ( {} ).
options
map of string to strings
Additional parameters.The default value is an empty map ( {} ).

Output Parameter Description

The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
status
String
‘OK’ or ‘ERROR’
message
String
Empty if success or an error message
data_type
String
‘visualize_isochrone_response’ or ‘none’ in case of an error
data
String
Empty string
data_str
JSON or String
This embedded JSON represents the result of the /visualize/isochrone endpoint:Empty string in case of an error.