Changed readme.

tulov · Nov 13, 2013 · 03785f4 · 03785f4
1 parent e0ef679
commit 03785f4
Showing 1 changed file with 80 additions and 47 deletions.
diff --git a/README.md b/README.md
@@ -28,25 +28,34 @@ yaMap
     2 запустить node web-server.js находясь в папке с примерами.
     3 ввести в браузере: localhost: 8000
 
+
+----------
+
 Поддержка событий
 -----
-Реализована поддержка для всех событий. Чтобы подписаться на любое событие нужно определить атрибут с ya-event[-object]-eventname, где вместо eventname нужно подставить имя события, а вместо object, если необходимо, то подставить имя свойства, на событие которого подписываемся. Например ya-event-click - для подписки на событие click, или ya-event-geoobjects-add - для подписки на событие add для map.geoObjects. Работать с ними нужно так же, как и с встроенными директивами событий, такими как ng-click.
-Чтобы получить родной объект события используйте $event. Получить объект, породивший событие можно через $event.get('target')
-Соответственно события нужно определять в той директиве, к которой они относятся, например события карты в yaMap.
+Реализована поддержка для всех событий. Чтобы подписаться на любое событие нужно определить атрибут с `ya-event[-object]-eventname`, где вместо `eventname` нужно подставить имя события, а вместо `object`, если необходимо, то подставить имя свойства, на событие которого подписываемся. Например `ya-event-click` - для подписки на событие `click`, или `ya-event-geoobjects-add` - для подписки на событие `add` для `map.geoObjects`. 
+
+Работать с ними нужно так же, как и с встроенными директивами событий, такими как `ng-click`.
+Чтобы получить родной объект события используйте `$event`. Получить объект, породивший событие можно через `$event.get('target')`
+Соответственно события нужно определять в той директиве, к которой они относятся, например события карты в `yaMap`.
 
 Директива yaMap
 -----
 Представляет карту на вашей странице. Именно в ней должны располагаться практически все остальные директивы.
+
 Атрибуты:
-    ya-center - выражение, которое должно возвращать массив координат, или строку адреса. Если не задан, тогда определяется текущее местоположение пользователя и используется в качестве центра.
-    ya-zoom - массштаб карты, по умолчанию 0. Диапазон от 0-23 включительно. 0 самый мелкий (вся земля).
-    ya-type - тип карты, возможные значения:
+
+ - `ya-center` - выражение, которое должно возвращать массив координат, или строку адреса. Если не задан, тогда определяется текущее местоположение пользователя и используется в качестве центра.
+ - `ya-zoom` - массштаб карты, по умолчанию 0. Диапазон от 0-23 включительно. 0 самый мелкий (вся земля).
+ - `ya-type` - тип карты, возможные значения:
+
         yandex#map (схема) - по умолчанию;
         yandex#satellite (спутник);
         yandex#hybrid (гибрид);
         yandex#publicMap (народная карта);
         yandex#publicMapHybrid (гибрид народной карты)
-    ya-behaviors - поведения карты, задается в виде строки с разделительным пробелом между значениями. По умолчанию - default. Чтобы удалить какие-либо поведения, из нужно поставить перед их именем знак "-". Доступные значения:
+ - `ya-behaviors` - поведения карты, задается в виде строки с разделительным пробелом между значениями. По умолчанию - `default`. Чтобы удалить какие-либо поведения, нужно поставить перед их именем знак "-". Доступные значения:
+
             "default" — короткий 	синоним для включения/отключения поведений карты по умолчанию:
                 для настольных браузеров - "drag", "dblClickZoom", "rightMouseButtonMagnifier",
                 для мобильных - "drag", "dblClickZoom" и "multiTouch"
@@ -58,64 +67,88 @@ yaMap
             "leftMouseButtonMagnifier" — увеличение области, выделенной левой кнопкой мыши либо одиночным касанием
             "ruler" — измерение 	расстояния
             "routeEditor" — редактор маршрутов
