Модуль:Graph/doc

Module with helper functions for the Graph extension.

Functions for templates

map

Creates a JSON object for <graph> to display a political map with colored highlights. In the article namespace the template {{Graph:Map}} should be used instead. See its page for use cases.

Maps can be found at Special:Prefixindex/Module:Graph/ (for example WorldMap-iso2.json with country borders) and new maps should also be saved under Module:Graph/.

Parameters:

• basemap: sets the base map. The map definitions must follow the TopoJSON format and if saved in Wikipedia are available for this module. Maps in the default directory Special:Prefixindex/Module:Graph/ like WorldMap-iso2.json should only be referenced by their name while omitting the Modul:Graph/ prefix to allow better portability. The parameter also accepts URLs, e.g. maps from other Wikipedia versions (the link should follow the scheme of //ru.wikipedia.org/w/index.php?title=mapname&action=raw, i.e. protocol-relative without leading http/s and a trailing action=raw to fetch the raw content only). URLs to maps on external sites should be avoided for the sake of link stability, performance, security, and she be assumed to be blocked by the software or browser anyway.
• scale: the scaling factor of the map (default: 100)
• projection: the map projection to use. Supported values are listed at https://github.com/mbostock/d3/wiki/Geo-Projections. The default value is equirectangular for an equirectangular projection.
• center: map center (corresponds in the map data to both comma-separated values of the scale field)
• feature: which geographic objects should be displayed (corresponds in the map data to the name of the field under the objects field). The default is value countries.
• ids of geographic entities: The actual parameter names depend on the base map and the selected feature. For example, for the above mentioned world map the ids are ISO country codes. The values can be either colors or numbers in case the geographic entities should be associated with numeric data: DE=lightblue marks Germany in light blue color, and DE=80.6 assigns Germany the value 80.6 (population in millions). In the latter case, the actual color depends on the following parameters.
• colorScale: the color palette to use for the color scale. The palette must be provided as a comma-separated list of color values. The color values must be given either as #rgb/#rrggbb or by a CSS color name. Instead of a list, the built-in color palettes category10 and category20 can also be used.
• scaleType: supported values are linear for a linear mapping between the data values and the color scale, log for a log mapping, pow for a power mapping (the exponent can be provided as pow 0.5), sqrt for a square-root mapping, and quantize for a quantized scale, i.e. the data is grouped in as many classes as the color palette has colors.
• domainMin: lower boundary of the data values, i.e. smaller data values are mapped to the lower boundary
• domainMax: upper boundary of the data values, i.e. larger data values are mapped to the upper boundary
• legend: show color legend (does not work with quantize)
• defaultValue: default value for unused geographic entities. In case the id values are colors the default value is silver, in case of numbers it is 0.
• formatjson: format JSON object for better legibility

chart

Создаёт JSON-объект для отображения диаграммы в тэге <graph>. В пространстве статей стоит использовать шаблон {{Graph:Chart}}. См. примеры на его странице.

Параметры:

• width: ширина диаграммы
• height: высота диаграммы
• type: тип диаграммы: line для линейных, area для диаграмм с областями, rect для (вертикальной) столбчатых и pie для круговых диаграмм. Ряды данных могут быть наложены друг на друга с помощью префикса stacked, например, stackedarea.
• interpolate: метод интерполяции для линейных диаграмм и диаграмм с областями. Рекомендуется использовать monotone для монотонной кубической интерполяции, другие значения перечислены на https://github.com/vega/vega/wiki/Marks#area.
• colors: цветовая палитра диаграммы списком, разделённым запятой. Значения цветов должны указываться в форматах #rgb/#rrggbb/#aarrggbb или по названию в CSS. В формате #aarrggbb aa — альфа-канал, т. е. FF = 100% прозрачности, 80 = 50% прозрачности и т. п. (Стандартная цветовая палитра — category10.)
• xAxisTitle и yAxisTitle: заголовки для осей x и y
• xAxisMin, xAxisMax, yAxisMin и yAxisMax: минимальные и максимальные значения осей x и y (пока не поддерживается для столбчатых диаграмм)
• xAxisFormat и yAxisFormat: меняет форматирование меток у осей. Поддерживаемые значения перечислены на https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#numbers для чисел и https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md для дат/времени. Например, формат % можно использовать для вывода процентов.
• xAxisAngle: поворачивает метки на оси x на указанное число градусов. Рекомендуемые значения: -45, +45, -90, +90
• xType и yType: типы данных для значений, например, integer для целых чисел, number для вещественных чисел, date для дат (например, ГГГГ/ММ/ДД) и string для порядковых значений.
• xGrid=x и yGrid=y: включает сетки по осям.
• x: значения x, разделённые запятой.
• y или y1, y2, …: значения y для одной или нескольких рядов данных соответственно. В круговых диаграммах y2 указывает радиусы соответствующих секторов.
• legend: показать легенду (работает для нескольких рядов данных)
• y1Title, y2Title, …: метки соответствующих рядов данных в легенде
• linewidth: ширина линии в линейных диаграммах или расстояние между сегментами круга в круговых диаграммах
• linewidths: different line widths may be defined for each series of data with csv, if set to 0 with "showSymbols" results with points graph, eg.: linewidths=1, 0, 5, 0.2
• showSymbols: (для линейных диаграмм) показать символ (круг) на каждой точке данных, if number is provided it's size of symbol, default 2.5. may be defined for each series of data with csv, eg.: showSymbols=1, 2, 3, 4
• symbolsShape: custom shape for symbol: circle, x, square, cross, diamond, triangle_up, triangle_down, triangle_right, triangle_left. May be defined for each series of data with csv, eg.: symbolsShape= circle, cross, square
• symbolsNoFill: if true symbol will be without fill (only stroke),
• symbolsStroke: if "x" symbol is used or option "symbolsNoFill" symbol stroke width, default 2.5
• showValues: выводить значения y текстом. (На текущий момент, поддерживаются (нестековые) столбчатые диаграммы и круговые диаграммы.) Вывод может настраиваться через следующие параметры, заданные как название1:значение1, название2:значение2:
  • format: отформатировать вывод в соответствии с https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#numbers для чисел и https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md для времени.
  • fontcolor: цвет текста
  • fontsize: размер текста
  • offset: передвинуть текст на заданное расстояние. Для круговых диаграмм с параметром midangle и столбчатых диаграмм этот параметр также задаёт, внутри или снаружи находится текст.
  • angle (только в круговых диаграммах): угол текста в градусах или midangle (по умолчанию) для динамических углов на основании среднего угла сектора круговой диаграммы.
• innerRadius: (для круговых диаграмм) задаёт внутренний радиус для создания «диаграммы-пончика».
• Annotations
  • vAnnotatonsLine and hAnnotatonsLine: display vertical or horizontal annotation lines on specific values e.g. hAnnotatonsLine=4, 5, 6
  • vAnnotatonsLabel and vAnnotatonsLabel: display vertical or horizontal annotation labels for lines e.g. hAnnotationLabel = label1, label2, label3
• formatjson: отформатировать JSON-объект для лучшей читаемости

Template wrappers

The functions mapWrapper and chartWrapper are wrappers to pass all parameters of the calling template to the respective map and chart functions.

Внимание: При предпросмотре расширение Graph создаёт элемент canvas с векторной графикой. После сохранения генерируется PNG-изображение.