Aviso | ||
---|---|---|
| ||
|
draw.io Diagram | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
TPR: TOTVS: Planejamento TOTVS Planejamento de Rotas
Sistema Externo: Todos os ERPs que se conectam ou pretendem se conectar com os produtos de planejamento logístico TOTVS.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
class TPR { get(token: string, systemInfo: StringSystemInfo): Promise<TPRServices> } |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
classinterface SystemInfo TPRServices{ createMap(element: HTMLElement, mapOptions: TPRMapOptions): Promise<TPRMap> readonly system: string; readonly version: string; readonly qualifiers: string; readonly callbackURL?: string; } |
Âncora | ||||
---|---|---|---|---|
|
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
class TPRServices TPRMapOptions{ public height: number; public width: number createMap(element: HTMLElement): Promise<TPRMap>; } |
Âncora | ||||
---|---|---|---|---|
|
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
class TPRMap {
addMarker(point: TPRPoint, markerOptions?: MarkerOptions): void;
viewRoute(route: TPRRoute, routeOptions?: TPRRouteOptions): Promise<TPRMapRoute>;
zoomIn(): void;
zoomOut(): void;
centerOn(point: TPRPoint);
centerRoutes(): void;
clear(): void;
close(): void;
} |
Âncora | ||||
---|---|---|---|---|
|
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
class TPRPoint { public readonly latitude; public readonly longitude; } |
Âncora | ||||
---|---|---|---|---|
|
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
interface MarkerOptions {
color?: String;
draggable?: boolean;
onDrag?: (latitude: number, longitude: number) => void
} |
Âncora | ||||
---|---|---|---|---|
|
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
class TPRRoute { constructor(publicreadonly trip: TPRTrip, readonly identifier?: string) { } } |
Âncora | ||||
---|---|---|---|---|
|
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
class TPRRouteOptions { constructor(publicreadonly tooglePopup: boolean) {} } |
Âncora | ||||
---|---|---|---|---|
|
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
class TPRMapRoute { hide(): void; show(): void; color(color?: String); } |
Âncora | ||||
---|---|---|---|---|
|
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
class TPRTrip { // Campos do TPRTrip (https://tdn.totvs.com/pages/releaseviewviewpage.action?pageId=604507369) readonly sequential:Integer Publicreadonly distance:double:Double readonly tollValue:Double Publicreadonly numberOfStops:integerInteger Publicreadonly volume:doubleDouble Publicreadonly weight:doubleDouble Publicreadonly duration:doubleInteger Publicreadonly extraTrip:Boolean:boolean readonly considerReturnDistance: boolean Publicreadonly vehicle:StringTPRVehicle Publicreadonly stops:TPRTripStop[] } |
Âncora | ||||
---|---|---|---|---|
|
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
class TPRVehicle { readonly identifier: string, readonly weightCapacity: number, readonly volumeCapacity: number, readonly quantity: number, readonly speed: number, readonly vehicleType: string, readonly tollAxes: number, readonly tollReturnAxes: number } |
Âncora | ||||
---|---|---|---|---|
|
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
class TPRTripStop { // Campos do TPRTripStop (https://tdn.totvs.com/pages/releaseviewviewpage.action?pageId=604507369) Publicreadonly stopSequencesequence:intInteger Publicreadonly stopTypetype:String readonly distance:Double, readonly tollValue:Double, Publicreadonly locality:TPRRoutingLocality Publicreadonly arrivalTime:DateTime Publicreadonly departureTime:DateTime Publicreadonly loadedOrders:TPRRoutedOrder[] Publicreadonly unloadedOrders:TPRRoutedOrder[] {} |
Âncora | ||||
---|---|---|---|---|
|
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
class TPRRoutingLocality { // Campos do TPRRoutingLocality(https://tdn.totvs.com/pages/releaseviewviewpage.action?pageId=604507369) Publicreadonly identifier:String readonly name: String Publicreadonly country:String Publicreadonly latitude:Double Publicreadonly longitude:Double Publicreadonly operation:String { readonly customizedOperation: TPRCustomizedOperation[] } |
Âncora | ||||
---|---|---|---|---|
|
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
class TPRCustomizedOperation TPRRoutedOrder{ Publicreadonly identifierweekDay:String Public weight:Double Public volume:Double string, readonly startTime: string, readonly endTime: string } |
Âncora | ||||
---|---|---|---|---|
|
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
interfaceclass TPRRoutedOrder TPRMapRoute{ hide(): void; show(): void; color(color?: String);readonly identifier:String readonly weight:Double readonly volume:Double } |
Âncora | ||||
---|---|---|---|---|
|
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
(function() { //require ou import TPR const tpr: TPR; let tprServices: TPRServices; tpr.get("alksdjlaksdjal""algum-token-aqui", {"system": "system-1.0.0", "version": "1.0.0", "qualifiers": ""}) .then((services) => { tprServices = services; }); let tprMap: TPRMap; // Caso de uso 1: visualizar uma localidade no mapa tprServices.createMap(document.getElementById("mapDiv"), { height: 300, width: 650 }).then((map) => { tprMap = map; map.addMarker({latitude: -23, longitude: -46}); }); // Caso de uso 2: zoomIn tprMap.zoomIn(); // Caso de uso 3: zoomOut tprMap.zoomOut(); // Caso de uso 4: centralizar sobre um ponto específico tprMap.centerOn({latitude:new TPRPoint(-23, longitude: -46})); // Caso de uso 5: Centralizar considerando todos os pontos plotados tprMap.centerRoutes(); // Caso de uso 6: Ver rota let tprMapRoute: TPRMapRoute; tprMap.viewRoute(new TPRRoute([{latitude: -23, longitude: -46}, {latitude: -22, longitude: -45}])new TPRTrip(...))) .then((mapRoute) => tprMapRoute = mapRoute); // Caso de uso 7: Limpa o conteúdo (pontos e rota) tprMap.clear(); // Caso de uso 8: Remover mapa tprMap.close(); // Caso de uso 9: Esconder roda let tprMapRoute: TPRMapRoute; tprMap.viewRoute(new TPRRoute([{latitude: -23, longitude: -46}, {latitude: -22, longitude: -45}])) .then((mapRoute) => tprMapRoute = mapRoute); tprMapRoute.hide(); // Caso de uso 10: Reexibir rota tprMapRoute.show(); // Caso de uso 11: Trocar cor de rota tprMapRoute.color("AABBCC#AABBCC"); // Caso de uso 12: Exibir popup nas paradas tprMap.viewRoute(new TPRRoute([{latitude: -23, longitude: -46}, {latitude: -22, longitude: -45}]), (new TPRTrip(...)), new TPRRouteOptions(true)); // Caso de uso 12.1: Permitir alteração de rotas (Fluxo ocorre apenas quando há uma rota no mapa e a rota possui identificador. OBS: é necessário ter uma callbackURL no modelo de SystemInfo ex: {"system": "system-1.0.0", "version": "1.0.0", "qualifiers": "", callbackURL:"https://abc.com.br"} ) tprMap.viewRoute(new TPRRoute(new TPRTrip(...), "someRouteIdentifierToRouteAlteration"), new TPRRouteOptions(true)); // Caso de uso 13: Receber evento de drag dos marcadores tprMap.addMarker({latitude: -23, longitude: -46}, { draggable: true, onDrag: (lat, long) => console.log("Arrastei o marcador") }); })(); |
Anexos