-    ya-options - опции карты. При задании опции projection используется следующий формат:
-        projection:{type:'Cartesian', bounds:[[-1, -1],[1, 1]]}, где type - задает класс для создания проекции, а bounds - координаты ограничивающего прямоугольника проекции. Остальные опции задаются как обычно.
-    ya-before-init - задает функцию, которая будет выполнена после подготовки api карт, но до создания самой карты.
-    ya-after-init - задает функцию, которая будет выполнена после создания объекта карты. Чтобы получить сам объект карты,используйте $target.
-
- Директива yaToolbar
- -----
-Представляет набор элементов управления на карте. Обязательно должна находится в yaMap. Возможные атрибуты:
-    ya-name - обязательный. Задает имя контролла для отображения. Доступные значения: 'zoomControl','typeSelector','mapTools','scaleLine','miniMap','searchControl', 'trafficControl' и 'smallZoomControl'.
-    ya-options - выражение, которое должно возвращать объект с настройками для контрола. По умолчанию не установлено.
-    ya-params - параметры создания контрола. по умолчанию не установлены.
-    ya-after-init - задает функцию, которая будет выполнена после создания объекта. Чтобы получить сам объект,используйте $target.
+ - `ya-options` - опции карты. При задании опции `projection` используется следующий формат:
+        `projection:{type:'Cartesian', bounds:[[-1, -1],[1, 1]]}`, где `type` - задает класс для создания проекции, а `bounds` - координаты ограничивающего прямоугольника проекции. Остальные опции задаются как обычно.
+    `ya-before-init` - задает функцию, которая будет выполнена после подготовки api карт, но до создания самой карты.
+    `ya-after-init` - задает функцию, которая будет выполнена после создания объекта карты. Чтобы получить сам объект карты,используйте `$target`.
+
+Директива yaToolbar
+-----
+Представляет набор элементов управления на карте. Обязательно должна находится в yaMap. 
+
+Возможные атрибуты:
+
+ - `ya-name` - обязательный. Задает имя контрола для отображения. Доступные значения: `'zoomControl'`,`'typeSelector'`,`'mapTools'`,`'scaleLine'`,`'miniMap'`,`'searchControl'`, `'trafficControl'` и `'smallZoomControl'`.
+ - `ya-options` - выражение, которое должно возвращать объект с настройками для контрола. По умолчанию не установлено.
+    `ya-params` - параметры создания контрола. по умолчанию не установлены.
+    `ya-after-init` - задает функцию, которая будет выполнена после создания объекта. Чтобы получить сам объект,используйте `$target`.
 
 Директива yaControl
 -----
-Представляет элемент управления на карте. Должна стоять внутри yaToolbar Атрибуты:
-    ya-type- тип создаваемого элемента управления.
-    ya-params - параметры элемента управления
-    ya-after-init - задает функцию, которая будет выполнена после создания объекта. Чтобы получить сам объект,используйте $target.
+Представляет элемент управления на карте. Должна стоять внутри `yaToolbar` 
+
+Атрибуты:
+
+ - `ya-type` - тип создаваемого элемента управления.
+ - `ya-params` - параметры элемента управления
+ - `ya-after-init` - задает функцию, которая будет выполнена после создания объекта. Чтобы получить сам объект,используйте `$target`.
 
 Директива yaCollection
 -----
-представляет коллекцию гео.объектов. Должна находиться внутри yaMap. Атрибуты:
-    ya-options - задает настройки отображения объектов для всей коллекции. По умолчанию {}.
-    ya-show-all - подстраивать масштаб карты и ее центр при первом отображении, для того чтобы отображались все доступные гео.объекты. По умолчанию: false
-    ya-after-init - задает функцию, которая будет выполнена после создания объекта. Чтобы получить сам объект,используйте $target.
+представляет коллекцию гео.объектов. Должна находиться внутри `yaMap`. 
+
+Атрибуты:
+
+ - `ya-options` - задает настройки отображения объектов для всей коллекции. По умолчанию `{}`.
+ - `ya-show-all` - подстраивать масштаб карты и ее центр при первом отображении, для того чтобы отображались все доступные гео.объекты. По умолчанию: `false`
+ - `ya-after-init` - задает функцию, которая будет выполнена после создания объекта. Чтобы получить сам объект,используйте `$target`.
 
 Директиа yaGeoObject
 -----
