ReportMagic

[LogicMonitor.Graph:]

Retrieve data relating to a devices, services etc. and display in chart form in a report.

Purpose

Retrieve data relating to a devices, services etc. and display in chart form in a report. Many of the parameters used by the LogicMonitor.Graph macro are also used by other macros, such as LogicMonitor.SummaryValue.

This macro should specify one of:

device, host, hostId, hosts, group, groups, deviceId, devices, deviceGroup, deviceGroups or serviceName.
graphName, graphId, overviewGraphName, overviewGraphId
dataSourceName or dataSource

Macro Compatibility

The macro can be used in all input document types and in Report Studio.

Parameter	Type	Deprecation Message	Preferred Parameter	Presence	Purpose	Options	Default
chartType	List<String>	Deprecated	chartTypes		The type(s) of chart. You can specify more than one (separated by a semi-colon). If you specify fewer than the number of series, the last value will continue to be used for the remainder of the series. Permitted values: Point, FastPoint, Line, Spline, StepLine, FastLine, Bar, StackedBar, StackedBar100, Column, StackedColumn, StackedColumn100, Area, SplineArea, StackedArea, StackedArea100, Pie, Doughnut, Radar, Polar, BoxPlot, Funnel, Pyramid. For Pie and Doughnut chart types, the first column provides the slice name, the second column the slice size and all other columns are ignored.	N/A	N/A
chartTypes	List<String>	Use instead of: chartType		Conditional	The type(s) of chart. You can specify more than one (separated by a semi-colon). If you specify fewer than the number of series, the last value will continue to be used for the remainder of the series. Permitted values: Point, FastPoint, Line, Spline, StepLine, FastLine, Bar, StackedBar, StackedBar100, Column, StackedColumn, StackedColumn100, Area, SplineArea, StackedArea, StackedArea100, Pie, Doughnut, Radar, Polar, BoxPlot, Funnel, Pyramid. For Pie and Doughnut chart types, the first column provides the slice name, the second column the slice size and all other columns are ignored.	N/A	N/A
customPaletteHexCodes	String			Conditional	When the 'overridePaletteType' parameter is set to 'Custom', you must specify a semi-colon separated list of HTML-style hex codes (or HTML colour names such as red), e.g. #FF0000;#00FF00;#0000FF (with or without the hash) to use as a custom override palette, which will apply to each line series plotted. This parameter is ignored unless you use 'overridePaletteType=Custom'.	N/A	N/A
dataSource	String	Deprecated	dataSourceName		The DataSource name.	N/A	N/A
dataSourceInstanceGroupId	Int32			Conditional	The DataSource instance group id. If set, the dataSource parameter must also be set.	N/A	N/A
dataSourceInstanceGroupName	String			Conditional	The DataSource instance group name. If set, the dataSource parameter must also be set.	N/A	N/A
dataSourceInstanceId	Int32			Conditional	The DataSource instance ID. If set, the dataSource parameter must also be set.	N/A	N/A
dataSourceInstanceName	String			Conditional	The DataSource instance name. If set, the dataSource parameter must also be set.	N/A	N/A
dataSourceName	String	Use instead of: dataSource		Conditional	The DataSource name.	N/A	N/A
graphId	Int32			Conditional	The graph ID. If set, do not set the 'graphName' parameter. You can use -1 to use raw data when there is no graph in LogicMonitor but you must choose the data point name as it appears on the 'Raw Data' tab in LogicMonitor, rather than the name in the DataPoint definition.	N/A	N/A
graphName	String			Conditional	The graph name. If set, do not set the 'graphId' parameter.	N/A	N/A
imageHeightCm	Double			Conditional	The image height in centimetres (cm). If this is set, so should 'imageWidthCm' be. For Word output, this is equivalent to setting an absolute height in cm without locking the aspect ratio.	N/A	N/A
imageWidthCm	Double			Conditional	The image width in centimetres. If this is set, so should 'imageHeightCm' be. For Word output, this is equivalent to setting an absolute with in cm without locking the aspect ratio.	N/A	N/A
interLineAggregation	AdvancedAggregation			Conditional	The aggregation to use for inter-line aggregation if aggregateOverDevices or aggregateOverDataSourceInstances are true.	All Mean Min Max First Last Sum Calc Property Count PercentConditionMet MinDateTime MaxDateTime CountConditionMet Delta DeltaPercent PercentUpTime Percentile	All
overviewGraphId	Int32			Conditional	The overview graph ID.	N/A	N/A
overviewGraphName	String			Conditional	The overview graph name.	N/A	N/A
serviceCheckPointName	List<String>	Deprecated	websiteCheckPointName		The website checkpoint name or names (required when type is set to WebsiteCheckPoint).	N/A	N/A
serviceCheckPointNames	List<String>	Deprecated	websiteCheckPointName		The website checkpoint name or names (required when type is set to WebsiteCheckPoint).	N/A	N/A
serviceName	List<String>	Deprecated	websiteName		The website name or names (required when type is set to WebsiteOverview or WebsiteCheckPoint).	N/A	N/A
serviceNames	List<String>	Deprecated	websiteName		The website name or names (required when type is set to WebsiteOverview or WebsiteCheckPoint).	N/A	N/A
websiteCheckPointName	List<String>	Use instead of: serviceCheckPointName serviceCheckPointNames websiteCheckPointNames		Conditional	The website checkpoint name or names (required when type is set to WebsiteCheckPoint).	N/A	N/A
websiteCheckPointNames	List<String>	Deprecated	websiteCheckPointName		The website checkpoint name or names (required when type is set to WebsiteCheckPoint).	N/A	N/A
websiteName	List<String>	Use instead of: serviceName serviceNames websiteNames		Conditional	The website name or names (required when type is set to WebsiteOverview or WebsiteCheckPoint).	N/A	N/A
websiteNames	List<String>	Deprecated	websiteName		The website name or names (required when type is set to WebsiteOverview or WebsiteCheckPoint).	N/A	N/A
widgetId	Int32			Conditional	The Widget id for dashboard graphs. The type parameter should be set to DashboardWidget. Finding the Widget id requires a few steps: you will need to use your LogicMonitor portal UI, enter developer mode in the browser, and find all 'li' elements (which are the Widgets) where the 'data_component_unique_name' attribute is like xxx_widget_xxx, where xxx are numbers. For example, 99_widget_123 is a Widget id of 123.	N/A	N/A
xAxisLabel	String	Deprecated	xAxisTitle		Set the X Axis Label to the provided text. Required for all chartTypes, except 'Pie' and 'Doughnut'.	N/A	N/A
xAxisTitle	String	Use instead of: xAxisLabel		Conditional	Set the X Axis Label to the provided text. Required for all chartTypes, except 'Pie' and 'Doughnut'.	N/A	N/A
yAxisLabel	String	Deprecated	yAxisTitle		Set the Y Axis Label to the provided text. Required for all chartTypes, except 'Pie' and 'Doughnut'.	N/A	N/A
yAxisTitle	String	Use instead of: yAxisLabel		Conditional	Set the Y Axis Label to the provided text. Required for all chartTypes, except 'Pie' and 'Doughnut'.	N/A	N/A
aggregateOverDataSourceInstances	Boolean			Optional	Whether to aggregate over DataSource instances. If specified, the aggregation parameter must also be specified.	true false	false
aggregateOverDevices	Boolean			Optional	Whether to aggregate over devices. If specified, the aggregation parameter must also be specified.	true false	false
auto	Boolean			Optional	If 'true', the reporting period will be the last calendar month and neither startDate nor endDate parameters may be used.	true false	false
autoScaleBoundaryLabels	Boolean			Optional	Use short (auto-scaled) labels for boundary legend items. When set, the 'boundaryLabelFormat' parameter is ignored.	true false	true
autoScaleBoundaryLabelsAreData	Boolean			Optional	Whether the short (auto-scaled) boundary legend values represent 'data' (B, KB, MB, GB, and TB) and so 1024 is used as a multiplier, rather than 1000. When not representing data, the labels used are: K, M, B, and T. Has no effect unless the 'autoScaleBoundaryLabels' parameter is used.	true false	false
autoScaleYAxisLabels	Boolean	Use instead of: useYAxisShortLabels		Optional	Whether to use short (auto-scaled) labels in Y-axes (e.g. 10K instead of 10000). Only has an effect when the 'yAxisLabelFormat' parameter is NOT set.	true false	true
autoScaleYAxisLabelsAreData	Boolean			Optional	Whether the short (auto-scaled) labels in Y-axes represent 'data'. In that case these labels are used: B, KB, MB, GB, and TB. When not representing data, the labels used are: K (thousands), M (millions), B (billions), and T (trillions). Only has an effect when 'autoScaleYAxisLabels' is true (the default for that parameter), otherwise ignored.	true false	false
autoTitle	Boolean			Optional	Whether to auto-title, based on the LogicMonitor graph title.	true false	false
autoTitleHeadingLevel	Int32	Deprecated	titleHeadingLevel		If auto-titling the graph, the heading level to use.	From 1 to 6	N/A
autoYAxisFrom	GraphAutoYAxisFromType	Deprecated	autoYAxisFromType		When set to ReportMagic, it ignores the 'yAxisMinimum' and 'yAxisMaximum' parameters, and those in the LogicMonitor graph, but instead focuses (effectively zooms in) more closely on the data's actual min/max, which can more clearly illustrate small variations in the data.	LogicMonitor ReportMagic	LogicMonitor
autoYAxisFromType	GraphAutoYAxisFromType	Use instead of: autoYAxisFrom		Optional	When set to ReportMagic, it ignores the 'yAxisMinimum' and 'yAxisMaximum' parameters, and those in the LogicMonitor graph, but instead focuses (effectively zooms in) more closely on the data's actual min/max, which can more clearly illustrate small variations in the data.	LogicMonitor ReportMagic	LogicMonitor
boundaryLabelFormat	String			Optional	The number format for the min/max/mean values of LogicMonitor boundaries when used in the graph's legend titles. ONLY applies when 'showBoundaries' is used and applicable, otherwise ignored.	N/A	F2
chartAreaBackgroundColor	Color			Optional	The chart area background color	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
chartAreaHeightPercent	Int32			Optional	The ChartAreaHeightPercent	From 0 to 100	100
chartAreaWidthPercent	Int32			Optional	The ChartAreaWidthPercent	From 0 to 100	80
chartAreaXPosition	Int32			Optional	The ChartAreaXPosition	From 0 to 100	0
chartAreaYPosition	Int32			Optional	The ChartAreaYPosition	From 0 to 100	0
chartBackgroundColor	Color			Optional	The chart background color	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
chartBorderLineColor	Color			Optional	The chart border line color	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	Color [Black]
chartBorderLineDashStyle	ChartDashStyle			Optional	The chart border line dash style	Solid NotSet Dash DashDot DashDotDot Dot	Solid
chartBorderLineWidth	Int32			Optional	The chart border line width	N/A	0
chartHeight	Int32			Optional	The chart height in pixels	From 1 to 8000	400
chartImageFormat	ChartImageFormat			Optional	The chart image format	EmfPlus Jpeg Png Bmp Tiff Gif Emf EmfDual	EmfPlus
chartWidth	Int32			Optional	The chart width in pixels	From 1 to 8000	2560
clipBottom	Double			Optional	The number of pixels to clip from the bottom of the image. In PowerPoint, you must manually set the 'chartImageFormat' parameter to either Png or Jpeg, e.g. chartImageFormat=Png	N/A	N/A
clipLeft	Double			Optional	The number of pixels to clip from the left of the image. In PowerPoint, you must manually set the 'chartImageFormat' parameter to either Png or Jpeg, e.g. chartImageFormat=Png	N/A	N/A
clipRight	Double			Optional	The number of pixels to clip from the right of the image. In PowerPoint, you must manually set the 'chartImageFormat' parameter to either Png or Jpeg, e.g. chartImageFormat=Png	N/A	N/A
clipTop	Double			Optional	The number of pixels to clip from the top of the image. In PowerPoint, you must manually set the 'chartImageFormat' parameter to either Png or Jpeg, e.g. chartImageFormat=Png	N/A	N/A
comment	String			Optional	Add a comment to make your document template more readable. The comment is discarded in the output document.	N/A	N/A
connectionName	String			Optional	The name of the Connection.	N/A	N/A
dataSourceId	Int32			Optional	The DataSource ID.	N/A	N/A
description	String			Optional	The description for visually-impaired users. This text also displays when the user hovers the mouse over the image in Word or a PDF viewer.	N/A	N/A
device	List<String>	Deprecated	devices		The Device Display name or names.	N/A	N/A
deviceGroup	List<String>	Deprecated	deviceGroups		The Device Group or Groups. Use "/" or no value in the deviceGroup parameter to reference the root folder.	N/A	N/A
deviceGroups	List<String>	Use instead of: deviceGroup group groups		Optional	The Device Group or Groups. Use "/" or no value in the deviceGroup parameter to reference the root folder.	N/A	N/A
deviceId	List<Int32>	Deprecated	deviceIds		The Device ID or IDs.	N/A	N/A
deviceIds	List<Int32>	Use instead of: deviceId hostId		Optional	The Device ID or IDs.	N/A	N/A
devices	List<String>	Use instead of: device host hosts		Optional	The Device Display name or names.	N/A	N/A
doughnutRadius	Int32			Optional	Optionally use to specify the doughnut radius when specifying 'chartType=Doughnut'.	From 0 to 99	60
dynamicYAxis	Boolean			Optional	Whether to more closely show the y-axis variance on charts. Use the 'dynamicYAxisVariancePercent' parameter to control the variance percentage. When set, the 'yAxisMinimum' and 'yAxisMaximum' parameters are ignored. When this parameter is set, the 'yAxisIsLogarithmic' parameter is ignored.Note: when the minimum data value is 0, the y-axis minimum is NOT adjusted.	true false	false
dynamicYAxisVariancePercent	Double			Optional	The variance percentage to use in conjunction with the 'dynamicYAxis' parameter to adjust the y-axis scale. For example, if the maximum y-axis data value was 10 and this parameter was set to 5, then the y-axis maximum is set to 10 + (5% of 10), which is 10.5. When this parameter and 'dynamicYAxis' is set, the 'yAxisMinimum' and 'yAxisMaximum' parameters are ignored.When this parameter and 'dynamicYAxis' is set, the 'yAxisIsLogarithmic' parameter is ignored. NOTE: final y-axis minimum and maximum values will be rounded to the nearest integer (whole number)	From 0 to 100	1.5
emptyTableText	String			Optional	The text for the new tab in the Xlsx document if the table is empty.	N/A	N/A
enable3d	Boolean			Optional	Whether to enable 3D.	true false	false
endDate	DateTimeOffset			Optional	The end date in the format YYYY-MM-DD.	N/A	Midnight on the first day of this month
ensureColorsUnique	Boolean			Optional	Whether to ensure the colours of all series in the chart are unique. Note that unique colours are still selected if no palette is provided for any series.	true false	false
errorOnOverflow	Boolean			Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
excludeDataPoint	List<String>			Optional	The datapoints to exclude.	N/A	N/A
excludeSdt	Boolean			Optional	Whether to exclude periods of SDT from the macro results. Only works for Devices (not Websites, etc.). For the most accurate results, ensure that you have LogicMonitor permissions for ALL the Device Groups that the Devices are members of. When this is not the case, those Device Groups will simply be skipped.	true false	false
failureText	String			Optional	The text to display should the macro fail to execute. Note that a poorly-specified macro (e.g. omitting mandatory parameters) will still result in an error message.	N/A	N/A
fixedLines	List<FixedLine>			Optional	The semicolon-delimited list of lines of fixed y-value to add to the graph. Each should be in the format "name^value^color", e.g. fixedLines=Lower95th^10^Red;Mean^50^Blue;Upper95th^90^Red	N/A	N/A
flowDirection	Flows.FlowDirection			Optional	The traffic flow direction. Used only with type=NetflowBandwidth.	All In Out	All
flowInterfaceIndices	List<String>			Optional	The traffic flow interfaces e.g. 1;2;3 for interfaces 1, 2 and 3. Used only with type=NetflowBandwidth.	N/A	N/A
forecast	Boolean			Optional	Whether to include forecast data.	true false	false
forecastTime	String			Optional	The time to forecast.	7days 14days 1month 3months	7days
forecastTrainingTime	String			Optional	The amount of data to use to inform the forecast.	1month 1year 3months 6months	1month
graphType	GraphType	Deprecated	type		The graph type. Defaults to Device. Options are: Device, WebsiteOverview, NetflowBandwidth, WebsiteCheckPoint and DashboardWidget.	Device WebsiteOverview NetflowBandwidth WebsiteCheckPoint DashboardWidget	Device
group	List<String>	Deprecated	deviceGroups		The Device Group or Groups. Use "/" or no value in the deviceGroup parameter to reference the root folder.	N/A	N/A
groups	List<String>	Deprecated	deviceGroups		The Device Group or Groups. Use "/" or no value in the deviceGroup parameter to reference the root folder.	N/A	N/A
hAlign	PowerPointImageHorizontalAlign			Optional	For PowerPoint output only, the ability to horizontally align images produced by macros, with vertical lines. No other image parameters apply (clipping, etc.).	Center Left Right	N/A
horizontalPositionAlignment	HorizontalPositionAlignment			Optional	The horizontal position alignment.	Left Inline Center Right Inside Outside	Left
horizontalPositionRelativeTo	HorizontalPositionRelativeTo			Optional	What the horizontal position is relative to.	Inline Margin Column Page InsideMargin OutsideMargin LeftMargin RightMargin	Inline
host	List<String>	Deprecated	devices		The Device Display name or names.	N/A	N/A
hostId	List<Int32>	Deprecated	deviceIds		The Device ID or IDs.	N/A	N/A
hosts	List<String>	Deprecated	devices		The Device Display name or names.	N/A	N/A
if	String			Optional	The condition that must be true in order for the macro to be executed/evaluated. Must either evaluate to true or false, for example: "3+5=8" or "contains('abcd', 'z').	N/A	true
inclination3dDegrees	Int32			Optional	The inclination in degrees. Only valid when enable3d is set to true.	From -90 to 90	50
includeDataPoint	List<String>			Optional	The datapoints to include.	N/A	N/A
innerPlotHeightPercent	Int32			Optional	The InnerPlotHeightPercent	From 0 to 100	75
innerPlotWidthPercent	Int32			Optional	The InnerPlotWidthPercent	From 0 to 100	85
innerPlotXPosition	Int32			Optional	The InnerPlotXPosition	From 0 to 100	10
innerPlotYPosition	Int32			Optional	The InnerPlotYPosition	From 0 to 100	10
labelBackgroundColor	Color			Optional	The label background color	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
labelColor	Color			Optional	The label color	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
labelFontSize	Double			Optional	Set the chart label font size.	From 5 to 100	16
labels	List<String>			Optional	Optionally use to specify labels to add to the chart, formatted as: text^X^Y^alignment^font^fontSize^fontStyle^fontColor. Supported fonts are: 'Arial, Calibri, Comic Sans MS, and Ms Sans Serif'. Supported fontStyles are 'Regular, Bold, Italic, Underline, Strikeout'. Supported alignments are TopLeft, TopCenter, TopRight, MiddleLeft, MiddleCenter, MiddleRight, BottomLeft, BottomCenter, BottomRight. Font colours can be named fonts (such as Red) or hex-based colours (ARGB or RGB-formatted such as #FF0000 or #FFFF0000 for red). Note that alpha component is optional.	N/A	N/A
labelText	String			Optional	Optionally use to specify the label text. Options include #PERCENT{P0} (e.g. for Pie/doughnut charts), #VALX and #VALY. The {P-number} specifies the number of decimal places to display. You can combine these and other symbols (e.g. '#VALX\n(#PERCENT %)' ).	N/A	N/A
legendBackgroundColor	Color			Optional	The legend background color	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
legendBorderColor	Color			Optional	The legend border color	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
legendFontSize	Double			Optional	Set the chart legend font size (default autofit).	From 5 to 100	20
legendHeightPercent	Int32			Optional	The LegendHeightPercent	From 0 to 100	100
legendStyle	LegendStyle			Optional	The legend style	Column Row Table	Column
legendText	String			Optional	Optionally use to specify the label legend text. For other options, see the labelText parameter.	N/A	N/A
legendTextWrapThreshold	Int32			Optional	The number of characters that can be placed in a legend item before text wrapping occurs. Wrapping uses a 'word-break' method, so if the legend names do NOT contain spaces, no wrapping will occur.	From 0 to 2147483647	25
legendWidthPercent	Int32			Optional	The LegendWidthPercent	From 0 to 100	20
legendXPosition	Int32			Optional	The LegendXPosition	From 0 to 100	80
legendYPosition	Int32			Optional	The LegendYPosition	From 0 to 100	0
lineWidth	Int32			Optional	The line width	From 1 to 10	2
markerBorderColor	ListColor	Use instead of: markerBorderColors		Optional	Set the border color(s) of the marker (for example, on line charts). If there are fewer values provided than there are series in your graph, the last one is repeated for the remaining series.	N/A	N/A
markerBorderColors	ListColor	Deprecated	markerBorderColor		Set the border color(s) of the marker (for example, on line charts). If there are fewer values provided than there are series in your graph, the last one is repeated for the remaining series.	N/A	N/A
markerBorderWidth	List<Int32>	Use instead of: markerBorderWidths		Optional	Set the border width(s) of the marker (for example, on line charts). If there are fewer values provided than there are series in your graph, the last one is repeated for the remaining series.	N/A	N/A
markerBorderWidths	List<Int32>	Deprecated	markerBorderWidth		Set the border width(s) of the marker (for example, on line charts). If there are fewer values provided than there are series in your graph, the last one is repeated for the remaining series.	N/A	N/A
markerColor	ListColor	Use instead of: markerColors		Optional	Set the color(s) of the marker (for example, on line charts). If there are fewer values provided than there are series in your graph, the last one is repeated for the remaining series.	N/A	N/A
markerColors	ListColor	Deprecated	markerColor		Set the color(s) of the marker (for example, on line charts). If there are fewer values provided than there are series in your graph, the last one is repeated for the remaining series.	N/A	N/A
markerSize	List<Int32>	Use instead of: markerSizes		Optional	Set the size(s) of the marker (for example, on line charts). If there are fewer values provided than there are series in your graph, the last one is repeated for the remaining series.	N/A	N/A
markerSizes	List<Int32>	Deprecated	markerSize		Set the size(s) of the marker (for example, on line charts). If there are fewer values provided than there are series in your graph, the last one is repeated for the remaining series.	N/A	N/A
markerStyle	ListMarkerStyle	Use instead of: markerStyles		Optional	Set the marker style(s) (for example, on line charts) If there are fewer values provided than there are series in your graph, the last one is repeated for the remaining series.	N/A	N/A
markerStyles	ListMarkerStyle	Deprecated	markerStyle		Set the marker style(s) (for example, on line charts) If there are fewer values provided than there are series in your graph, the last one is repeated for the remaining series.	N/A	N/A
maxAttempts	Int32			Optional	The maximum number of attempts when requesting data via the LogicMonitor API.	From 1 to 2147483647	N/A
mode	MacroMode			Optional	The mode in which variables are stored. In the legacy mode (default for Schedules), the variable created is a string and formatted. In the normal mode (default for Report Studio), the output variable is stored as a strongly-typed object, e.g. an Int32 or a List etc., rather than a formatted string.	Legacy Normal	Legacy
monthsToReport	Int32			Optional	If set, sets 'endDate' to the 'start' plus the specified number of months.	N/A	N/A
obfuscation	ObfuscationType			Optional	Obfuscation type. Use obfuscation to write reports where sensitive data is hidden. When used, ReportMagic guarantees that the same input string will map to the same output string for the whole of the report (but the next time the report runs, it will most likely map to a different value). If you use obfuscation, the property in your macro will not show up and instead, you will see a fake item of the obfuscation type chosen.	None UkTown DeviceName Company IpAddress PrivateIpAddress	None
opacityPercent	Double			Optional	The image opacity (0 is transparent, 100 is solid).	From 0 to 100	100
orderAreaChartSeriesByMean	Boolean			Optional	For charts where all the series are areas (not stacked), order the series according to the mean y-axis values (largest first, descending). This is useful for charts where, depending on the data, 'larger' series would be rendered in front of smaller ones, thereby obscuring them in the chart.	true false	false
overridePaletteType	OverridePaletteType			Optional	Force series colours to use various alternative palettes. Overrides all other settings such as 'EnsureColorsUnique'. When there are more series than the count of colours in each palette, the colours chosen will start again from the beginning of the palette. This parameter is useful for series where there are no colours set (or set to 'Auto' in LogicMonitor Widget graphs, for example).	Default Custom LogicMonitor RainbowStandard RainbowExtended	Default
pageHeightPercent	Double			Optional	The height of the page to take up with the graph. Always overrides 'imageHeightCm'	From 0 to 300	N/A
pageWidthPercent	Double			Optional	The width of the page to take up with the graph. Always overrides 'imageWidthCm'	From 0 to 300	N/A
palette	List<String>			Optional	A list of html-encoded (hex codes) colours for each series separated by ^ for the series name and colour, and semicolons for each series (see examples below). If not specified, a default Microsoft palette will be used. The 'OverridePaletteType' parameter will, if set, override this parameter.	N/A	Yes^#0d0;No^#d00;True^#0d0;False^#d00;OK^#0d0;Error^#d00;Unknown^#ddd
perspective3dPercent	Int32			Optional	The perspective in percent. Only valid when enable3d is set to true.	From 0 to 100	0
pieCollectedColor	Color			Optional	Optionally use to specify the color of the collected ('other') pie slice.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	Color [LightGray]
pieCollectedLabel	String			Optional	Optionally use to specify the label for the collected ('other') pie slice.	N/A	Other
pieCollectedThresholdPercent	Double			Optional	Optionally use to specify the percentage threshold for the collected ('other') pie slice.	From 0 to 100	5
pieLabelStyle	PieLabelStyle			Optional	Optionally use to specify the doughnut radius when specifying 'chartType=Doughnut' or 'chartType=Pie'.	Inside Outside Disabled	Inside
pieLineColor	Color			Optional	Optionally use to specify the pie or doughnut line color when using 'pieLabelStyle=Outside'.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	Color [LightGray]
pieStartAngleDegrees	Int32			Optional	Optionally use to specify the pie or doughnut start angle in degrees from the top.	From 0 to 359	0
pointDepth3dPercent	Int32			Optional	The point depth as a percentage. Only valid when enable3d is set to true.	From 0 to 1000	100
pointGapDepth3dPercent	Int32			Optional	The point gap depth as a percentage. Only valid when enable3d is set to true.	From 0 to 1000	100
pointWidth	Double			Optional	The point width (gap between bar or column chart items)	N/A	N/A
recurseDeviceGroups	Boolean			Optional	Whether to recurse Device Groups. Specify false to exclude child Device Groups.	true false	true
rotation3dDegrees	Int32			Optional	The rotation in degrees. Only valid when enable3d is set to true.	From -90 to 90	30
showBoundaries	Boolean			Optional	Whether to include the LogicMonitor boundaries in the legend titles. ONLY applies when 'type' is 'DashboardWidget'.	true false	false
startDate	DateTimeOffset			Optional	The start date in the format YYYY-MM-DD.	N/A	Midnight on the first day of last month
storeAsHidden	String			Optional	The hidden (does not show in document output) variable in which to save the output graph as base64-encoded text. This is useful because the [Variable.Image:] macro can then insert it into any document. The image is generated only once but can then be manipulated repeatedly with a variety of image-related parameters. Note: when this variable is set, the image format will be forced to PNG, i.e. the equivalent of: chartImageFormat=Png. The image is saved unclipped (i.e. without any clip parameters applied).	N/A	N/A
title	String			Optional	The optional chart title, to appear in text above the chart graphic.	N/A	N/A
titleHeadingLevel	Int32	Use instead of: autoTitleHeadingLevel		Optional	If auto-titling the graph, the heading level to use.	From 1 to 6	N/A
type	GraphType	Use instead of: graphType		Optional	The graph type. Defaults to Device. Options are: Device, WebsiteOverview, NetflowBandwidth, WebsiteCheckPoint and DashboardWidget.	Device WebsiteOverview NetflowBandwidth WebsiteCheckPoint DashboardWidget	Device
useCache	Boolean			Optional	Whether to use the cache (where supported).	true false	false
useChartMagic	Boolean			Optional	Whether to use ChartMagic (experimental)	true false	false
useYAxisShortLabels	Boolean	Deprecated	autoScaleYAxisLabels		Whether to use short (auto-scaled) labels in Y-axes (e.g. 10K instead of 10000). Only has an effect when the 'yAxisLabelFormat' parameter is NOT set.	true false	true
vAlign	PowerPointImageVerticalAlign			Optional	For PowerPoint output only, the ability to vertically align images produced by macros, with horizontal lines. No other image parameters apply (clipping, etc.).	Bottom Middle Top	N/A
verticalPositionAlignment	VerticalPositionAlignment			Optional	The Vertical position alignment.	Top Inline Center Bottom Inside Outside	Top
verticalPositionRelativeTo	VerticalPositionRelativeTo			Optional	What the vertical position is relative to.	Inline Page Paragraph Margin BottomMargin InsideMargin OutsideMargin TopMargin	Inline
waitDuringUpgrades	Boolean			Optional	Whether to wait during LogicMonitor upgrades (i.e. execution essentially pauses).	true false	N/A
warning	String			Optional	If specified, adds a warning message for this macro. This is processed as an NCalc, and the warning message will ALWAYS be present and will be the value of the evaluated NCalc expression.	N/A	N/A
websiteId	List<Int32>	Deprecated	websiteIds		The website ID or IDs.	N/A	N/A
websiteIds	List<Int32>	Use instead of: websiteId		Optional	The website ID or IDs.	N/A	N/A
worksheetName	String			Optional	The worksheet to save the result in the output Excel document (if so configured). Excel does not allow blank names, names above 31 characters, and the following characters: :, /, \, ?, *, [, ]	N/A	Table
wrapping	Wrapping			Optional	Image wrapping.	Inline BehindText	Inline
writeToSpreadsheet	Boolean			Optional	Whether to write output to a spreadsheet.	true false	N/A
xAxisFontColor	Color			Optional	Optionally use to specify the x axis font color.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	Color [Black]
xAxisFontSize	Double			Optional	Set the chart x-axis font size (default autofit).	From 5 to 100	20
xAxisHeightPercent	Double			Optional	Set the chart x-axis height as a percent of the chart area. By default, an automatic choice is made.	From 0 to 90	N/A
xAxisInterval	Double			Optional	The x-axis interval. Only works for whole numbers such as 1, 2, etc. (unpredictable results otherwise).	N/A	N/A
xAxisIntervalAutoMode	IntervalAutoMode			Optional	Optionally use to specify the x axis's interval auto mode.	FixedCount VariableCount	FixedCount
xAxisIntervalType	DateTimeIntervalType			Optional	Optionally use to specify the x axis's interval type. The 'xAxisInterval' parameter is ignored when this parameter is 'Auto' (the default). It is recommended that if you know the type of the date-oriented x-axis (such as months) then you set this parameter accordingly e.g. xAxisIntervalType=Months, and xAxisInterval=1 (to display each month on the x-axis).	Auto Number Years Months Weeks Days Hours Minutes Seconds Milliseconds NotSet	Auto
xAxisIsAutoFit	Boolean			Optional	Whether the x axis's labels are automatically fitted.	true false	true
xAxisIsMarginVisible	Boolean			Optional	Overrides the default x-axis auto margin (which is true by default EXCEPT when there's an empty graph with 2 data points, e.g. a start and an end date). The auto margin extends the x-axis by the equivalent of 1 data point either side of the data, typically leaving a small gap between both interior sides of the axis and the data. Note that in the case of an EMPTY graph (no y-values, but where there is a date / data range), this can lead to an additional month each side of the axis, which may not be what you want to achieve. ReportMagic in this case AUTOMATICALLY disables the margins to produce the 'expected' x-axis range, hence why you may want to force this to true in case you do want the margins.	true false	N/A
xAxisLabelAngle	Int32			Optional	Optionally use to specify the x axis's label angle.	From -90 to 90	0
xAxisLabelAutoFitStyle	LabelAutoFitStyles			Optional	Optionally use to specify the X Axis label autofit style.	DecreaseFont None IncreaseFont StaggeredLabels LabelsAngleStep30 LabelsAngleStep45 LabelsAngleStep90 WordWrap	DecreaseFont
xAxisLabelFormat	String			Optional	The X Axis label format. See https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-numeric-format-strings for more details.	N/A	yyyy-MM-dd
xAxisLineColor	Color			Optional	The x axis line color.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
xAxisLineDashStyle	ChartDashStyle			Optional	The x axis line dash style	Solid NotSet Dash DashDot DashDotDot Dot	Solid
xAxisLineWidth	Int32			Optional	The x axis line width.	N/A	N/A
xAxisMajorGridEnabled	Boolean			Optional	Whether the X-axis major grid is enabled	true false	true
xAxisMajorGridInterval	Double			Optional	A number - (if specified, you must also specify xAxisMajorGridIntervalType)	From 0 to 100	N/A
xAxisMajorGridIntervalType	DateTimeIntervalType			Optional	The major x-axis grid interval type.	Auto Days Hours Milliseconds Minutes Months NotSet Number Seconds Weeks Years	N/A
xAxisMinorGridEnabled	Boolean			Optional	Whether the X-axis Minor grid is enabled	true false	true
xAxisMinorGridInterval	Double			Optional	A number - (if specified, you must also specify xAxisMinorGridIntervalType)	From 0 to 100	N/A
xAxisMinorGridIntervalType	DateTimeIntervalType			Optional	The Minor x-axis grid interval type.	Auto Days Hours Milliseconds Minutes Months NotSet Number Seconds Weeks Years	N/A
xlsxTableStyle	XlsxTableStyle			Optional	The XLSX table style to use in any XLSX output document.	TableStyleMedium13 None TableStyleDark1 TableStyleDark10 TableStyleDark11 TableStyleDark2 TableStyleDark3 TableStyleDark4 TableStyleDark5 TableStyleDark6 TableStyleDark7 TableStyleDark8 TableStyleDark9 TableStyleLight1 TableStyleLight10 TableStyleLight11 TableStyleLight12 TableStyleLight13 TableStyleLight14 TableStyleLight15 TableStyleLight16 TableStyleLight17 TableStyleLight18 TableStyleLight19 TableStyleLight2 TableStyleLight20 TableStyleLight21 TableStyleLight3 TableStyleLight4 TableStyleLight5 TableStyleLight6 TableStyleLight7 TableStyleLight8 TableStyleLight9 TableStyleMedium1 TableStyleMedium10 TableStyleMedium11 TableStyleMedium12 TableStyleMedium14 TableStyleMedium15 TableStyleMedium16 TableStyleMedium17 TableStyleMedium18 TableStyleMedium19 TableStyleMedium2 TableStyleMedium20 TableStyleMedium21 TableStyleMedium22 TableStyleMedium23 TableStyleMedium24 TableStyleMedium25 TableStyleMedium26 TableStyleMedium27 TableStyleMedium28 TableStyleMedium3 TableStyleMedium4 TableStyleMedium5 TableStyleMedium6 TableStyleMedium7 TableStyleMedium8 TableStyleMedium9	TableStyleMedium13
xValueType	ChartValueType			Optional	The x value type. You can set this to 'String' which will disable the 'Auto' mode for the 'xAxisIntervalType' parameter.	DateTime Auto Double Single Int32 Int64 UInt32 UInt64 String Date Time DateTimeOffset	DateTime
yAxisFontColor	Color			Optional	Optionally use to specify the y axis font color.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	Color [Black]
yAxisFontSize	Double			Optional	Set the chart y-axis font size (default autofit).	From 5 to 100	20
yAxisInterval	Double			Optional	The y-axis interval. Only works for whole numbers such as 1, 2, etc. (unpredictable results otherwise).	N/A	N/A
yAxisIntervalAutoMode	IntervalAutoMode			Optional	Optionally use to specify the y axis's interval auto mode.	FixedCount VariableCount	FixedCount
yAxisIntervalType	DateTimeIntervalType			Optional	Optionally use to specify the y axis's interval type.	Auto Number Years Months Weeks Days Hours Minutes Seconds Milliseconds NotSet	Auto
yAxisIsAutoFit	Boolean			Optional	Whether the y axis's labels are automatically fitted.	true false	true
yAxisIsLogarithmic	Boolean			Optional	Optionally use to specify that the Y Axis is logarithmic. Note that any y values of 0 or below will cause an error. You may need to manually adjust the yAxisMinimum parameter. When the 'dynamicYAxis' parameter is set, this parameter is ignored and the axis is forced NOT to be logarithmic.	true false	false
yAxisLabelAngle	Int32			Optional	Optionally use to specify the y axis's label angle.	From -90 to 90	0
yAxisLabelAutoFitStyle	LabelAutoFitStyles			Optional	Optionally use to specify the Y Axis label autofit style.	DecreaseFont None IncreaseFont StaggeredLabels LabelsAngleStep30 LabelsAngleStep45 LabelsAngleStep90 WordWrap	DecreaseFont
yAxisLabelFormat	String			Optional	The Y Axis label format. See https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-numeric-format-strings for more details. When this parameter is set, it overrides the 'autoScaleYAxisLabels' parameter (i.e. that one has no effect).	N/A	N/A
yAxisLineColor	Color			Optional	The y axis line color.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
yAxisLineDashStyle	ChartDashStyle			Optional	The y axis line dash style	Solid NotSet Dash DashDot DashDotDot Dot	Solid
yAxisLineWidth	Int32			Optional	The y axis line width.	N/A	N/A
yAxisMajorGridEnabled	Boolean			Optional	Whether the Y-axis major grid is enabled	true false	true
yAxisMajorGridInterval	Double			Optional	A number - (if specified, you must also specify yAxisMajorGridIntervalType)	From 0 to 100	N/A
yAxisMajorGridIntervalType	DateTimeIntervalType			Optional	The major y-axis grid interval type.	Auto Days Hours Milliseconds Minutes Months NotSet Number Seconds Weeks Years	N/A
yAxisMaximum	Double			Optional	Sets the Y Axis maximum (default derived from graph data). When both yAxisMinimum and yAxisMaximum are set, if either are not whole numbers, this MAY cause chart data to be rendered incorrectly.	N/A	N/A
yAxisMinimum	Double			Optional	Sets the Y Axis minimum (default derived from graph data). This value MAY be automatically adjusted when 'yAxisIsLogarithmic=true' and the data contains any 0 values, to avoid chart errors (logarithmic charts may not contain y-axis values of 0 or below). When both yAxisMinimum and yAxisMaximum are set, if either are not whole numbers, this MAY cause chart data to be rendered incorrectly.	N/A	N/A
yAxisMinorGridEnabled	Boolean			Optional	Whether the Y-axis Minor grid is enabled	true false	true
yAxisMinorGridInterval	Double			Optional	A number - (if specified, you must also specify yAxisMinorGridIntervalType)	From 0 to 100	N/A
yAxisMinorGridIntervalType	DateTimeIntervalType			Optional	The Minor y-axis grid interval type.	Auto Days Hours Milliseconds Minutes Months NotSet Number Seconds Weeks Years	N/A
yAxisWidthPercent	Double			Optional	Set the chart y-axis width as a percent of the chart area. By default, an automatic choice is made.	From 0 to 90	N/A

Examples (12)

Example 1:

Shows the CPU Usage graph, defined in the WinCPU DataSource:

[LogicMonitor.Graph: device=dev.panoramicdata.com, graphName=CPU Usage, dataSourceInstanceName=WinCPU]

Example 2:

Shows the CPU Usage graph, and uses a custom palette and y-axis label format:

[LogicMonitor.Graph: device=dev.panoramicdata.com, graphName=CPU Usage, dataSourceInstanceName=WinCPU, palette=Busy^#f84589, yAxisLabelFormat="00.00"]

Example 3:

[LogicMonitor.Graph: device=dev.panoramicdata.com, graphName=CPU Usage, dataSourceInstanceName=WinCPU, fixedLines=10%^10^LimeGreen;90%^90^LightCoral]

Example 4:

Shows the Queue Length graph, defined in the WinCPU DataSource:

[LogicMonitor.Graph: device=dev.panoramicdata.com, graphName=Queue Length, dataSourceInstanceName=WinCPU, includeDataPoint=Queue Length]

Example 5:

Illustrates use of a custom y-axis label:

[LogicMonitor.Graph: device=dev.panoramicdata.com, graphName=CPU Usage, dataSourceInstanceName=WinCPU, yAxisLabel=Custom Y Axis Label]

Example 6:

Shows the Maximum CPU across 2 devices: dev.panoramicdata.com and test.panoramicdata.com:

[LogicMonitor.Graph: devices=dev.panoramicdata.com;test.panoramicdata.com, graphName=CPU Usage, dataSourceName=WinCPU, aggregation=Max]

Example 7:

[LogicMonitor.Graph: device=dev.panoramicdata.com, dataSourceName=WinIIS-, overviewGraphName=Requests]

Example 8:

Generate a graph from the 'Raw Data' tab (NOT based on a defined graph) by using -1 as the graph ID and the data point name as shown in the tab (not the DataPoint definition):

[LogicMonitor.Graph: device=pdl-app-rm-test-06, graphId=-1, dataSourceName=WinLogicalDrivePerformance-, dataSourceInstanceName=WinLogicalDrivePerformance-C:, palette=PercentDiskWriteTime^#00CC33, chartTypes=Area, includeDataPoint=PercentDiskWriteTime]

Example 9:

Forecast graph example #1:

[LogicMonitor.Graph: device=dev.panoramicdata.com, forecast=true, forecastTrainingTime=1month, forecastTime=1month, graphName=CPU Usage, dataSourceInstanceName=WinCPU, includeDataPoint=CPUBusyPercent]

Example 10:

Forecast graph example #2:

[LogicMonitor.Graph: device=dev.panoramicdata.com, forecast=true, forecastTrainingTime=3months, forecastTime=1month, graphName=WinCPU, dataSourceInstanceName=WinCoreCount-CPU1, includeDataPoint=NUMBEROFCORES]

Example 11:

Forecast graph example #3:

[LogicMonitor.Graph: device=dev.panoramicdata.com, forecast=true, forecastTrainingTime=1year, forecastTime=7days, graphName=DNS Server Activity, dataSourceInstanceName=Windows DNS Server-default, includeDataPoint=TotalResponseSent]

Example 12:

Netflow example:

[LogicMonitor.Graph: device=PDL-FW-01, type=NetflowBandwidth]