Class: ARCHline.Extension

Overview

This class holds the information of a JavaScript plugin.
You can register a plugin by instantiating this class, and call register_extension().

Version:

2021 development

Instance Property Summary

#

collapse

• [

#copyright ⇒ { get; set; }

](#copyright-instance_property)

Additional information about the plugin.

• [

#creator ⇒ { get; set; }

](#creator-instance_property)

Additional information about the plugin.

• [

#description ⇒ { get; set; }

](#description-instance_property)

Additional information about the plugin.

• [

#extension_path ⇒ { get; }

](#extension_path-instance_property)

The full path to the plugin.

• [

#load_on_start ⇒ { get; }

](#load_on_start-instance_property)

Whether to load the plugin when the ARCHline starts.

• [

#name ⇒ { get; set; }

](#name-instance_property)

The name of the plugin.

• [

#registered ⇒ { get; }

](#registered-instance_property)

Whether the plugin is registered.

• [

#version ⇒ { get; set; }

](#version-instance_property)

Additional information about the plugin.

↑

#copyright ⇒ { get; set; }

Additional information about the plugin.

Type:

String

Version:

• 2021 development

↑

#creator ⇒ { get; set; }

Additional information about the plugin.

Type:

String

Version:

• 2021 development

↑

#description ⇒ { get; set; }

Additional information about the plugin.

Type:

String

Version:

• 2021 development

↑

#extension_path ⇒ { get; }

The full path to the plugin.

Type:

String

Version:

• 2021 development

↑

#load_on_start ⇒ { get; }

Whether to load the plugin when the ARCHline starts.
This is usually set to true.

Type:

Boolean

Version:

• 2021 development

↑

#name ⇒ { get; set; }

The name of the plugin.

Type:

String

Version:

• 2021 development

↑

#registered ⇒ { get; }

Whether the plugin is registered.

Type:

Boolean

Version:

• 2021 development

↑

#version ⇒ { get; set; }

Additional information about the plugin.

Type:

String

Version:

• 2021 development

Instance Method Summary

#

collapse

• [

#Extension(title, path)

](#Extension-instance_method)

↑

#Extension(title, path)

Parameters:

title

(String)

—

This will be the name of the plugin.

path

(String)

—

The path to the plugin relative to the file which registers the plugin.

Version:

• 2021 development