-представляет гео. объект карты. Должна стоять в yaMap, или yaCollection или yaCluster. Атрибуты:
-    ya-source - задает источник данных для гео. объекта.
-    ya-options - задает настройки отображения для конкретного гео. объекта.
-    ya-edit - если задан, переводит объект в режим редактирования
-    ya-draw - если задан, переводит объект в режим рисования.
-    ya-show-balloon - выражение, если оно возвращает true, то балун будет открыт, иначе закрыт.
-    ya-after-init - задает функцию, которая будет выполнена после создания объекта. Чтобы получить сам объект,используйте $target.
+представляет гео. объект карты. Должна стоять в `yaMap` или `yaCollection`, или `yaCluster`. 
+
+Атрибуты:
+
+ - `ya-source` - задает источник данных для гео. объекта.
+ - `ya-options` - задает настройки отображения для конкретного гео. объекта.
+ - `ya-edit` - если задан, переводит объект в режим редактирования
+ - `ya-draw` - если задан, переводит объект в режим рисования.
+ - `ya-show-balloon` - выражение, если оно возвращает true, то балун будет открыт, иначе закрыт.
+ - `ya-after-init` - задает функцию, которая будет выполнена после создания объекта. Чтобы получить сам объект,используйте `$target`.
 
 Директива yaImageLayer
 -----
-Представляет собой картиночный слой карты. Должна находиться в yaMap. Имеет атрибуты:
-    ya-url-template - шаблон URL тайлов картиночного слоя. Обязательный атрибут
-    ya-options - настройка отображения слоя на карте. Не обязательный атрибут.
+Представляет собой картиночный слой карты. Должна находиться в yaMap. 
+
+Имеет атрибуты:
+
+ - `ya-url-template` - шаблон URL тайлов картиночного слоя. Обязательный атрибут
+ - `ya-options` - настройка отображения слоя на карте. Не обязательный атрибут.
 
 Директива yaHotspotLayer
 -----
-Представляет собой активный слой карты. Должна находиться в yaMap. Имеет атрибуты:
-    ya-url-template - Шаблон URL для данных активных областей. Обязательный атрибут.
-    ya-key-template - Шаблон callback-функции, в которую сервер будет оборачивать данные тайла. Обязательный атрибут.
-    ya-options - настройки отображения слоя на карте. Не обязательный атрибут.
+Представляет собой активный слой карты. Должна находиться в yaMap. 
+
+Имеет атрибуты:
+
+ - `ya-url-template` - Шаблон URL для данных активных областей. Обязательный атрибут.
+ - `ya-key-template` - Шаблон callback-функции, в которую сервер будет оборачивать данные тайла. Обязательный атрибут.
+ - `ya-options` - настройки отображения слоя на карте. Не обязательный атрибут.
 
 Директива yaCluster
 -----
-Представляет кластеризатор карты. Должна находиться в yaMap. Имеет атрибуты:
-    ya-options - задает опции для кластера.
-    ya-after-init - задает функцию, которая будет выполнена после создания объекта. Чтобы получить сам объект,используйте $target.
+Представляет кластеризатор карты. Должна находиться в `yaMap`. 
+
+Имеет атрибуты:
+
+ - `ya-options` - задает опции для кластера.
+ - `ya-after-init` - задает функцию, которая будет выполнена после создания объекта. Чтобы получить сам объект,используйте `$target`.
 
 Директива yaTemplateLayout
 -----
-Представляет собой HTML шаблон, который должен использоваться элементами карты. Должна определяться до использования соответствующего шаблона. Имеет атрибуты:
-ya-key - ключ для дальнейшего обращения к шаблону
-ya-overrides - объект, который задает переопределяемые функции.
+Представляет собой HTML шаблон, который должен использоваться элементами карты. Должна определяться до использования соответствующего шаблона.
+
+Имеет атрибуты:
+
+ - `ya-key` - ключ для дальнейшего обращения к шаблону
+ - `ya-overrides` - объект, который задает переопределяемые функции.