Package com.inductiveautomation.historian.common.scripting

Class HistorianDocProvider

java.lang.Object

com.inductiveautomation.ignition.common.script.hints.PropertiesFileDocProvider

com.inductiveautomation.historian.common.scripting.HistorianDocProvider

All Implemented Interfaces:

ScriptFunctionDocProvider

public class HistorianDocProvider
extends PropertiesFileDocProvider

Custom documentation provider for historian scripting functions that hides certain parameters from autocomplete and documentation while still accepting them for backward compatibility.

On Ignition 8.3, the legacy query path cannot honor certain parameters advertised in the scripting API. Rather than breaking existing scripts, this provider hides these parameters from documentation while the underlying code continues to accept them (accept-and-ignore pattern).

• queryAggregatedPoints: fillModes, excludeObservations, includeBounds
• queryRawPoints: excludeObservations, includeBounds
• browse: snapshotTime

These parameters will be fully supported when the 2027.02 query overhaul is implemented.

Field Summary

Fields inherited from class com.inductiveautomation.ignition.common.script.hints.PropertiesFileDocProvider

IGNORED_EXCEPTIONS

Fields inherited from interface com.inductiveautomation.ignition.common.script.hints.ScriptFunctionDocProvider

NO_DOC_PROVIDER

Constructor Summary

Constructors

Constructor	Description
HistorianDocProvider()

Method Summary

Modifier and Type	Method	Description
com.inductiveautomation.ignition.common.script.typing.CompletionDescriptor.Method	getMethodDescriptor(String path, Method method)

Methods inherited from class com.inductiveautomation.ignition.common.script.hints.PropertiesFileDocProvider

b10n, buildParameter, getAnnotations, getBundlePrefix, getDeprecation, getExceptionDescription, getExceptions, getFieldDescription, getFieldDescriptor, getFieldType, getFieldValue, getIgnoredExceptions, getMethodDescription, getParameters, getReturnDocs, getReturnType, parametersFromKeywordArgs, parametersFromScriptArgs, shouldBeIgnored

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HistorianDocProvider

public HistorianDocProvider()

Method Details

getMethodDescriptor

public com.inductiveautomation.ignition.common.script.typing.CompletionDescriptor.Method getMethodDescriptor(String path,
 Method method)

Specified by:

getMethodDescriptor in interface ScriptFunctionDocProvider

Overrides:

getMethodDescriptor in class PropertiesFileDocProvider

Parameters:

path - The path this function is being added at, as given to the ScriptManager.

method - The Method being added as a scripting function.

Returns:

A descriptor for the method.

See Also:

• CompletionDescriptor.Method
• TypeDescriptor