Skip to main content
interface VisualizeIsochroneRequest
contour_options?: Record<string, string>;
generate_image?: boolean;
graph_name: string;
levels_table?: string;
max_solution_radius?: number;
num_levels?: number;
options?: Record<string, string>;
restrictions?: string[];
solve_options?: Record<string, string>;
source_node: string;
style_options: Record<string, string>;
weights_on_edges?: string[];
contour_options? generate_image? graph_name levels_table? max_solution_radius? num_levels? options? restrictions? solve_options? source_node style_options weights_on_edges?
contour_options?: Record<string, string>

Contour specific parameters.

generate_image?: boolean

If set to true, generates a PNG image of the isochrones in the response.

graph_name: string

Name of the graph on which the isochrone is to be computed.

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.

max_solution_radius?: number

Extent of the search radius around source_node. Set to ‘-1.0’ for unrestricted search radius.

num_levels?: number

Number of equally-separated isochrones to compute.

options?: Record<string, string>

Additional parameters.

restrictions?: string[]

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’).

solve_options?: Record<string, string>

Solver specific parameters.

source_node: string

Starting vertex on the underlying graph from/to which the isochrones are created.

style_options: Record<string, string>

Various style related options of the isochrone image.

weights_on_edges?: string[]

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).