Simon Hunt | 7ac7be9 | 2015-01-06 10:47:56 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Laboratory |
Simon Hunt | 7ac7be9 | 2015-01-06 10:47:56 -0800 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | /* |
| 18 | ONOS GUI -- SVG -- Icon Service |
Simon Hunt | 7ac7be9 | 2015-01-06 10:47:56 -0800 | [diff] [blame] | 19 | */ |
| 20 | (function () { |
| 21 | 'use strict'; |
| 22 | |
Simon Hunt | 1894d79 | 2015-02-04 17:09:20 -0800 | [diff] [blame] | 23 | var $log, fs, gs, sus; |
Simon Hunt | 7f172cc | 2015-01-16 17:43:00 -0800 | [diff] [blame] | 24 | |
Simon Hunt | 9722538 | 2015-01-19 13:33:09 -0800 | [diff] [blame] | 25 | var vboxSize = 50, |
| 26 | cornerSize = vboxSize / 10, |
| 27 | viewBox = '0 0 ' + vboxSize + ' ' + vboxSize; |
Simon Hunt | 7f172cc | 2015-01-16 17:43:00 -0800 | [diff] [blame] | 28 | |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 29 | // Maps icon ID to the glyph ID it uses. |
| 30 | // NOTE: icon ID maps to a CSS class for styling that icon |
Simon Hunt | 7f172cc | 2015-01-16 17:43:00 -0800 | [diff] [blame] | 31 | var glyphMapping = { |
Bri Prebilic Cole | ab582b8 | 2015-04-14 15:08:22 -0700 | [diff] [blame] | 32 | active: 'checkMark', |
| 33 | inactive: 'xMark', |
Thomas Vachuska | 0fa583c | 2015-03-30 23:07:41 -0700 | [diff] [blame] | 34 | |
Bri Prebilic Cole | ab582b8 | 2015-04-14 15:08:22 -0700 | [diff] [blame] | 35 | plus: 'plus', |
| 36 | minus: 'minus', |
| 37 | play: 'play', |
| 38 | stop: 'stop', |
Simon Hunt | 986b92f | 2016-06-03 15:46:59 -0700 | [diff] [blame] | 39 | |
| 40 | close: 'xClose', |
Bri Prebilic Cole | ab582b8 | 2015-04-14 15:08:22 -0700 | [diff] [blame] | 41 | |
Simon Hunt | 4e41273 | 2015-10-27 15:25:39 -0700 | [diff] [blame] | 42 | topo: 'topo', |
| 43 | |
Bri Prebilic Cole | 43f17c0 | 2015-05-01 10:43:38 -0700 | [diff] [blame] | 44 | refresh: 'refresh', |
Bri Prebilic Cole | bd0bc77 | 2015-05-13 13:02:26 -0700 | [diff] [blame] | 45 | garbage: 'garbage', |
Bri Prebilic Cole | 3d4d01c | 2015-04-30 13:48:36 -0700 | [diff] [blame] | 46 | |
Bri Prebilic Cole | ab582b8 | 2015-04-14 15:08:22 -0700 | [diff] [blame] | 47 | upArrow: 'triangleUp', |
| 48 | downArrow: 'triangleDown', |
| 49 | |
| 50 | appInactive: 'unknown', |
| 51 | |
Bri Prebilic Cole | dea0974 | 2015-02-12 15:33:50 -0800 | [diff] [blame] | 52 | devIcon_SWITCH: 'switch', |
Thomas Vachuska | 58eded6 | 2015-03-31 12:04:03 -0700 | [diff] [blame] | 53 | devIcon_ROADM: 'roadm', |
Rimon Ashkenazy | 8ebfff0 | 2016-02-01 11:56:36 +0200 | [diff] [blame] | 54 | devIcon_OTN: 'otn', |
Simon Hunt | 864333a | 2015-11-16 17:08:08 -0800 | [diff] [blame] | 55 | deviceTable: 'switch', |
Bri Prebilic Cole | 9b1fb9a | 2015-07-01 13:57:11 -0700 | [diff] [blame] | 56 | flowTable: 'flowTable', |
| 57 | portTable: 'portTable', |
| 58 | groupTable: 'groupTable', |
Jian Li | 1f54473 | 2015-12-30 23:36:37 -0800 | [diff] [blame] | 59 | meterTable: 'meterTable', |
Thomas Vachuska | 58eded6 | 2015-03-31 12:04:03 -0700 | [diff] [blame] | 60 | |
| 61 | hostIcon_endstation: 'endstation', |
| 62 | hostIcon_router: 'router', |
Simon Hunt | 20e1679 | 2015-04-24 14:29:39 -0700 | [diff] [blame] | 63 | hostIcon_bgpSpeaker: 'bgpSpeaker', |
| 64 | |
Simon Hunt | 986b92f | 2016-06-03 15:46:59 -0700 | [diff] [blame] | 65 | // navigation menu icons... |
Simon Hunt | 20e1679 | 2015-04-24 14:29:39 -0700 | [diff] [blame] | 66 | nav_apps: 'bird', |
Thomas Vachuska | aa8b0eb | 2015-05-22 09:54:15 -0700 | [diff] [blame] | 67 | nav_settings: 'chain', |
Simon Hunt | 20e1679 | 2015-04-24 14:29:39 -0700 | [diff] [blame] | 68 | nav_cluster: 'node', |
Simon Hunt | 986b92f | 2016-06-03 15:46:59 -0700 | [diff] [blame] | 69 | nav_processors: 'allTraffic', |
| 70 | |
Bri Prebilic Cole | 6ed04eb | 2015-04-27 16:26:03 -0700 | [diff] [blame] | 71 | nav_topo: 'topo', |
Simon Hunt | 20e1679 | 2015-04-24 14:29:39 -0700 | [diff] [blame] | 72 | nav_devs: 'switch', |
| 73 | nav_links: 'ports', |
| 74 | nav_hosts: 'endstation', |
Thomas Vachuska | 3ece373 | 2015-09-22 23:58:50 -0700 | [diff] [blame] | 75 | nav_intents: 'relatedIntents', |
Simon Hunt | 986b92f | 2016-06-03 15:46:59 -0700 | [diff] [blame] | 76 | nav_tunnels: 'ports' // TODO: use tunnel glyph, when available |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 77 | }; |
| 78 | |
Simon Hunt | 9722538 | 2015-01-19 13:33:09 -0800 | [diff] [blame] | 79 | function ensureIconLibDefs() { |
| 80 | var body = d3.select('body'), |
Simon Hunt | 24d0c5c | 2016-03-03 00:05:08 -0800 | [diff] [blame] | 81 | svg = body.select('svg#IconLibDefs'); |
Simon Hunt | 9722538 | 2015-01-19 13:33:09 -0800 | [diff] [blame] | 82 | |
| 83 | if (svg.empty()) { |
| 84 | svg = body.append('svg').attr('id', 'IconLibDefs'); |
Simon Hunt | 24d0c5c | 2016-03-03 00:05:08 -0800 | [diff] [blame] | 85 | svg.append('defs'); |
Simon Hunt | 9722538 | 2015-01-19 13:33:09 -0800 | [diff] [blame] | 86 | } |
| 87 | return svg.select('defs'); |
| 88 | } |
| 89 | |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 90 | // div is a D3 selection of the <DIV> element into which icon should load |
Bri Prebilic Cole | 40be6b2 | 2015-02-19 17:12:23 -0800 | [diff] [blame] | 91 | // glyphId identifies the glyph to use |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 92 | // size is dimension of icon in pixels. Defaults to 20. |
| 93 | // installGlyph, if truthy, will cause the glyph to be added to |
| 94 | // well-known defs element. Defaults to false. |
| 95 | // svgClass is the CSS class used to identify the SVG layer. |
| 96 | // Defaults to 'embeddedIcon'. |
Bri Prebilic Cole | 40be6b2 | 2015-02-19 17:12:23 -0800 | [diff] [blame] | 97 | function loadIcon(div, glyphId, size, installGlyph, svgClass) { |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 98 | var dim = size || 20, |
| 99 | svgCls = svgClass || 'embeddedIcon', |
Bri Prebilic Cole | 40be6b2 | 2015-02-19 17:12:23 -0800 | [diff] [blame] | 100 | gid = glyphId || 'unknown', |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 101 | svg, g; |
| 102 | |
| 103 | if (installGlyph) { |
| 104 | gs.loadDefs(ensureIconLibDefs(), [gid], true); |
| 105 | } |
| 106 | |
| 107 | svg = div.append('svg').attr({ |
| 108 | 'class': svgCls, |
| 109 | width: dim, |
| 110 | height: dim, |
| 111 | viewBox: viewBox |
| 112 | }); |
| 113 | |
| 114 | g = svg.append('g').attr({ |
Bri Prebilic Cole | 40be6b2 | 2015-02-19 17:12:23 -0800 | [diff] [blame] | 115 | 'class': 'icon' |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 116 | }); |
| 117 | |
| 118 | g.append('rect').attr({ |
| 119 | width: vboxSize, |
| 120 | height: vboxSize, |
| 121 | rx: cornerSize |
| 122 | }); |
| 123 | |
Bri Prebilic Cole | e1bda3f | 2015-02-13 17:01:49 -0800 | [diff] [blame] | 124 | g.append('use').attr({ |
| 125 | width: vboxSize, |
| 126 | height: vboxSize, |
| 127 | 'class': 'glyph', |
| 128 | 'xlink:href': '#' + gid |
| 129 | }); |
Bri Prebilic Cole | 40be6b2 | 2015-02-19 17:12:23 -0800 | [diff] [blame] | 130 | } |
| 131 | |
| 132 | // div is a D3 selection of the <DIV> element into which icon should load |
| 133 | // iconCls is the CSS class used to identify the icon |
| 134 | // size is dimension of icon in pixels. Defaults to 20. |
| 135 | // installGlyph, if truthy, will cause the glyph to be added to |
| 136 | // well-known defs element. Defaults to false. |
| 137 | // svgClass is the CSS class used to identify the SVG layer. |
| 138 | // Defaults to 'embeddedIcon'. |
| 139 | function loadIconByClass(div, iconCls, size, installGlyph, svgClass) { |
| 140 | loadIcon(div, glyphMapping[iconCls], size, installGlyph, svgClass); |
| 141 | div.select('svg g').classed(iconCls, true); |
| 142 | } |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 143 | |
| 144 | function loadEmbeddedIcon(div, iconCls, size) { |
Bri Prebilic Cole | 40be6b2 | 2015-02-19 17:12:23 -0800 | [diff] [blame] | 145 | loadIconByClass(div, iconCls, size, true); |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 146 | } |
Simon Hunt | a5487ad | 2016-06-16 13:10:41 -0700 | [diff] [blame] | 147 | |
Simon Hunt | f44d726 | 2016-06-14 14:46:56 -0700 | [diff] [blame] | 148 | // Adds a device glyph to the specified element. |
| 149 | // Returns the D3 selection of the glyph (use) element. |
| 150 | function addDeviceIcon(elem, glyphId, iconDim) { |
| 151 | var gid = gs.glyphDefined(glyphId) ? glyphId : 'query'; |
| 152 | return elem.append('use').attr({ |
Simon Hunt | 044f2807 | 2015-10-08 12:38:16 -0700 | [diff] [blame] | 153 | 'xlink:href': '#' + gid, |
Simon Hunt | f44d726 | 2016-06-14 14:46:56 -0700 | [diff] [blame] | 154 | width: iconDim, |
| 155 | height: iconDim |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 156 | }); |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 157 | } |
| 158 | |
Simon Hunt | 1894d79 | 2015-02-04 17:09:20 -0800 | [diff] [blame] | 159 | function addHostIcon(elem, radius, glyphId) { |
| 160 | var dim = radius * 1.5, |
| 161 | xlate = -dim / 2, |
| 162 | g = elem.append('g') |
| 163 | .attr('class', 'svgIcon hostIcon'); |
| 164 | |
| 165 | g.append('circle').attr('r', radius); |
| 166 | |
| 167 | g.append('use').attr({ |
| 168 | 'xlink:href': '#' + glyphId, |
| 169 | width: dim, |
| 170 | height: dim, |
| 171 | transform: sus.translate(xlate,xlate) |
| 172 | }); |
| 173 | return g; |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 174 | } |
| 175 | |
Bri Prebilic Cole | 3d4d01c | 2015-04-30 13:48:36 -0700 | [diff] [blame] | 176 | function sortIcons() { |
Simon Hunt | 051e9fa | 2016-01-19 15:54:22 -0800 | [diff] [blame] | 177 | function _s(div, gid) { |
Bri Prebilic Cole | 1f93be2 | 2015-02-10 17:16:46 -0800 | [diff] [blame] | 178 | div.style('display', 'inline-block'); |
Simon Hunt | 051e9fa | 2016-01-19 15:54:22 -0800 | [diff] [blame] | 179 | loadEmbeddedIcon(div, gid, 10); |
Simon Hunt | 3695a62 | 2015-03-31 11:52:23 -0700 | [diff] [blame] | 180 | div.classed('tableColSort', true); |
Bri Prebilic Cole | 1f93be2 | 2015-02-10 17:16:46 -0800 | [diff] [blame] | 181 | } |
| 182 | |
Bri Prebilic Cole | 1f93be2 | 2015-02-10 17:16:46 -0800 | [diff] [blame] | 183 | return { |
Simon Hunt | 051e9fa | 2016-01-19 15:54:22 -0800 | [diff] [blame] | 184 | asc: function (div) { _s(div, 'upArrow'); }, |
| 185 | desc: function (div) { _s(div, 'downArrow'); }, |
| 186 | none: function (div) { div.remove(); } |
Bri Prebilic Cole | 1f93be2 | 2015-02-10 17:16:46 -0800 | [diff] [blame] | 187 | }; |
| 188 | } |
| 189 | |
Simon Hunt | 6f7668c | 2016-02-02 14:27:11 -0800 | [diff] [blame] | 190 | function registerIconMapping(iconId, glyphId) { |
| 191 | if (glyphMapping[iconId]) { |
| 192 | $log.warn('Icon with id', iconId, 'already mapped. Ignoring.'); |
| 193 | } else { |
Simon Hunt | 24d0c5c | 2016-03-03 00:05:08 -0800 | [diff] [blame] | 194 | // map icon-->glyph |
Simon Hunt | 6f7668c | 2016-02-02 14:27:11 -0800 | [diff] [blame] | 195 | glyphMapping[iconId] = glyphId; |
Simon Hunt | 24d0c5c | 2016-03-03 00:05:08 -0800 | [diff] [blame] | 196 | // make sure definition is installed |
| 197 | gs.loadDefs(ensureIconLibDefs(), [glyphId], true); |
Simon Hunt | 6f7668c | 2016-02-02 14:27:11 -0800 | [diff] [blame] | 198 | } |
| 199 | } |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 200 | |
| 201 | // ========================= |
| 202 | // === DEFINE THE MODULE |
| 203 | |
Simon Hunt | 7ac7be9 | 2015-01-06 10:47:56 -0800 | [diff] [blame] | 204 | angular.module('onosSvg') |
Bri Prebilic Cole | 0c41ba2 | 2015-07-06 15:09:48 -0700 | [diff] [blame] | 205 | .directive('icon', ['IconService', function (is) { |
| 206 | return { |
| 207 | restrict: 'A', |
| 208 | link: function (scope, element, attrs) { |
| 209 | attrs.$observe('iconId', function () { |
| 210 | var div = d3.select(element[0]); |
| 211 | div.selectAll('*').remove(); |
| 212 | is.loadEmbeddedIcon(div, attrs.iconId, attrs.iconSize); |
| 213 | }); |
| 214 | } |
| 215 | }; |
| 216 | }]) |
| 217 | |
Simon Hunt | 9722538 | 2015-01-19 13:33:09 -0800 | [diff] [blame] | 218 | .factory('IconService', ['$log', 'FnService', 'GlyphService', |
Simon Hunt | 1894d79 | 2015-02-04 17:09:20 -0800 | [diff] [blame] | 219 | 'SvgUtilService', |
| 220 | |
| 221 | function (_$log_, _fs_, _gs_, _sus_) { |
Simon Hunt | 7ac7be9 | 2015-01-06 10:47:56 -0800 | [diff] [blame] | 222 | $log = _$log_; |
Simon Hunt | 7f172cc | 2015-01-16 17:43:00 -0800 | [diff] [blame] | 223 | fs = _fs_; |
Simon Hunt | 9722538 | 2015-01-19 13:33:09 -0800 | [diff] [blame] | 224 | gs = _gs_; |
Simon Hunt | 1894d79 | 2015-02-04 17:09:20 -0800 | [diff] [blame] | 225 | sus = _sus_; |
Simon Hunt | 7f172cc | 2015-01-16 17:43:00 -0800 | [diff] [blame] | 226 | |
Simon Hunt | 7ac7be9 | 2015-01-06 10:47:56 -0800 | [diff] [blame] | 227 | return { |
Simon Hunt | 9722538 | 2015-01-19 13:33:09 -0800 | [diff] [blame] | 228 | loadIcon: loadIcon, |
Bri Prebilic Cole | 40be6b2 | 2015-02-19 17:12:23 -0800 | [diff] [blame] | 229 | loadIconByClass: loadIconByClass, |
Simon Hunt | ac4c6f7 | 2015-02-03 19:50:53 -0800 | [diff] [blame] | 230 | loadEmbeddedIcon: loadEmbeddedIcon, |
| 231 | addDeviceIcon: addDeviceIcon, |
| 232 | addHostIcon: addHostIcon, |
Simon Hunt | 6f7668c | 2016-02-02 14:27:11 -0800 | [diff] [blame] | 233 | sortIcons: sortIcons, |
| 234 | registerIconMapping: registerIconMapping |
Simon Hunt | 7ac7be9 | 2015-01-06 10:47:56 -0800 | [diff] [blame] | 235 | }; |
| 236 | }]); |
| 237 | |
| 238 | }()); |